src/gromacs/awh/awh.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2017,2018,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
  36 /*! \libinternal
  37  * \defgroup module_awh Accelerated weight histogram (AWH) method
  38  * \ingroup group_mdrun
  39  * \brief
  40  * Implements the "accelerated weight histogram" sampling method.
  41  *
  42  * This class provides the interface between the AWH module and
  43  * other modules using it. Currently AWH can only act on COM pull
  44  * reaction coordinates, but this can easily be extended to other
  45  * types of reaction coordinates.
  46  *
  47  * \author Viveca Lindahl
  48  * \author Berk Hess <hess@kth.se>
  49  */
  50
  51 /*! \libinternal \file
  52  *
  53  * \brief
  54  * Declares the Awh class.
  55  *
  56  * \author Viveca Lindahl
  57  * \author Berk Hess <hess@kth.se>
  58  * \inlibraryapi
  59  * \ingroup module_awh
  60  */
  61
  62 #ifndef GMX_AWH_H
  63 #define GMX_AWH_H
  64
  65 #include <cstdio>
  66
  67 #include <memory>
  68 #include <string>
  69 #include <vector>
  70
  71 #include "gromacs/math/vectypes.h"
  72 #include "gromacs/utility/basedefinitions.h"
  73
  74 struct gmx_multisim_t;
  75 struct gmx_wallcycle;
  76 struct pull_work_t;
  77 struct pull_t;
  78 class t_state;
  79 struct t_commrec;
  80 struct t_enxframe;
  81 struct t_inputrec;
  82 struct t_mdatoms;
  83 enum class PbcType : int;
  84
  85 namespace gmx
  86 {
  87
  88 struct AwhHistory;
  89 struct AwhParams;
  90 class Bias;
  91 struct BiasCoupledToSystem;
  92 class ForceWithVirial;
  93
  94 /*! \libinternal
  95  * \brief Coupling of the accelerated weight histogram method (AWH) with the system.
  96  *
  97  * AWH calculates the free energy along order parameters of the system.
  98  * Free energy barriers are overcome by adaptively tuning a bias potential along
  99  * the order parameter such that the biased distribution along the parameter
 100  * converges toward a chosen target distribution.
 101  *
 102  * The Awh class takes care of the coupling between the system and the AWH
 103  * bias(es). The Awh class contains one or more BiasCoupledToSystem objects.
 104  * The BiasCoupledToSystem class takes care of the reaction coordinate input
 105  * and force output for the single Bias object it containts.
 106  *
 107  * \todo Update parameter reading and checkpointing, when general C++ framework is ready.
 108  */
 109 class Awh
 110 {
 111 public:
 112     /*! \brief Construct an AWH at the start of a simulation.
 113      *
 114      * AWH will here also register itself with the pull struct as the
 115      * potential provider for the pull coordinates given as AWH coordinates
 116      * in the user input. This allows AWH to later apply the bias force to
 117      * these coordinate in \ref Awh::applyBiasForcesAndUpdateBias.
 118      *
 119      * \param[in,out] fplog             General output file, normally md.log, can be nullptr.
 120      * \param[in]     inputRecord       General input parameters (as set up by grompp).
 121      * \param[in]     commRecord        Struct for communication, can be nullptr.
 122      * \param[in]     multiSimRecord    Multi-sim handler
 123      * \param[in]     awhParams         AWH input parameters, consistent with the relevant parts of \p inputRecord (as set up by grompp).
 124      * \param[in]     biasInitFilename  Name of file to read PMF and target from.
 125      * \param[in,out] pull_work         Pointer to a pull struct which AWH will couple to, has to be initialized, is assumed not to change during the lifetime of the Awh object.
 126      */
 127     Awh(FILE*                 fplog,
 128         const t_inputrec&     inputRecord,
 129         const t_commrec*      commRecord,
 130         const gmx_multisim_t* multiSimRecord,
 131         const AwhParams&      awhParams,
 132         const std::string&    biasInitFilename,
 133         pull_t*               pull_work);
 134
 135     ~Awh();
 136
 137     /*! \brief Peform an AWH update, to be called every MD step.
 138      *
 139      * An update has two tasks: apply the bias force and improve
 140      * the bias and the free energy estimate that AWH keeps internally.
 141      *
 142      * For the first task, AWH retrieves the pull coordinate values from the pull struct.
 143      * With these, the bias potential and forces are calculated.
 144      * The bias force together with the atom forces and virial
 145      * are passed on to pull which applies the bias force to the atoms.
 146      * This is done at every step.
 147      *
 148      * Secondly, coordinate values are regularly sampled and kept by AWH.
 149      * Convergence of the bias and free energy estimate is achieved by
 150      * updating the AWH bias state after a certain number of samples has been collected.
 151      *
 152      * \note Requires that pull_potential from pull.h has been called first
 153      * since AWH needs the current coordinate values (the pull code checks
 154      * for this).
 155      *
 156      * \param[in]     mdatoms          Atom properties.
 157      * \param[in]     pbcType          Type of periodic boundary conditions.
 158      * \param[in]     box              Box vectors.
 159      * \param[in,out] forceWithVirial  Force and virial buffers, should cover at least the local atoms.
 160      * \param[in]     t                Time.
 161      * \param[in]     step             The current MD step.
 162      * \param[in,out] wallcycle        Wallcycle counter, can be nullptr.
 163      * \param[in,out] fplog            General output file, normally md.log, can be nullptr.
 164      * \returns the potential energy for the bias.
 165      */
 166     real applyBiasForcesAndUpdateBias(PbcType               pbcType,
 167                                       const t_mdatoms&      mdatoms,
 168                                       const matrix          box,
 169                                       gmx::ForceWithVirial* forceWithVirial,
 170                                       double                t,
 171                                       int64_t               step,
 172                                       gmx_wallcycle*        wallcycle,
 173                                       FILE*                 fplog);
 174
 175     /*! \brief
 176      * Update the AWH history in preparation for writing to checkpoint file.
 177      *
 178      * Should be called at least on the master rank at checkpoint steps.
 179      *
 180      * Should be called with a valid \p awhHistory (is checked).
 181      *
 182      * \param[in,out] awhHistory  AWH history to set.
 183      */
 184     void updateHistory(AwhHistory* awhHistory) const;
 185
 186     /*! \brief
 187      * Allocate and initialize an AWH history with the given AWH state.
 188      *
 189      * This function should be called at the start of a new simulation
 190      * at least on the master rank.
 191      * Note that only constant data will be initialized here.
 192      * History data is set by \ref Awh::updateHistory.
 193      *
 194      * \returns a shared pointer to the AWH history on the rank that does I/O, nullptr otherwise.
 195      */
 196     std::shared_ptr<AwhHistory> initHistoryFromState() const;
 197
 198     /*! \brief Restore the AWH state from the given history.
 199      *
 200      * Should be called on all ranks (for internal MPI broadcast).
 201      * Should pass a point to an AwhHistory on the master rank that
 202      * is compatible with the AWH setup in this simulation. Will throw
 203      * an exception if it is not compatible.
 204      *
 205      * \param[in] awhHistory  AWH history to restore from.
 206      */
 207     void restoreStateFromHistory(const AwhHistory* awhHistory);
 208
 209     /*! \brief Fills the AWH data block of an energy frame with data at certain steps.
 210      *
 211      * \param[in]     step  The current MD step.
 212      * \param[in,out] fr    Energy data frame.
 213      */
 214     void writeToEnergyFrame(int64_t step, t_enxframe* fr) const;
 215
 216     /*! \brief Returns string "AWH" for registering AWH as an external potential provider with the pull module.
 217      */
 218     static const char* externalPotentialString();
 219
 220     /*! \brief Register the AWH biased coordinates with pull.
 221      *
 222      * This function is public because it needs to be called by grompp
 223      * (and is otherwise only called by Awh()).
 224      * Pull requires all external potentials to register themselves
 225      * before the end of pre-processing and before the first MD step.
 226      * If this has not happened, pull with throw an error.
 227      *
 228      * \param[in]     awhParams  The AWH parameters.
 229      * \param[in,out] pull_work  Pull struct which AWH will register the bias into.
 230      */
 231     static void registerAwhWithPull(const AwhParams& awhParams, pull_t* pull_work);
 232
 233 private:
 234     /*! \brief Returns whether we need to write output at the current step.
 235      *
 236      * \param[in]     step             The current MD step.
 237      */
 238     bool isOutputStep(int64_t step) const;
 239
 240 private:
 241     std::vector<BiasCoupledToSystem> biasCoupledToSystem_; /**< AWH biases and definitions of their coupling to the system. */
 242     const int64_t    seed_;   /**< Random seed for MC jumping with umbrella type bias potential. */
 243     const int        nstout_; /**< Interval in steps for writing to energy file. */
 244     const t_commrec* commRecord_;          /**< Pointer to the communication record. */
 245     const gmx_multisim_t* multiSimRecord_; /**< Handler for multi-simulations. */
 246     pull_t*               pull_;           /**< Pointer to the pull working data. */
 247     double                potentialOffset_; /**< The offset of the bias potential which changes due to bias updates. */
 248 };
 249
 250 /*! \brief Makes an Awh and prepares to use it if the user input
 251  * requests that
 252  *
 253  * Restores state from history in checkpoint if needed.
 254  *
 255  * \param[in,out] fplog                   General output file, normally md.log, can be nullptr.
 256  * \param[in]     inputRecord             General input parameters (as set up by grompp).
 257  * \param[in]     stateGlobal             A pointer to the global state structure.
 258  * \param[in]     commRecord              Struct for communication, can be nullptr.
 259  * \param[in]     multiSimRecord          Multi-sim handler
 260  * \param[in]     startingFromCheckpoint  Whether the simulation is starting from a checkpoint
 261  * \param[in]     usingShellParticles     Whether the user requested shell particles (which is unsupported)
 262  * \param[in]     biasInitFilename        Name of file to read PMF and target from.
 263  * \param[in,out] pull_work               Pointer to a pull struct which AWH will couple to, has to be initialized,
 264  *                                        is assumed not to change during the lifetime of the Awh object.
 265  * \returns       An initialized Awh module, or nullptr if none was requested.
 266  * \throws        InvalidInputError       If another active module is not supported.
 267  */
 268 std::unique_ptr<Awh> prepareAwhModule(FILE*                 fplog,
 269                                       const t_inputrec&     inputRecord,
 270                                       t_state*              stateGlobal,
 271                                       const t_commrec*      commRecord,
 272                                       const gmx_multisim_t* multiSimRecord,
 273                                       bool                  startingFromCheckpoint,
 274                                       bool                  usingShellParticles,
 275                                       const std::string&    biasInitFilename,
 276                                       pull_t*               pull_work);
 277
 278 } // namespace gmx
 279
 280 #endif /* GMX_AWH_H */