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,2021, 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 <memory>
  52 #include <optional>
  53 #include <string>
  54
  55 #include "gromacs/utility/real.h"
  56
  57 struct gmx_mtop_t;
  58 struct t_atom;
  59 struct t_atomtypes;
  60 class InteractionOfType;
  61 struct InteractionsOfType;
  62 struct t_symtab;
  63 enum class ParticleType : int;
  64 namespace gmx
  65 {
  66 template<typename>
  67 class ArrayRef;
  68 }
  69
  70 /*! \libinternal \brief
  71  * Storage of all atom types used during preprocessing of a simulation
  72  * input.
  73  */
  74 class PreprocessingAtomTypes
  75 {
  76 public:
  77     PreprocessingAtomTypes();
  78     //! Move constructor.
  79     PreprocessingAtomTypes(PreprocessingAtomTypes&& old) noexcept;
  80     //! Move assignment constructor.
  81     PreprocessingAtomTypes& operator=(PreprocessingAtomTypes&& old) noexcept;
  82
  83     ~PreprocessingAtomTypes();
  84
  85     /*! \brief
  86      *  Get atom type index for atom type name if present in the database, or empty optional.
  87      *
  88      *  \todo The code should be changed to instead use a gmx::compat version
  89      *  of std::optional to return an iterator to the element being searched,
  90      *  or an empty optional construct if the entry has not been found.
  91      *
  92      *  \param[in] str Input string to search type for.
  93      *  \returns Optional atomtype as integer.
  94      */
  95     std::optional<int> atomTypeFromName(const std::string& str) const;
  96
  97     //! Get number of defined atom types.
  98     size_t size() const;
  99
 100     /*! \brief
 101      * Get name of atom from internal atom type number.
 102      *
 103      * \param[in] nt Internal number of atom type.
 104      * \returns The optional type name.
 105      */
 106     std::optional<const char*> atomNameFromAtomType(int nt) const;
 107
 108     /*! \brief
 109      * Get normal mass of atom from internal atom type number.
 110      *
 111      * \param[in] nt Internal number of atom type.
 112      * \returns The optional mass for the atom.
 113      */
 114     std::optional<real> atomMassFromAtomType(int nt) const;
 115
 116     /*! \brief
 117      * Get normal charge of atom from internal atom type number.
 118      *
 119      * \param[in] nt Internal number of atom type.
 120      * \returns The optional charge for the atom.
 121      */
 122     std::optional<real> atomChargeFromAtomType(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 optional particle type.
 129      */
 130     std::optional<ParticleType> 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 optional bond atom parameter.
 137      */
 138     std::optional<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 optional atomic number type.
 145      */
 146     std::optional<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 optional value of the parameter.
 154      */
 155     std::optional<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 Optional number of the type set.
 183      */
 184     std::optional<int> setType(int                      nt,
 185                                t_symtab*                tab,
 186                                const t_atom&            a,
 187                                const std::string&       name,
 188                                const InteractionOfType& nb,
 189                                int                      bondAtomType,
 190                                int                      atomNumber);
 191
 192     /*! \brief
 193      * Add a unique type to the 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 Index to the type in the database. If the type shares
 202      *          a name with an existing type, return the index of that type.
 203      */
 204     int addType(t_symtab*                tab,
 205                 const t_atom&            a,
 206                 const std::string&       name,
 207                 const InteractionOfType& nb,
 208                 int                      bondAtomType,
 209                 int                      atomNumber);
 210
 211     /*! \brief
 212      * Renumber existing atom type entries.
 213      *
 214      * \param[in] plist List of parameters.
 215      * \param[in] mtop Global topology.
 216      * \param[inout] wallAtomType Atom types of wall atoms, which may also be renumbered
 217      * \param[in] verbose If we want to print additional info.
 218      */
 219     void renumberTypes(gmx::ArrayRef<InteractionsOfType> plist, gmx_mtop_t* mtop, int* wallAtomType, bool verbose);
 220
 221     /*! \brief
 222      * Copy information to other structure.
 223      *
 224      * \param[inout] atypes Other datastructure to copy to.
 225      */
 226     void copyTot_atomtypes(t_atomtypes* atypes) const;
 227
 228 private:
 229     class Impl;
 230     //! Pimpl that holds the data.
 231     std::unique_ptr<Impl> impl_;
 232 };
 233
 234 #endif