src/gromacs/gmxpreprocess/genhydro.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_GENHYDRO_H
  39 #define GMX_GMXPREPROCESS_GENHYDRO_H
  40
  41 #include <vector>
  42
  43 #include "gromacs/math/vectypes.h"
  44
  45 struct t_atoms;
  46 struct t_symtab;
  47 struct MoleculePatchDatabase;
  48
  49 namespace gmx
  50 {
  51 template<typename>
  52 class ArrayRef;
  53 }
  54
  55 /*! \brief
  56  * Generate hydrogen atoms and N and C terminal patches.
  57  *
  58  * \param[inout] initialAtoms The input atoms data structure to be modified.
  59  * \param[inout] localAtoms The extra atoms for reassigning the new entries.
  60  * \param[inout] xptr Coordinates to be updated with those for new atoms.
  61  * \param[in] globalPatches The atom modifications to use.
  62  * \param[inout] symtab Global symbol table for atom names.
  63  * \param[in] nterpairs Number of termini pairs in the molecule.
  64  * \param[in] ntdb Entries for N-terminus in each chain, each entry can be valid or nullptr.
  65  * \param[in] ctdb Entries for C-terminus in each cahin, each entry can be valid or nullptr.
  66  * \param[in] rN Residue number of the N-terminus of each chain.
  67  * \param[in] rC Residue number of the C-terminus of each chain.
  68  * \param[in] bMissing If routine should continue if atoms are not found.
  69  * \param[in] cyclicBondsIndex Index of cyclic bonds or empty.
  70  * \returns New total number of atoms.
  71  */
  72 int add_h(t_atoms**                                   initialAtoms,
  73           t_atoms**                                   localAtoms,
  74           std::vector<gmx::RVec>*                     xptr,
  75           gmx::ArrayRef<const MoleculePatchDatabase>  globalPatches,
  76           t_symtab*                                   symtab,
  77           int                                         nterpairs,
  78           gmx::ArrayRef<MoleculePatchDatabase* const> ntdb,
  79           gmx::ArrayRef<MoleculePatchDatabase* const> ctdb,
  80           gmx::ArrayRef<const int>                    rN,
  81           gmx::ArrayRef<const int>                    rC,
  82           bool                                        bMissing,
  83           gmx::ArrayRef<const int>                    cyclicBondsIndex);
  84 #endif