src/gromacs/modularsimulator/freeenergyperturbationelement.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 free energy perturbation 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 "freeenergyperturbationelement.h"
  45
  46 #include "gromacs/mdlib/md_support.h"
  47 #include "gromacs/mdlib/mdatoms.h"
  48 #include "gromacs/mdtypes/inputrec.h"
  49 #include "gromacs/mdtypes/mdatom.h"
  50 #include "gromacs/mdtypes/state.h"
  51
  52 namespace gmx
  53 {
  54
  55 FreeEnergyPerturbationElement::FreeEnergyPerturbationElement(FILE*             fplog,
  56                                                              const t_inputrec* inputrec,
  57                                                              MDAtoms*          mdAtoms) :
  58     lambda_(),
  59     lambda0_(),
  60     currentFEPState_(0),
  61     lambdasChange_(inputrec->fepvals->delta_lambda != 0),
  62     fplog_(fplog),
  63     inputrec_(inputrec),
  64     mdAtoms_(mdAtoms)
  65 {
  66     lambda_.fill(0);
  67     lambda0_.fill(0);
  68     initialize_lambdas(fplog_, *inputrec_, true, &currentFEPState_, lambda_, lambda0_.data());
  69     update_mdatoms(mdAtoms_->mdatoms(), lambda_[efptMASS]);
  70 }
  71
  72 void FreeEnergyPerturbationElement::scheduleTask(Step step,
  73                                                  Time gmx_unused               time,
  74                                                  const RegisterRunFunctionPtr& registerRunFunction)
  75 {
  76     if (lambdasChange_)
  77     {
  78         (*registerRunFunction)(
  79                 std::make_unique<SimulatorRunFunction>([this, step]() { updateLambdas(step); }));
  80     }
  81 }
  82
  83 void FreeEnergyPerturbationElement::updateLambdas(Step step)
  84 {
  85     // at beginning of step (if lambdas change...)
  86     setCurrentLambdasLocal(step, inputrec_->fepvals, lambda0_.data(), lambda_, currentFEPState_);
  87     update_mdatoms(mdAtoms_->mdatoms(), lambda_[efptMASS]);
  88 }
  89
  90 ArrayRef<real> FreeEnergyPerturbationElement::lambdaView()
  91 {
  92     return lambda_;
  93 }
  94
  95 ArrayRef<const real> FreeEnergyPerturbationElement::constLambdaView()
  96 {
  97     return lambda_;
  98 }
  99
 100 int FreeEnergyPerturbationElement::currentFEPState()
 101 {
 102     return currentFEPState_;
 103 }
 104
 105 void FreeEnergyPerturbationElement::writeCheckpoint(t_state* localState, t_state gmx_unused* globalState)
 106 {
 107     localState->fep_state = currentFEPState_;
 108     localState->lambda    = lambda_;
 109     localState->flags |= (1U << estLAMBDA) | (1U << estFEPSTATE);
 110 }
 111
 112 } // namespace gmx