src/gromacs/domdec/dump.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2021, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  *
  37  * \brief This file declares functions for DD to write PDB files
  38  * e.g. when reporting problems.
  39  *
  40  * \author Berk Hess <hess@kth.se>
  41  * \ingroup module_domdec
  42  */
  43
  44 #ifndef GMX_DOMDEC_DUMP_H
  45 #define GMX_DOMDEC_DUMP_H
  46
  47 #include <cstdint>
  48
  49 #include "gromacs/math/vectypes.h"
  50
  51 struct gmx_ddbox_t;
  52 struct gmx_domdec_t;
  53 struct gmx_mtop_t;
  54 struct t_commrec;
  55
  56 //! Write the DD grid to a PDB file
  57 void write_dd_grid_pdb(const char* fn, int64_t step, gmx_domdec_t* dd, matrix box, gmx_ddbox_t* ddbox);
  58
  59 /*! \brief Dump a pdb file with the current DD home + communicated atoms.
  60  *
  61  * When natoms=-1, dump all known atoms.
  62  */
  63 void write_dd_pdb(const char*       fn,
  64                   int64_t           step,
  65                   const char*       title,
  66                   const gmx_mtop_t& mtop,
  67                   const t_commrec*  cr,
  68                   int               natoms,
  69                   const rvec        x[],
  70                   const matrix      box);
  71
  72 #endif