api/nblib/interactions.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 /*! \inpublicapi \file
  36  * \brief
  37  * Implements nblib particle-types interactions
  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 #ifndef NBLIB_INTERACTIONS_H
  46 #define NBLIB_INTERACTIONS_H
  47
  48 #include <map>
  49 #include <tuple>
  50 #include <unordered_map>
  51
  52 #include "nblib/kerneloptions.h"
  53 #include "nblib/particletype.h"
  54 #include "nblib/util/util.hpp"
  55
  56 namespace nblib
  57 {
  58
  59 //! Shorthand for a map used for looking up non-bonded parameters using particle types
  60 //! Named type for the C6 parameter in the Lennard-Jones potential
  61 using C6 = StrongType<real, struct C6Parameter>;
  62 //! Named type for the C12 parameter in the Lennard-Jones potential
  63 using C12 = StrongType<real, struct C12Parameter>;
  64
  65 using NonBondedInteractionMapImpl =
  66         std::map<std::tuple<ParticleTypeName, ParticleTypeName>, std::tuple<C6, C12>>;
  67
  68 //! Map used for looking up non-bonded parameters using particle types
  69 class NonBondedInteractionMap final
  70 {
  71 private:
  72     using NamePairTuple   = std::tuple<ParticleTypeName, ParticleTypeName>;
  73     using ComboParameters = std::tuple<C6, C12>;
  74     using InteractionMap  = std::map<NamePairTuple, ComboParameters>;
  75     InteractionMap interactionMap_;
  76
  77 public:
  78     void   setInteractions(const ParticleTypeName&, const ParticleTypeName&, const C6, const C12);
  79     size_t count(const NamePairTuple&);
  80
  81     [[nodiscard]] C6  getC6(const ParticleTypeName&, const ParticleTypeName&) const;
  82     [[nodiscard]] C12 getC12(const ParticleTypeName&, const ParticleTypeName&) const;
  83
  84     InteractionMap::iterator begin() { return interactionMap_.begin(); }
  85     InteractionMap::iterator end() { return interactionMap_.end(); }
  86 };
  87
  88 /*! \brief Non-Bonded Interactions between Particle Types
  89  *
  90  * \inpublicapi
  91  * \ingroup nblib
  92  *
  93  * A class to hold a mapping between pairs of particle types and the non-bonded
  94  * interactions between them. One may add the non-bonded parameters, namely the
  95  * C6/C12 params for each particle type individually and construct a pair-wise
  96  * mapping using combination rules or manually specify the parameters between
  97  * a specific pair.
  98  *
  99  */
 100 class ParticleTypesInteractions final
 101 {
 102 public:
 103     //! Initialized with the default geometric combination rule
 104     explicit ParticleTypesInteractions(CombinationRule = CombinationRule::Geometric);
 105
 106     //! Specify non-bonded params of a particle type
 107     ParticleTypesInteractions& add(const ParticleTypeName& particleTypeName, C6 c6, C12 c12);
 108
 109     //! Specify the non-bonded params of a specific pair of particle types
 110     ParticleTypesInteractions& add(const ParticleTypeName& particleTypeName1,
 111                                    const ParticleTypeName& particleTypeName2,
 112                                    C6                      c6,
 113                                    C12                     c12);
 114
 115     //! Generate table based on the parameters stored
 116     [[nodiscard]] NonBondedInteractionMap generateTable() const;
 117
 118     //! Get combination rule enabled in this object
 119     [[nodiscard]] CombinationRule getCombinationRule() const;
 120
 121     //! Merge with the information stored in another ParticleTypesInteractions object
 122     void merge(const ParticleTypesInteractions&);
 123
 124 private:
 125     CombinationRule combinationRule_;
 126
 127     std::map<ParticleTypeName, std::tuple<C6, C12>> singleParticleInteractionsMap_;
 128     std::map<std::tuple<ParticleTypeName, ParticleTypeName>, std::tuple<C6, C12>> twoParticlesInteractionsMap_;
 129 };
 130
 131 } // namespace nblib
 132 #endif // NBLIB_INTERACTIONS_H