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