api/nblib/topology.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, 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 /*! \internal \file
  36  * \brief
  37  * Implements nblib Topology and TopologyBuilder
  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 #include <numeric>
  46
  47 #include "gromacs/topology/exclusionblocks.h"
  48 #include "gromacs/utility/listoflists.h"
  49 #include "gromacs/utility/smalloc.h"
  50 #include "nblib/exception.h"
  51 #include "nblib/particletype.h"
  52 #include "nblib/topology.h"
  53 #include "nblib/util/internal.h"
  54
  55 namespace nblib
  56 {
  57
  58 TopologyBuilder::TopologyBuilder() : numParticles_(0) {}
  59
  60 gmx::ListOfLists<int> TopologyBuilder::createExclusionsListOfLists() const
  61 {
  62     const auto& moleculesList = molecules_;
  63
  64     std::vector<gmx::ExclusionBlock> exclusionBlockGlobal;
  65     exclusionBlockGlobal.reserve(numParticles_);
  66
  67     size_t particleNumberOffset = 0;
  68     for (const auto& molNumberTuple : moleculesList)
  69     {
  70         const Molecule& molecule   = std::get<0>(molNumberTuple);
  71         size_t          numMols    = std::get<1>(molNumberTuple);
  72         const auto&     exclusions = molecule.getExclusions();
  73
  74         // Note this is a programming error as all particles should exclude at least themselves and empty topologies are not allowed.
  75         const std::string message =
  76                 "No exclusions found in the " + molecule.name().value() + " molecule.";
  77         assert((!exclusions.empty() && message.c_str()));
  78
  79         std::vector<gmx::ExclusionBlock> exclusionBlockPerMolecule =
  80                 detail::toGmxExclusionBlock(exclusions);
  81
  82         // duplicate the exclusionBlockPerMolecule for the number of Molecules of (numMols)
  83         for (size_t i = 0; i < numMols; ++i)
  84         {
  85             auto offsetExclusions =
  86                     detail::offsetGmxBlock(exclusionBlockPerMolecule, particleNumberOffset);
  87
  88             std::copy(std::begin(offsetExclusions), std::end(offsetExclusions),
  89                       std::back_inserter(exclusionBlockGlobal));
  90
  91             particleNumberOffset += molecule.numParticlesInMolecule();
  92         }
  93     }
  94
  95     gmx::ListOfLists<int> exclusionsListOfListsGlobal;
  96     for (const auto& block : exclusionBlockGlobal)
  97     {
  98         exclusionsListOfListsGlobal.pushBack(block.atomNumber);
  99     }
 100
 101     return exclusionsListOfListsGlobal;
 102 }
 103
 104 template<typename T, class Extractor>
 105 std::vector<T> TopologyBuilder::extractParticleTypeQuantity(Extractor&& extractor)
 106 {
 107     auto& moleculesList = molecules_;
 108
 109     // returned object
 110     std::vector<T> ret;
 111     ret.reserve(numParticles_);
 112
 113     for (auto& molNumberTuple : moleculesList)
 114     {
 115         Molecule& molecule = std::get<0>(molNumberTuple);
 116         size_t    numMols  = std::get<1>(molNumberTuple);
 117
 118         for (size_t i = 0; i < numMols; ++i)
 119         {
 120             for (auto& particleData : molecule.particleData())
 121             {
 122                 auto particleTypesMap = molecule.particleTypesMap();
 123                 ret.push_back(extractor(particleData, particleTypesMap));
 124             }
 125         }
 126     }
 127
 128     return ret;
 129 }
 130
 131 Topology TopologyBuilder::buildTopology()
 132 {
 133     assert((!(numParticles_ < 0) && "It should not be possible to have negative particles"));
 134     if (numParticles_ == 0)
 135     {
 136         throw InputException("You cannot build a topology with no particles");
 137     }
 138     topology_.numParticles_ = numParticles_;
 139
 140     topology_.exclusions_ = createExclusionsListOfLists();
 141     topology_.charges_    = extractParticleTypeQuantity<real>([](const auto& data, auto& map) {
 142         ignore_unused(map);
 143         return data.charge_;
 144     });
 145
 146     // map unique ParticleTypes to IDs
 147     std::unordered_map<std::string, int> nameToId;
 148     for (auto& name_particleType_tuple : particleTypes_)
 149     {
 150         topology_.particleTypes_.push_back(name_particleType_tuple.second);
 151         nameToId[name_particleType_tuple.first] = nameToId.size();
 152     }
 153
 154     topology_.particleTypeIdOfAllParticles_ =
 155             extractParticleTypeQuantity<int>([&nameToId](const auto& data, auto& map) {
 156                 ignore_unused(map);
 157                 return nameToId[data.particleTypeName_];
 158             });
 159
 160     detail::ParticleSequencer particleSequencer;
 161     particleSequencer.build(molecules_);
 162     topology_.particleSequencer_ = std::move(particleSequencer);
 163
 164     topology_.combinationRule_         = particleTypesInteractions_.getCombinationRule();
 165     topology_.nonBondedInteractionMap_ = particleTypesInteractions_.generateTable();
 166
 167     // Check whether there is any missing term in the particleTypesInteractions compared to the
 168     // list of particletypes
 169     for (const auto& particleType1 : particleTypes_)
 170     {
 171         for (const auto& particleType2 : particleTypes_)
 172         {
 173             auto interactionKey = std::make_tuple(ParticleTypeName(particleType1.first),
 174                                                   ParticleTypeName(particleType2.first));
 175             if (topology_.nonBondedInteractionMap_.count(interactionKey) == 0)
 176             {
 177                 std::string message =
 178                         formatString("Missing nonbonded interaction parameters for pair {} {}",
 179                                      particleType1.first, particleType2.first);
 180                 throw InputException(message);
 181             }
 182         }
 183     }
 184
 185     return topology_;
 186 }
 187
 188 TopologyBuilder& TopologyBuilder::addMolecule(const Molecule& molecule, const int nMolecules)
 189 {
 190     /*
 191      * 1. Push-back a tuple of molecule type and nMolecules
 192      * 2. Append exclusion list into the data structure
 193      */
 194
 195     molecules_.emplace_back(molecule, nMolecules);
 196     numParticles_ += nMolecules * molecule.numParticlesInMolecule();
 197
 198     auto particleTypesInMolecule = molecule.particleTypesMap();
 199
 200     for (const auto& name_type_tuple : particleTypesInMolecule)
 201     {
 202         // If we already have the particleType, we need to make
 203         // sure that the type's parameters are actually the same
 204         // otherwise we would overwrite them
 205         if (particleTypes_.count(name_type_tuple.first) > 0)
 206         {
 207             if (!(particleTypes_.at(name_type_tuple.first) == name_type_tuple.second))
 208             {
 209                 throw InputException("Differing ParticleTypes with identical names encountered");
 210             }
 211         }
 212     }
 213
 214     // Note: insert does nothing if the key already exists
 215     particleTypes_.insert(particleTypesInMolecule.begin(), particleTypesInMolecule.end());
 216
 217     return *this;
 218 }
 219
 220 void TopologyBuilder::addParticleTypesInteractions(const ParticleTypesInteractions& particleTypesInteractions)
 221 {
 222     particleTypesInteractions_.merge(particleTypesInteractions);
 223 }
 224
 225 int Topology::numParticles() const
 226 {
 227     return numParticles_;
 228 }
 229
 230 std::vector<real> Topology::getCharges() const
 231 {
 232     return charges_;
 233 }
 234
 235 std::vector<ParticleType> Topology::getParticleTypes() const
 236 {
 237     return particleTypes_;
 238 }
 239
 240 std::vector<int> Topology::getParticleTypeIdOfAllParticles() const
 241 {
 242     return particleTypeIdOfAllParticles_;
 243 }
 244
 245 int Topology::sequenceID(MoleculeName moleculeName, int moleculeNr, ResidueName residueName, ParticleName particleName) const
 246 {
 247     return particleSequencer_(moleculeName, moleculeNr, residueName, particleName);
 248 }
 249
 250 NonBondedInteractionMap Topology::getNonBondedInteractionMap() const
 251 {
 252     return nonBondedInteractionMap_;
 253 }
 254
 255 CombinationRule Topology::getCombinationRule() const
 256 {
 257     return combinationRule_;
 258 }
 259
 260 gmx::ListOfLists<int> Topology::getGmxExclusions() const
 261 {
 262     return exclusions_;
 263 }
 264
 265 } // namespace nblib