src/gromacs/modularsimulator/topologyholder.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,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 Defines the topology class for the modular simulator
  37  *
  38  * \author Pascal Merz <pascal.merz@me.com>
  39  * \ingroup module_modularsimulator
  40  */
  41
  42 #include "gmxpre.h"
  43
  44 #include "topologyholder.h"
  45
  46 #include "gromacs/domdec/domdec.h"
  47 #include "gromacs/domdec/mdsetup.h"
  48 #include "gromacs/mdtypes/commrec.h"
  49 #include "gromacs/topology/topology.h"
  50
  51 namespace gmx
  52 {
  53 TopologyHolder::TopologyHolder(std::vector<ITopologyHolderClient*> clients,
  54                                const gmx_mtop_t&                   globalTopology,
  55                                const t_commrec*                    cr,
  56                                const t_inputrec*                   inputrec,
  57                                t_forcerec*                         fr,
  58                                MDAtoms*                            mdAtoms,
  59                                Constraints*                        constr,
  60                                VirtualSitesHandler*                vsite) :
  61     globalTopology_(globalTopology),
  62     localTopology_(std::make_unique<gmx_localtop_t>(globalTopology.ffparams)),
  63     clients_(std::move(clients))
  64 {
  65     if (!DOMAINDECOMP(cr))
  66     {
  67         // Generate and initialize new topology
  68         // Note that most of the data needed for the constructor is used here -
  69         // this function should probably be simplified sooner or later.
  70         // Note: Legacy mdrun resizes the force buffer in mdAlgorithmsSetupAtomData()
  71         //       TopologyHolder has no access to the forces, so we are passing a nullptr
  72         //       TODO: Find a unique approach to resizing the forces in modular simulator (#3461)
  73         mdAlgorithmsSetupAtomData(
  74                 cr, inputrec, globalTopology, localTopology_.get(), fr, nullptr, mdAtoms, constr, vsite, nullptr);
  75     }
  76     // Send copy of initial topology to clients
  77     updateLocalTopology();
  78 }
  79
  80 const gmx_mtop_t& TopologyHolder::globalTopology() const
  81 {
  82     return globalTopology_;
  83 }
  84
  85 void TopologyHolder::updateLocalTopology()
  86 {
  87     for (auto& client : clients_)
  88     {
  89         client->setTopology(localTopology_.get());
  90     }
  91 }
  92
  93 void TopologyHolder::Builder::registerClient(ITopologyHolderClient* client)
  94 {
  95     // Register client
  96     if (client)
  97     {
  98         if (state_ == ModularSimulatorBuilderState::NotAcceptingClientRegistrations)
  99         {
 100             throw SimulationAlgorithmSetupError(
 101                     "Tried to register to signaller after it was built.");
 102         }
 103         clients_.emplace_back(client);
 104     }
 105 }
 106 } // namespace gmx