src/gromacs/modularsimulator/topologyholder.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, 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 /*! \libinternal \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
  42
  43 #ifndef GMX_MODULARSIMULATOR_TOPOLOGYHOLDER_H
  44 #define GMX_MODULARSIMULATOR_TOPOLOGYHOLDER_H
  45
  46 #include <vector>
  47
  48 #include "modularsimulatorinterfaces.h"
  49
  50 struct gmx_localtop_t;
  51 struct gmx_mtop_t;
  52 struct gmx_vsite_t;
  53 struct t_commrec;
  54 struct t_forcerec;
  55 struct t_inputrec;
  56
  57 namespace gmx
  58 {
  59 class Constraints;
  60 class MDAtoms;
  61
  62 /*! \libinternal
  63  * \ingroup module_modularsimulator
  64  * \brief Object holding the topology
  65  *
  66  * Clients can register to get an updated local topology whenever there
  67  * is a change (infrequent, only due to domdec currently).
  68  */
  69 class TopologyHolder final
  70 {
  71 public:
  72     //! Constructor
  73     TopologyHolder(const gmx_mtop_t& globalTopology,
  74                    const t_commrec*  cr,
  75                    const t_inputrec* inputrec,
  76                    t_forcerec*       fr,
  77                    MDAtoms*          mdAtoms,
  78                    Constraints*      constr,
  79                    gmx_vsite_t*      vsite);
  80
  81     //! Get global topology
  82     const gmx_mtop_t& globalTopology() const;
  83
  84     //! Register topology client
  85     void registerClient(ITopologyHolderClient* client);
  86
  87     //! Allow domdec to update local topology
  88     friend class DomDecHelper;
  89
  90 private:
  91     //! Constant reference to the global topolgy
  92     const gmx_mtop_t& globalTopology_;
  93     //! Pointer to the currently valid local topology
  94     std::unique_ptr<gmx_localtop_t> localTopology_;
  95
  96     //! List of clients to be updated if local topology changes
  97     std::vector<ITopologyHolderClient*> clients_;
  98
  99     //! Update local topology
 100     void updateLocalTopology();
 101 };
 102
 103 } // namespace gmx
 104
 105 #endif // GMX_MODULARSIMULATOR_TOPOLOGYHOLDER_H