src/gromacs/modularsimulator/forceelement.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 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/domdec/mdsetup.h"
  47 #include "gromacs/math/vectypes.h"
  48 #include "gromacs/mdlib/constr.h"
  49 #include "gromacs/mdlib/force.h"
  50 #include "gromacs/mdlib/force_flags.h"
  51 #include "gromacs/mdlib/mdatoms.h"
  52 #include "gromacs/mdrun/shellfc.h"
  53 #include "gromacs/mdtypes/forcebuffers.h"
  54 #include "gromacs/mdtypes/inputrec.h"
  55 #include "gromacs/mdtypes/mdatom.h"
  56 #include "gromacs/mdtypes/mdrunoptions.h"
  57 #include "gromacs/pbcutil/pbc.h"
  58
  59 #include "energydata.h"
  60 #include "freeenergyperturbationdata.h"
  61 #include "modularsimulator.h"
  62 #include "simulatoralgorithm.h"
  63 #include "statepropagatordata.h"
  64
  65 struct gmx_edsam;
  66 struct gmx_enfrot;
  67 struct gmx_multisim_t;
  68 class history_t;
  69
  70 namespace gmx
  71 {
  72 ForceElement::ForceElement(StatePropagatorData*        statePropagatorData,
  73                            EnergyData*                 energyData,
  74                            FreeEnergyPerturbationData* freeEnergyPerturbationData,
  75                            bool                        isVerbose,
  76                            bool                        isDynamicBox,
  77                            FILE*                       fplog,
  78                            const t_commrec*            cr,
  79                            const t_inputrec*           inputrec,
  80                            const MDAtoms*              mdAtoms,
  81                            t_nrnb*                     nrnb,
  82                            t_forcerec*                 fr,
  83
  84                            gmx_wallcycle*         wcycle,
  85                            MdrunScheduleWorkload* runScheduleWork,
  86                            VirtualSitesHandler*   vsite,
  87                            ImdSession*            imdSession,
  88                            pull_t*                pull_work,
  89                            Constraints*           constr,
  90                            const gmx_mtop_t*      globalTopology,
  91                            gmx_enfrot*            enforcedRotation) :
  92     shellfc_(init_shell_flexcon(fplog,
  93                                 globalTopology,
  94                                 constr ? constr->numFlexibleConstraints() : 0,
  95                                 inputrec->nstcalcenergy,
  96                                 DOMAINDECOMP(cr))),
  97     doShellFC_(shellfc_ != nullptr),
  98     nextNSStep_(-1),
  99     nextEnergyCalculationStep_(-1),
 100     nextVirialCalculationStep_(-1),
 101     nextFreeEnergyCalculationStep_(-1),
 102     statePropagatorData_(statePropagatorData),
 103     energyData_(energyData),
 104     freeEnergyPerturbationData_(freeEnergyPerturbationData),
 105     localTopology_(nullptr),
 106     isDynamicBox_(isDynamicBox),
 107     isVerbose_(isVerbose),
 108     nShellRelaxationSteps_(0),
 109     ddBalanceRegionHandler_(cr),
 110     lambda_(),
 111     fplog_(fplog),
 112     cr_(cr),
 113     inputrec_(inputrec),
 114     mdAtoms_(mdAtoms),
 115     nrnb_(nrnb),
 116     wcycle_(wcycle),
 117     fr_(fr),
 118     vsite_(vsite),
 119     imdSession_(imdSession),
 120     pull_work_(pull_work),
 121     runScheduleWork_(runScheduleWork),
 122     constr_(constr),
 123     enforcedRotation_(enforcedRotation)
 124 {
 125     lambda_.fill(0);
 126
 127     if (doShellFC_ && !DOMAINDECOMP(cr))
 128     {
 129         // This was done in mdAlgorithmsSetupAtomData(), but shellfc
 130         // won't be available outside this element.
 131         make_local_shells(cr, mdAtoms->mdatoms(), shellfc_);
 132     }
 133 }
 134
 135 void ForceElement::scheduleTask(Step step, Time time, const RegisterRunFunction& registerRunFunction)
 136 {
 137     unsigned int flags =
 138             (GMX_FORCE_STATECHANGED | GMX_FORCE_ALLFORCES | (isDynamicBox_ ? GMX_FORCE_DYNAMICBOX : 0)
 139              | (nextVirialCalculationStep_ == step ? GMX_FORCE_VIRIAL : 0)
 140              | (nextEnergyCalculationStep_ == step ? GMX_FORCE_ENERGY : 0)
 141              | (nextFreeEnergyCalculationStep_ == step ? GMX_FORCE_DHDL : 0)
 142              | (!doShellFC_ && nextNSStep_ == step ? GMX_FORCE_NS : 0));
 143
 144     registerRunFunction([this, step, time, flags]() {
 145         if (doShellFC_)
 146         {
 147             run<true>(step, time, flags);
 148         }
 149         else
 150         {
 151             run<false>(step, time, flags);
 152         }
 153     });
 154 }
 155
 156 void ForceElement::elementSetup()
 157 {
 158     GMX_ASSERT(localTopology_, "Setup called before local topology was set.");
 159 }
 160
 161 template<bool doShellFC>
 162 void ForceElement::run(Step step, Time time, unsigned int flags)
 163 {
 164     // Disabled functionality
 165     gmx_multisim_t* ms = nullptr;
 166
 167
 168     if (!DOMAINDECOMP(cr_) && (flags & GMX_FORCE_NS) && inputrecDynamicBox(inputrec_))
 169     {
 170         // TODO: Correcting the box is done in DomDecHelper (if using DD) or here (non-DD simulations).
 171         //       Think about unifying this responsibility, could this be done in one place?
 172         auto box = statePropagatorData_->box();
 173         correct_box(fplog_, step, box);
 174     }
 175
 176     /* The coordinates (x) are shifted (to get whole molecules)
 177      * in do_force.
 178      * This is parallelized as well, and does communication too.
 179      * Check comments in sim_util.c
 180      */
 181     auto       x      = statePropagatorData_->positionsView();
 182     auto&      forces = statePropagatorData_->forcesView();
 183     auto       box    = statePropagatorData_->constBox();
 184     history_t* hist   = nullptr; // disabled
 185
 186     tensor force_vir = { { 0 } };
 187     // TODO: Make lambda const (needs some adjustments in lower force routines)
 188     ArrayRef<real> lambda =
 189             freeEnergyPerturbationData_ ? freeEnergyPerturbationData_->lambdaView() : lambda_;
 190
 191     if (doShellFC)
 192     {
 193         auto v = statePropagatorData_->velocitiesView();
 194
 195         relax_shell_flexcon(
 196                 fplog_, cr_, ms, isVerbose_, enforcedRotation_, step, inputrec_, imdSession_,
 197                 pull_work_, step == nextNSStep_, static_cast<int>(flags), localTopology_, constr_,
 198                 energyData_->enerdata(), statePropagatorData_->localNumAtoms(), x, v, box, lambda,
 199                 hist, &forces, force_vir, mdAtoms_->mdatoms(), nrnb_, wcycle_, shellfc_, fr_,
 200                 runScheduleWork_, time, energyData_->muTot(), vsite_, ddBalanceRegionHandler_);
 201         nShellRelaxationSteps_++;
 202     }
 203     else
 204     {
 205         // Disabled functionality
 206         Awh*       awh = nullptr;
 207         gmx_edsam* ed  = nullptr;
 208
 209         do_force(fplog_, cr_, ms, inputrec_, awh, enforcedRotation_, imdSession_, pull_work_, step,
 210                  nrnb_, wcycle_, localTopology_, box, x, hist, &forces, force_vir,
 211                  mdAtoms_->mdatoms(), energyData_->enerdata(), lambda, fr_, runScheduleWork_, vsite_,
 212                  energyData_->muTot(), time, ed, static_cast<int>(flags), ddBalanceRegionHandler_);
 213     }
 214     energyData_->addToForceVirial(force_vir, step);
 215 }
 216
 217 void ForceElement::elementTeardown()
 218 {
 219     if (doShellFC_)
 220     {
 221         done_shellfc(fplog_, shellfc_, nShellRelaxationSteps_);
 222     }
 223 }
 224
 225 void ForceElement::setTopology(const gmx_localtop_t* top)
 226 {
 227     localTopology_ = top;
 228 }
 229
 230 std::optional<SignallerCallback> ForceElement::registerNSCallback()
 231 {
 232     return [this](Step step, Time gmx_unused time) { this->nextNSStep_ = step; };
 233 }
 234
 235 std::optional<SignallerCallback> ForceElement::registerEnergyCallback(EnergySignallerEvent event)
 236 {
 237     if (event == EnergySignallerEvent::EnergyCalculationStep)
 238     {
 239         return [this](Step step, Time /*unused*/) { nextEnergyCalculationStep_ = step; };
 240     }
 241     if (event == EnergySignallerEvent::VirialCalculationStep)
 242     {
 243         return [this](Step step, Time /*unused*/) { nextVirialCalculationStep_ = step; };
 244     }
 245     if (event == EnergySignallerEvent::FreeEnergyCalculationStep)
 246     {
 247         return [this](Step step, Time /*unused*/) { nextFreeEnergyCalculationStep_ = step; };
 248     }
 249     return std::nullopt;
 250 }
 251
 252 ISimulatorElement*
 253 ForceElement::getElementPointerImpl(LegacySimulatorData*                    legacySimulatorData,
 254                                     ModularSimulatorAlgorithmBuilderHelper* builderHelper,
 255                                     StatePropagatorData*                    statePropagatorData,
 256                                     EnergyData*                             energyData,
 257                                     FreeEnergyPerturbationData* freeEnergyPerturbationData,
 258                                     GlobalCommunicationHelper gmx_unused* globalCommunicationHelper)
 259 {
 260     const bool isVerbose    = legacySimulatorData->mdrunOptions.verbose;
 261     const bool isDynamicBox = inputrecDynamicBox(legacySimulatorData->inputrec);
 262     return builderHelper->storeElement(std::make_unique<ForceElement>(
 263             statePropagatorData, energyData, freeEnergyPerturbationData, isVerbose, isDynamicBox,
 264             legacySimulatorData->fplog, legacySimulatorData->cr, legacySimulatorData->inputrec,
 265             legacySimulatorData->mdAtoms, legacySimulatorData->nrnb, legacySimulatorData->fr,
 266             legacySimulatorData->wcycle, legacySimulatorData->runScheduleWork, legacySimulatorData->vsite,
 267             legacySimulatorData->imdSession, legacySimulatorData->pull_work, legacySimulatorData->constr,
 268             legacySimulatorData->top_global, legacySimulatorData->enforcedRotation));
 269 }
 270 } // namespace gmx