src/gromacs/topology/atomprop.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) 2010,2014,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 #ifndef GMX_TOPOLOGY_ATOMPROP_H
  38 #define GMX_TOPOLOGY_ATOMPROP_H
  39
  40 #include <string>
  41
  42 #include "gromacs/utility/basedefinitions.h"
  43 #include "gromacs/utility/classhelpers.h"
  44 #include "gromacs/utility/real.h"
  45
  46 enum {
  47     epropMass, epropVDW, epropDGsol, epropElectroneg, epropElement,
  48     epropNR
  49 };
  50
  51 struct AtomProperty;
  52 class ResidueType;
  53 /*! \brief
  54  * Holds all the atom property information loaded.
  55  */
  56 class AtomProperties
  57 {
  58     public:
  59         //! Default constructor.
  60         AtomProperties();
  61         //! Default destructor
  62         ~AtomProperties();
  63
  64         /*! \brief
  65          * Get element string from atom number.
  66          *
  67          * \param[in] atomNumber Atomnumber to check.
  68          * \returns Name of the element.
  69          *
  70          * \todo This should be made const once the lazy
  71          * implementation is done properly for the class.
  72          */
  73         std::string elementFromAtomNumber(int atomNumber);
  74         /*! \brief
  75          * Get atom number from element string.
  76          *
  77          * \param[in] element Name of element.
  78          * \returns AtomNumber that was being looked for.
  79          *
  80          * \todo This should be made const once the lazy
  81          * implementation is done properly for the class.
  82          */
  83         int atomNumberFromElement(const char *element);
  84         /*! \brief
  85          * Set atom property based on atomname.
  86          *
  87          * Extract a \p value from the database. Returns true
  88          * if this is successful, or false if not. Sets default value
  89          * in the later case. The first time this function is called
  90          * for this property the database will be initialized.
  91          *
  92          * \param[in] eprop Property to set.
  93          * \param[in] residueName Residue name for entry.
  94          * \param[in] atomName Atom name for entry.
  95          * \param[out] value New value to set or default.
  96          * \returns If the operation has been succesful.
  97          */
  98         bool setAtomProperty(int                eprop,
  99                              const std::string &residueName,
 100                              const std::string &atomName,
 101                              real              *value);
 102         /*! \brief
 103          * Get handle to property.
 104          *
 105          * \param[in] eprop Which property we need a handle to.
 106          * \returns Pointer to property entry.
 107          */
 108         AtomProperty *prop(int eprop);
 109         //! Get handle to residuetype library.
 110         ResidueType *restype();
 111
 112     private:
 113         //! Implementation pointer.
 114         class Impl;
 115
 116         gmx::PrivateImplPointer<Impl> impl_;
 117 };
 118
 119 #endif