src/gromacs/mdtypes/awh_history.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2017,2018,2019,2021, 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 \file
  37  *
  38  * \brief
  39  * Contains datatypes and function declarations needed by AWH to
  40  * have its data checkpointed.
  41  *
  42  * \author Viveca Lindahl
  43  * \inlibraryapi
  44  * \ingroup module_mdtypes
  45  */
  46
  47 #ifndef GMX_MDTYPES_AWHHISTORY_H
  48 #define GMX_MDTYPES_AWHHISTORY_H
  49
  50 #include <cstdint>
  51
  52 #include <vector>
  53
  54 #include "gromacs/mdtypes/awh_correlation_history.h"
  55
  56 namespace gmx
  57 {
  58 enum class CheckpointDataOperation;
  59 template<CheckpointDataOperation operation>
  60 class CheckpointData;
  61
  62 /*! \cond INTERNAL */
  63
  64 //! Grid point state history data.
  65 struct AwhPointStateHistory
  66 {
  67     double  bias;                /**< Current biasing function estimate */
  68     double  free_energy;         /**< Current estimate of the convolved free energy/PMF. */
  69     double  target;              /**< Current target distribution, normalized to 1 */
  70     double  weightsum_iteration; /**< Accumulated weight this iteration (1 replica) */
  71     double  weightsum_covering;  /**< Accumulated weights for covering checks */
  72     double  weightsum_tot;       /**< Accumulated weights, never reset */
  73     double  weightsum_ref;       /**< The reference weight histogram determining the f updates */
  74     int64_t last_update_index;   /**< The last update that was performed at this point. */
  75     double  log_pmfsum;          /**< Logarithm of the PMF histogram (for 1 replica) */
  76     double  visits_iteration;    /**< Visits to this bin this iteration (1 replica) */
  77     double  visits_tot;          /**< Accumulated visits to this bin */
  78 };
  79
  80 //! The global AWH bias history state, contains most data of the corresponding struct in awh.h.
  81 struct AwhBiasStateHistory
  82 {
  83     int     umbrellaGridpoint; /**< Index for the current umbrella reference coordinate point (for umbrella potential type) */
  84     int     origin_index_updatelist; /**< Point index of the origin of the subgrid that has been touched since last update. */
  85     int     end_index_updatelist; /**< Point index of the end of the subgrid that has been touched since last update. */
  86     bool    in_initial;           /**< True if in the intial stage. */
  87     bool    equilibrateHistogram; /**< True if histogram needs equilibration. */
  88     double  histSize;             /**< Size of reference weight histogram. */
  89     double  logScaledSampleWeight; /**< The log of the current sample weight, scaled because of the histogram rescaling. */
  90     double  maxLogScaledSampleWeight; /**< Maximum sample weight obtained for previous (smaller) histogram sizes. */
  91     int64_t numUpdates; /**< The number of updates. */
  92
  93     /*! \brief Constructor. */
  94     AwhBiasStateHistory() :
  95         umbrellaGridpoint(0),
  96         origin_index_updatelist(0),
  97         end_index_updatelist(0),
  98         in_initial(false),
  99         equilibrateHistogram(false),
 100         histSize(0),
 101         logScaledSampleWeight(0),
 102         maxLogScaledSampleWeight(0),
 103         numUpdates(0)
 104     {
 105     }
 106 };
 107
 108 //! AWH bias history data. Note that this is a copy of an AWH internal struct.
 109 struct AwhBiasHistory
 110 {
 111     std::vector<AwhPointStateHistory> pointState; /**< History for grid coordinate points. */
 112
 113     AwhBiasStateHistory    state;                /**< The global state of the AWH bias. */
 114     CorrelationGridHistory forceCorrelationGrid; /**< History for force correlation statistics. */
 115 };
 116
 117 //! A collection of AWH bias history data. */
 118 struct AwhHistory
 119 {
 120     std::vector<AwhBiasHistory> bias; /**< History for each bias. */
 121     double potentialOffset;           /**< The offset of the bias potential due to bias updates. */
 122
 123     /*! \brief Constructor. */
 124     AwhHistory() : potentialOffset(0) {}
 125
 126     /*! \brief Allows to read and write checkpoint within modular simulator
 127      *
 128      * \tparam operation  Whether we're reading or writing
 129      * \param checkpointData  The CheckpointData object
 130      */
 131     template<CheckpointDataOperation operation>
 132     void doCheckpoint(CheckpointData<operation> checkpointData);
 133 };
 134
 135 /*! \endcond */
 136
 137 } // namespace gmx
 138
 139 #endif