src/gromacs/gmxpreprocess/gpp_atomtype.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) 2011,2014,2015,2018,2019, 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_GPP_ATOMTYPE_H
  39 #define GMX_GMXPREPROCESS_GPP_ATOMTYPE_H
  40
  41 #include <cstdio>
  42
  43 #include "gromacs/utility/arrayref.h"
  44 #include "gromacs/utility/classhelpers.h"
  45 #include "gromacs/utility/real.h"
  46
  47 struct gmx_mtop_t;
  48 struct t_atom;
  49 struct t_atomtypes;
  50 class InteractionType;
  51 struct InteractionTypeParameters;
  52 struct t_symtab;
  53
  54 /*! \libinternal \brief
  55  * Storage of all atom types used during preprocessing of a simulation
  56  * input.
  57  */
  58 class PreprocessingAtomTypes
  59 {
  60     public:
  61         PreprocessingAtomTypes();
  62         //! Move constructor.
  63         PreprocessingAtomTypes(PreprocessingAtomTypes &&old) noexcept;
  64         //! Move assignment constructor.
  65         PreprocessingAtomTypes &operator=(PreprocessingAtomTypes &&old) noexcept;
  66
  67         ~PreprocessingAtomTypes();
  68
  69         /*! \brief
  70          *  Get atom type index for atom type name if present in the database, or NOTSET.
  71          *
  72          *  \todo The code should be changed to instead use a gmx::compat version
  73          *  of std::optional to return an iterator to the element being searched,
  74          *  or an empty optional construct if the entry has not been found.
  75          *
  76          *  \param[in] str Input string to search type for.
  77          *  \returns Atomtype as integer.
  78          */
  79         int atomTypeFromName(const std::string &str) const;
  80
  81         //! Get number of defined atom types.
  82         size_t size() const;
  83
  84         /*! \brief
  85          * Get name of atom from internal atom type number.
  86          *
  87          * \param[in] nt Internal number of atom type.
  88          * \returns The type name.
  89          */
  90         const char *atomNameFromAtomType(int nt) const;
  91
  92         /*! \brief
  93          * Get normal mass of atom from internal atom type number.
  94          *
  95          * \param[in] nt Internal number of atom type.
  96          * \returns The mass for the atom in state A or NOTSET.
  97          */
  98         real atomMassAFromAtomType(int nt) const;
  99
 100         /*! \brief
 101          * Get mass for B state of atom from internal atom type number.
 102          *
 103          * \param[in] nt Internal number of atom type.
 104          * \returns The mass for the atom in state B or NOTSET.
 105          */
 106         real atomMassBFromAtomType(int nt) const;
 107
 108         /*! \brief
 109          * Get normal charge of atom from internal atom type number.
 110          *
 111          * \param[in] nt Internal number of atom type.
 112          * \returns The charge for the atom in state A or NOTSET.
 113          */
 114         real atomChargeAFromAtomType(int nt) const;
 115
 116         /*! \brief
 117          * Get charge for B state of atom from internal atom type number.
 118          *
 119          * \param[in] nt Internal number of atom type.
 120          * \returns The charge for the atom in state B or NOTSET.
 121          */
 122         real atomChargeBFromAtomType(int nt) const;
 123
 124         /*! \brief
 125          * Get particle type for atom type \p nt
 126          *
 127          * \param[in] nt Internal number of atom type.
 128          * \returns The particle type or NOTSET.
 129          */
 130         int atomParticleTypeFromAtomType(int nt) const;
 131
 132         /*! \brief
 133          * Get bond atom parameter of atom from internal atom type number.
 134          *
 135          * \param[in] nt Internal number of atom type.
 136          * \returns The bond atom parameter or NOTSET.
 137          */
 138         int bondAtomTypeFromAtomType(int nt) const;
 139
 140         /*! \brief
 141          * Get atomic number of atom from internal atom type number.
 142          *
 143          * \param[in] nt Internal number of atom type.
 144          * \returns The atomic number type or NOTSET.
 145          */
 146         int atomNumberFromAtomType(int nt) const;
 147
 148         /*! \brief
 149          * Get the value of \p param of type \p nt.
 150          *
 151          * \param[in] param The parameter value to find.
 152          * \param[in] nt The number of the type.
 153          * \returns The value of the parameter or NOTSET.
 154          */
 155         real atomNonBondedParamFromAtomType(int nt, int param) const;
 156
 157         /*! \brief
 158          * If a value is within the range of the current types or not.
 159          *
 160          * \param[in] nt Value to check.
 161          * \returns True if value is in range.
 162          */
 163         bool isSet(int nt) const;
 164
 165         /*! \brief
 166          * Print data to file.
 167          *
 168          * \param[in] out File pointer.
 169          */
 170         void printTypes(FILE *out);
 171
 172         /*! \brief
 173          * Set the values of an existing atom type \p nt.
 174          *
 175          * \param[in] nt Type that should be set.
 176          * \param[in] tab Symbol table.
 177          * \param[in] a Atom information.
 178          * \param[in] name Atom name.
 179          * \param[in] nb Nonbonded parameters.
 180          * \param[in] bondAtomType What kind of bonded interactions are there.
 181          * \param[in] atomNumber Atomic number of the entry.
 182          * \returns Number of the type set or NOTSET
 183          */
 184         int setType(int                    nt,
 185                     t_symtab              *tab,
 186                     const t_atom          &a,
 187                     const char            *name,
 188                     const InteractionType &nb,
 189                     int                    bondAtomType,
 190                     int                    atomNumber);
 191
 192         /*! \brief
 193          * Add new atom type to database.
 194          *
 195          * \param[in] tab Symbol table.
 196          * \param[in] a Atom information.
 197          * \param[in] name Atom name.
 198          * \param[in] nb Nonbonded parameters.
 199          * \param[in] bondAtomType What kind of bonded interactions are there.
 200          * \param[in] atomNumber Atomic number of the entry.
 201          * \returns Number of entries in database.
 202          */
 203         int addType(t_symtab              *tab,
 204                     const t_atom          &a,
 205                     const char            *name,
 206                     const InteractionType &nb,
 207                     int                    bondAtomType,
 208                     int                    atomNumber);
 209
 210         /*! \brief
 211          * Renumber existing atom type entries.
 212          *
 213          * \param[in] plist List of parameters.
 214          * \param[in] mtop Global topology.
 215          * \param[inout] wallAtomType Atom types of wall atoms, which may also be renumbered
 216          * \param[in] verbose If we want to print additional info.
 217          */
 218         void renumberTypes(gmx::ArrayRef<InteractionTypeParameters> plist,
 219                            gmx_mtop_t                              *mtop,
 220                            int                                     *wallAtomType,
 221                            bool                                     verbose);
 222
 223         /*! \brief
 224          * Copy information to other structure.
 225          *
 226          * \param[inout] atypes Other datastructure to copy to.
 227          */
 228         void copyTot_atomtypes(t_atomtypes *atypes) const;
 229     private:
 230         class Impl;
 231         gmx::PrivateImplPointer<Impl> impl_;
 232 };
 233
 234 #endif