src/gromacs/domdec/makebondedlinks.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \libinternal \file
  36  *
  37  * \brief Declares a function that makes the list of links between
  38  * atoms connected by bonded interactions.
  39  *
  40  * \inlibraryapi
  41  * \ingroup module_domdec
  42  */
  43
  44 #ifndef GMX_DOMDEC_MAKEBONDEDLINKS_H
  45 #define GMX_DOMDEC_MAKEBONDEDLINKS_H
  46
  47 struct gmx_domdec_t;
  48 struct gmx_mtop_t;
  49
  50 namespace gmx
  51 {
  52 template<typename>
  53 class ArrayRef;
  54 struct AtomInfoWithinMoleculeBlock;
  55 } // namespace gmx
  56
  57 /*! \brief Generate a list of links between atoms that are linked by bonded interactions
  58  *
  59  * Also stores whether atoms are linked in \p atomInfoForEachMoleculeBlock.
  60  */
  61 void makeBondedLinks(gmx_domdec_t*                                   dd,
  62                      const gmx_mtop_t&                               mtop,
  63                      gmx::ArrayRef<gmx::AtomInfoWithinMoleculeBlock> atomInfoForEachMoleculeBlock);
  64
  65 #endif