src/gromacs/topology/residuetypes.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2014,2018,2019,2020,2021, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 #ifndef GMX_TOPOLOGY_RESIDUETYPES_H
  36 #define GMX_TOPOLOGY_RESIDUETYPES_H
  37
  38 #include <string>
  39 #include <unordered_map>
  40
  41 #include "gromacs/utility/basedefinitions.h"
  42 #include "gromacs/utility/stringutil.h"
  43
  44 /*! \brief Convenience type aliases
  45  *
  46  * These are not as useful as strong types, but they will
  47  * help clarify usage to humans in some cases. */
  48 //! \{
  49 using ResidueName = std::string;
  50 using ResidueType = std::string;
  51 //! \}
  52
  53 /*! \brief Maps residue names to residue types
  54  *
  55  * The contents are typically loaded from share/top/residuetypes.dat
  56  * or similar file provided in the users's working directory.
  57  */
  58 using ResidueTypeMap =
  59         std::unordered_map<ResidueName, ResidueType, std::hash<ResidueName>, gmx::EqualCaseInsensitive>;
  60
  61 /*! \brief
  62  * Add entry to ResidueTypeMap if unique.
  63  *
  64  * \param[in] residueTypeMap Map to which to add new name+type entry
  65  * \param[in] residueName    Name of new residue.
  66  * \param[in] residueType    Type of new residue.
  67  */
  68 void addResidue(ResidueTypeMap* residueTypeMap, const ResidueName& residueName, const ResidueType& residueType);
  69
  70 /*! \brief Returns a ResidueTypeMap filled from a file
  71  *
  72  * The value of the parameter is typically "residuetypes.dat" which
  73  * treats that as a GROMACS library file, ie. loads it from the working
  74  * directory or from "share/top" corresponding to the sourced GMXRC.
  75  *
  76  * \param[in] residueTypesDatFilename Library file to read and from which to fill the returned map
  77  */
  78 ResidueTypeMap residueTypeMapFromLibraryFile(const std::string& residueTypesDatFilename);
  79
  80 /*! \brief
  81  * Checks if the indicated \p residueName is of \p residueType.
  82  *
  83  * \param[in] residueTypeMap Map to search
  84  * \param[in] residueName    Residue that should be checked.
  85  * \param[in] residueType    Which ResidueType the residue should have.
  86  * \returns If the check was successful.
  87  */
  88 bool namedResidueHasType(const ResidueTypeMap& residueTypeMap,
  89                          const ResidueName&    residueName,
  90                          const ResidueType&    residueType);
  91
  92 /*! \brief
  93  * Return the residue type if a residue with that name exists, or "Other"
  94  *
  95  * \param[in] residueTypeMap Map to search
  96  * \param[in] residueName    Name of the residue to search for.
  97  * \returns The residue type of any matching residue, or "Other"
  98  */
  99 ResidueType typeOfNamedDatabaseResidue(const ResidueTypeMap& residueTypeMap, const ResidueName& residueName);
 100
 101 #endif