src/gromacs/modularsimulator/forceelement.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 force element for the modular simulator
  37  *
  38  * \author Pascal Merz <pascal.merz@me.com>
  39  * \ingroup module_modularsimulator
  40  */
  41
  42 #ifndef GMX_MODULARSIMULATOR_FORCEELEMENT_H
  43 #define GMX_MODULARSIMULATOR_FORCEELEMENT_H
  44
  45 #include <array>
  46
  47 #include "gromacs/domdec/dlbtiming.h"
  48 #include "gromacs/mdtypes/md_enums.h"
  49 #include "gromacs/utility/real.h"
  50
  51 #include "modularsimulatorinterfaces.h"
  52 #include "topologyholder.h"
  53
  54 struct gmx_enfrot;
  55 struct gmx_wallcycle;
  56 struct pull_t;
  57 struct t_fcdata;
  58 struct t_nrnb;
  59
  60 namespace gmx
  61 {
  62 class Awh;
  63 class EnergyElement;
  64 class FreeEnergyPerturbationElement;
  65 class ImdSession;
  66 class MDAtoms;
  67 class MdrunScheduleWorkload;
  68 class StatePropagatorData;
  69
  70 /*! \libinternal
  71  * \ingroup module_modularsimulator
  72  * \brief Force element
  73  *
  74  * The force element manages the call to do_force(...)
  75  */
  76 class ForceElement final :
  77     public ISimulatorElement,
  78     public ITopologyHolderClient,
  79     public INeighborSearchSignallerClient,
  80     public IEnergySignallerClient
  81 {
  82 public:
  83     //! Constructor
  84     ForceElement(StatePropagatorData*           statePropagatorData,
  85                  EnergyElement*                 energyElement,
  86                  FreeEnergyPerturbationElement* freeEnergyPerturbationElement,
  87                  bool                           isDynamicBox,
  88                  FILE*                          fplog,
  89                  const t_commrec*               cr,
  90                  const t_inputrec*              inputrec,
  91                  const MDAtoms*                 mdAtoms,
  92                  t_nrnb*                        nrnb,
  93                  t_forcerec*                    fr,
  94                  t_fcdata*                      fcd,
  95                  gmx_wallcycle*                 wcycle,
  96                  MdrunScheduleWorkload*         runScheduleWork,
  97                  gmx_vsite_t*                   vsite,
  98                  ImdSession*                    imdSession,
  99                  pull_t*                        pull_work,
 100                  gmx_enfrot*                    enforcedRotation);
 101
 102     /*! \brief Register force calculation for step / time
 103      *
 104      * @param step                 The step number
 105      * @param time                 The time
 106      * @param registerRunFunction  Function allowing to register a run function
 107      */
 108     void scheduleTask(Step step, Time time, const RegisterRunFunctionPtr& registerRunFunction) override;
 109
 110     //! Check that we got the local topology
 111     void elementSetup() override;
 112     //! No element teardown needed
 113     void elementTeardown() override {}
 114
 115 private:
 116     //! ITopologyHolderClient implementation
 117     void setTopology(const gmx_localtop_t* top) override;
 118     //! INeighborSearchSignallerClient implementation
 119     SignallerCallbackPtr registerNSCallback() override;
 120     //! IEnergySignallerClient implementation
 121     SignallerCallbackPtr registerEnergyCallback(EnergySignallerEvent event) override;
 122     //! The actual do_force call
 123     void run(Step step, Time time, unsigned int flags);
 124
 125     //! The next NS step
 126     Step nextNSStep_;
 127     //! The next energy calculation step
 128     Step nextEnergyCalculationStep_;
 129     //! The next energy calculation step
 130     Step nextVirialCalculationStep_;
 131     //! The next free energy calculation step
 132     Step nextFreeEnergyCalculationStep_;
 133
 134     //! Pointer to the micro state
 135     StatePropagatorData* statePropagatorData_;
 136     //! Pointer to the energy element
 137     EnergyElement* energyElement_;
 138     //! Pointer to the free energy perturbation element
 139     FreeEnergyPerturbationElement* freeEnergyPerturbationElement_;
 140
 141     //! The local topology - updated by Topology via Client system
 142     const gmx_localtop_t* localTopology_;
 143
 144     //! Whether we're having a dynamic box
 145     const bool isDynamicBox_;
 146
 147     //! DD / DLB helper object
 148     const DDBalanceRegionHandler ddBalanceRegionHandler_;
 149
 150     /* \brief The FEP lambda vector
 151      *
 152      * Used if FEP is off, since do_force
 153      * requires lambda to be allocated anyway
 154      */
 155     std::array<real, efptNR> lambda_;
 156
 157     // Access to ISimulator data
 158     //! Handles logging.
 159     FILE* fplog_;
 160     //! Handles communication.
 161     const t_commrec* cr_;
 162     //! Contains user input mdp options.
 163     const t_inputrec* inputrec_;
 164     //! Atom parameters for this domain.
 165     const MDAtoms* mdAtoms_;
 166     //! Manages flop accounting.
 167     t_nrnb* nrnb_;
 168     //! Manages wall cycle accounting.
 169     gmx_wallcycle* wcycle_;
 170     //! Parameters for force calculations.
 171     t_forcerec* fr_;
 172     //! Handles virtual sites.
 173     gmx_vsite_t* vsite_;
 174     //! The Interactive Molecular Dynamics session.
 175     ImdSession* imdSession_;
 176     //! The pull work object.
 177     pull_t* pull_work_;
 178     //! Helper struct for force calculations.
 179     t_fcdata* fcd_;
 180     //! Schedule of work for each MD step for this task.
 181     MdrunScheduleWorkload* runScheduleWork_;
 182     //! Handles enforced rotation.
 183     gmx_enfrot* enforcedRotation_;
 184 };
 185
 186 } // namespace gmx
 187
 188 #endif // GMX_MODULARSIMULATOR_FORCEELEMENT_H