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