src/gromacs/gmxpreprocess/vsite_parm.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2018,2019,2020, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 #ifndef GMX_GMXPREPROCESS_VSITE_PARM_H
  39 #define GMX_GMXPREPROCESS_VSITE_PARM_H
  40
  41 class PreprocessingAtomTypes;
  42 struct gmx_moltype_t;
  43 struct t_atoms;
  44 struct InteractionsOfType;
  45
  46 namespace gmx
  47 {
  48 template<typename>
  49 class ArrayRef;
  50 class MDLogger;
  51 } // namespace gmx
  52
  53 int set_vsites(bool                              bVerbose,
  54                t_atoms*                          atoms,
  55                PreprocessingAtomTypes*           atype,
  56                gmx::ArrayRef<InteractionsOfType> plist,
  57                const gmx::MDLogger&              logger);
  58 /* set parameters for virtual sites, return number of virtual sites */
  59
  60 void set_vsites_ptype(bool bVerbose, gmx_moltype_t* molt, const gmx::MDLogger& logger);
  61 /* set ptype to VSite for virtual sites */
  62
  63 /*! \brief Clean up the bonded interactions
  64  *
  65  * Throw away all obsolete bonds, angles and dihedrals.
  66  * Throw away all constraints. */
  67 void clean_vsite_bondeds(gmx::ArrayRef<InteractionsOfType> ps,
  68                          int                               natoms,
  69                          bool                              bRmVSiteBds,
  70                          const gmx::MDLogger&              logger);
  71
  72 #endif