src/gromacs/modularsimulator/forceelement.cpp

   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 /*! \internal \file
  36  * \brief Defines the force element 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 "forceelement.h"
  45
  46 #include "gromacs/math/vectypes.h"
  47 #include "gromacs/mdlib/force.h"
  48 #include "gromacs/mdlib/force_flags.h"
  49 #include "gromacs/mdlib/mdatoms.h"
  50
  51 #include "energyelement.h"
  52 #include "freeenergyperturbationelement.h"
  53 #include "statepropagatordata.h"
  54
  55 struct gmx_edsam;
  56 struct gmx_enfrot;
  57 struct gmx_multisim_t;
  58 class history_t;
  59 struct t_graph;
  60
  61 namespace gmx
  62 {
  63 ForceElement::ForceElement(StatePropagatorData*           statePropagatorData,
  64                            EnergyElement*                 energyElement,
  65                            FreeEnergyPerturbationElement* freeEnergyPerturbationElement,
  66                            bool                           isDynamicBox,
  67                            FILE*                          fplog,
  68                            const t_commrec*               cr,
  69                            const t_inputrec*              inputrec,
  70                            const MDAtoms*                 mdAtoms,
  71                            t_nrnb*                        nrnb,
  72                            t_forcerec*                    fr,
  73                            t_fcdata*                      fcd,
  74                            gmx_wallcycle*                 wcycle,
  75                            MdrunScheduleWorkload*         runScheduleWork,
  76                            gmx_vsite_t*                   vsite,
  77                            ImdSession*                    imdSession,
  78                            pull_t*                        pull_work,
  79                            gmx_enfrot*                    enforcedRotation) :
  80     nextNSStep_(-1),
  81     nextEnergyCalculationStep_(-1),
  82     nextVirialCalculationStep_(-1),
  83     nextFreeEnergyCalculationStep_(-1),
  84     statePropagatorData_(statePropagatorData),
  85     energyElement_(energyElement),
  86     freeEnergyPerturbationElement_(freeEnergyPerturbationElement),
  87     localTopology_(nullptr),
  88     isDynamicBox_(isDynamicBox),
  89     ddBalanceRegionHandler_(cr),
  90     lambda_(),
  91     fplog_(fplog),
  92     cr_(cr),
  93     inputrec_(inputrec),
  94     mdAtoms_(mdAtoms),
  95     nrnb_(nrnb),
  96     wcycle_(wcycle),
  97     fr_(fr),
  98     vsite_(vsite),
  99     imdSession_(imdSession),
 100     pull_work_(pull_work),
 101     fcd_(fcd),
 102     runScheduleWork_(runScheduleWork),
 103     enforcedRotation_(enforcedRotation)
 104 {
 105     lambda_.fill(0);
 106 }
 107
 108 void ForceElement::scheduleTask(Step step, Time time, const RegisterRunFunctionPtr& registerRunFunction)
 109 {
 110     unsigned int flags =
 111             (GMX_FORCE_STATECHANGED | GMX_FORCE_ALLFORCES | (isDynamicBox_ ? GMX_FORCE_DYNAMICBOX : 0)
 112              | (nextVirialCalculationStep_ == step ? GMX_FORCE_VIRIAL : 0)
 113              | (nextEnergyCalculationStep_ == step ? GMX_FORCE_ENERGY : 0)
 114              | (nextFreeEnergyCalculationStep_ == step ? GMX_FORCE_DHDL : 0)
 115              | (nextNSStep_ == step ? GMX_FORCE_NS : 0));
 116
 117     (*registerRunFunction)(std::make_unique<SimulatorRunFunction>(
 118             [this, step, time, flags]() { run(step, time, flags); }));
 119 }
 120
 121 void ForceElement::elementSetup()
 122 {
 123     GMX_ASSERT(localTopology_, "Setup called before local topology was set.");
 124 }
 125
 126 void ForceElement::run(Step step, Time time, unsigned int flags)
 127 {
 128     // Disabled functionality
 129     Awh*            awh   = nullptr;
 130     gmx_edsam*      ed    = nullptr;
 131     gmx_multisim_t* ms    = nullptr;
 132     t_graph*        graph = nullptr;
 133
 134     /* The coordinates (x) are shifted (to get whole molecules)
 135      * in do_force.
 136      * This is parallelized as well, and does communication too.
 137      * Check comments in sim_util.c
 138      */
 139     auto       x      = statePropagatorData_->positionsView();
 140     auto       forces = statePropagatorData_->forcesView();
 141     auto       box    = statePropagatorData_->constBox();
 142     history_t* hist   = nullptr; // disabled
 143
 144     tensor force_vir = { { 0 } };
 145     // TODO: Make lambda const (needs some adjustments in lower force routines)
 146     ArrayRef<real> lambda =
 147             freeEnergyPerturbationElement_ ? freeEnergyPerturbationElement_->lambdaView() : lambda_;
 148
 149     do_force(fplog_, cr_, ms, inputrec_, awh, enforcedRotation_, imdSession_, pull_work_, step,
 150              nrnb_, wcycle_, localTopology_, box, x, hist, forces, force_vir, mdAtoms_->mdatoms(),
 151              energyElement_->enerdata(), fcd_, lambda, graph, fr_, runScheduleWork_, vsite_,
 152              energyElement_->muTot(), time, ed, static_cast<int>(flags), ddBalanceRegionHandler_);
 153     energyElement_->addToForceVirial(force_vir, step);
 154 }
 155
 156 void ForceElement::setTopology(const gmx_localtop_t* top)
 157 {
 158     localTopology_ = top;
 159 }
 160
 161 SignallerCallbackPtr ForceElement::registerNSCallback()
 162 {
 163     return std::make_unique<SignallerCallback>(
 164             [this](Step step, Time gmx_unused time) { this->nextNSStep_ = step; });
 165 }
 166
 167 SignallerCallbackPtr ForceElement::registerEnergyCallback(EnergySignallerEvent event)
 168 {
 169     if (event == EnergySignallerEvent::EnergyCalculationStep)
 170     {
 171         return std::make_unique<SignallerCallback>(
 172                 [this](Step step, Time /*unused*/) { nextEnergyCalculationStep_ = step; });
 173     }
 174     if (event == EnergySignallerEvent::VirialCalculationStep)
 175     {
 176         return std::make_unique<SignallerCallback>(
 177                 [this](Step step, Time /*unused*/) { nextVirialCalculationStep_ = step; });
 178     }
 179     if (event == EnergySignallerEvent::FreeEnergyCalculationStep)
 180     {
 181         return std::make_unique<SignallerCallback>(
 182                 [this](Step step, Time /*unused*/) { nextFreeEnergyCalculationStep_ = step; });
 183     }
 184     return nullptr;
 185 }
 186 } // namespace gmx