api/nblib/particletype.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \file
  36  * \brief
  37  * Declares nblib ParticleTypes
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  * \author Artem Zhmurov <zhmurov@gmail.com>
  44  *
  45  * \inpublicapi
  46  * \ingroup nblib
  47  */
  48 #ifndef NBLIB_PARTICLETYPE_H
  49 #define NBLIB_PARTICLETYPE_H
  50
  51 #include <string>
  52
  53 #include "nblib/util/util.hpp"
  54 #include "nblib/basicdefinitions.h"
  55
  56 namespace nblib
  57 {
  58 class TopologyBuilder;
  59
  60 //! Named type for particle type name
  61 using ParticleTypeName = StrongType<std::string, struct ParticleTypeNameParameter>;
  62 //! Named type for particle mass
  63 using Mass = StrongType<real, struct MassParameter>;
  64
  65 // Shorthand for a map used for looking up non-bonded parameters using particle types
  66 //! Named type for the C6 parameter in the Lennard-Jones potential
  67 using C6 = StrongType<real, struct C6Parameter>;
  68 //! Named type for the C12 parameter in the Lennard-Jones potential
  69 using C12 = StrongType<real, struct C12Parameter>;
  70
  71 /*! \brief Class that represents the particle type.
  72  *
  73  * The particle type is used in lookup tables for masses, non-bonded parameters, etc.
  74  * Every particle has to assigned an atom type.
  75  */
  76 class ParticleType final
  77 {
  78 public:
  79     /*! \brief Constructor with explicit name and mass specification.
  80      *
  81      * \param[in] name The unique name to reference the particle type.
  82      * \param[in] mass The mass of the particle of this type.
  83      */
  84     ParticleType(ParticleTypeName name, Mass mass);
  85
  86     //! Get the type name
  87     [[nodiscard]] ParticleTypeName name() const;
  88
  89     //! Get the mass
  90     [[nodiscard]] Mass mass() const;
  91
  92 private:
  93     //! The name
  94     ParticleTypeName name_;
  95     //! The mass
  96     Mass mass_;
  97 };
  98
  99 /*! \brief Comparison operator
 100  *
 101  * \param[in] a First type.
 102  * \param[in] b Second type.
 103  * \returns If the types are identical.
 104  */
 105 bool operator==(const ParticleType& a, const ParticleType& b);
 106
 107 } // namespace nblib
 108 #endif // NBLIB_PARTICLETYPE_H