src/gromacs/modularsimulator/topologyholder.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,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 /*! \internal \file
  36  * \brief Declares the topology class for the modular simulator
  37  *
  38  * \author Pascal Merz <pascal.merz@me.com>
  39  * \ingroup module_modularsimulator
  40  *
  41  * This header is only used within the modular simulator module
  42  */
  43
  44
  45 #ifndef GMX_MODULARSIMULATOR_TOPOLOGYHOLDER_H
  46 #define GMX_MODULARSIMULATOR_TOPOLOGYHOLDER_H
  47
  48 #include <vector>
  49
  50 #include "gromacs/compat/pointers.h"
  51
  52 #include "modularsimulatorinterfaces.h"
  53
  54 struct gmx_localtop_t;
  55 struct gmx_mtop_t;
  56 struct t_commrec;
  57 struct t_forcerec;
  58 struct t_inputrec;
  59
  60 namespace gmx
  61 {
  62 class Constraints;
  63 class MDAtoms;
  64 class VirtualSitesHandler;
  65
  66 /*! \internal
  67  * \ingroup module_modularsimulator
  68  * \brief Object holding the topology
  69  *
  70  * Clients can register to get an updated local topology whenever there
  71  * is a change (infrequent, only due to domdec currently).
  72  */
  73 class TopologyHolder final : public IDomDecHelperClient
  74 {
  75 public:
  76     //! Constructor
  77     TopologyHolder(std::vector<ITopologyHolderClient*> clients,
  78                    const gmx_mtop_t&                   globalTopology,
  79                    gmx_localtop_t*                     localTopology,
  80                    const t_commrec*                    cr,
  81                    const t_inputrec*                   inputrec,
  82                    t_forcerec*                         fr,
  83                    MDAtoms*                            mdAtoms,
  84                    Constraints*                        constr,
  85                    VirtualSitesHandler*                vsite);
  86
  87     //! Get global topology
  88     const gmx_mtop_t& globalTopology() const;
  89
  90     //! Callback on domain decomposition repartitioning
  91     DomDecCallback registerDomDecCallback() override;
  92
  93     //! Allow domdec to access local topology directly
  94     friend class DomDecHelper;
  95
  96     //! The builder
  97     class Builder;
  98
  99 private:
 100     //! Constant reference to the global topology
 101     const gmx_mtop_t& globalTopology_;
 102     //! Pointer to the currently valid local topology
 103     gmx_localtop_t* localTopology_;
 104
 105     //! List of clients to be updated if local topology changes
 106     std::vector<ITopologyHolderClient*> clients_;
 107
 108     //! Update local topology
 109     void updateLocalTopology();
 110 };
 111
 112 /*! \internal
 113  * \ingroup module_modularsimulator
 114  * \brief Builder for the topology holder
 115  */
 116 class TopologyHolder::Builder
 117 {
 118 public:
 119     //! Register topology client
 120     void registerClient(ITopologyHolderClient* client);
 121
 122     //! Build TopologyHolder
 123     template<typename... Args>
 124     std::unique_ptr<TopologyHolder> build(Args&&... args);
 125
 126 private:
 127     //! List of clients to be updated if local topology changes
 128     std::vector<ITopologyHolderClient*> clients_;
 129     //! The state of the builder
 130     ModularSimulatorBuilderState state_ = ModularSimulatorBuilderState::AcceptingClientRegistrations;
 131 };
 132
 133 template<typename... Args>
 134 std::unique_ptr<TopologyHolder> TopologyHolder::Builder::build(Args&&... args)
 135 {
 136     state_ = ModularSimulatorBuilderState::NotAcceptingClientRegistrations;
 137     return std::make_unique<TopologyHolder>(std::move(clients_), std::forward<Args>(args)...);
 138 }
 139
 140 } // namespace gmx
 141
 142 #endif // GMX_MODULARSIMULATOR_TOPOLOGYHOLDER_H