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, 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 <vector>
  51
  52 #include "gromacs/mdtypes/awh-correlation-history.h"
  53 #include "gromacs/utility/basedefinitions.h"
  54
  55 namespace gmx
  56 {
  57
  58 /*! \cond INTERNAL */
  59
  60 //! Grid point state history data.
  61 struct AwhPointStateHistory
  62 {
  63     double         bias;                /**< Current biasing function estimate */
  64     double         free_energy;         /**< Current estimate of the convolved free energy/PMF. */
  65     double         target;              /**< Current target distribution, normalized to 1 */
  66     double         weightsum_iteration; /**< Accumulated weight this iteration (1 replica) */
  67     double         weightsum_covering;  /**< Accumulated weights for covering checks */
  68     double         weightsum_tot;       /**< Accumulated weights, never reset */
  69     double         weightsum_ref;       /**< The reference weight histogram determining the f updates */
  70     int64_t        last_update_index;   /**< The last update that was performed at this point. */
  71     double         log_pmfsum;          /**< Logarithm of the PMF histogram (for 1 replica) */
  72     double         visits_iteration;    /**< Visits to this bin this iteration (1 replica) */
  73     double         visits_tot;          /**< Accumulated visits to this bin */
  74 };
  75
  76 //! The global AWH bias history state, contains most data of the corresponding struct in awh.h.
  77 struct AwhBiasStateHistory
  78 {
  79     int         umbrellaGridpoint;        /**< Index for the current umbrella reference coordinate point (for umbrella potential type) */
  80     int         origin_index_updatelist;  /**< Point index of the origin of the subgrid that has been touched since last update. */
  81     int         end_index_updatelist;     /**< Point index of the end of the subgrid that has been touched since last update. */
  82     int         in_initial;               /**< True if in the intial stage. */
  83     int         equilibrateHistogram;     /**< True if histogram needs equilibration. */
  84     double      histSize;                 /**< Size of reference weight histogram. */
  85     double      logScaledSampleWeight;    /**< The log of the current sample weight, scaled because of the histogram rescaling. */
  86     double      maxLogScaledSampleWeight; /**< Maximum sample weight obtained for previous (smaller) histogram sizes. */
  87     int64_t     numUpdates;               /**< The number of updates. */
  88
  89     /*! \brief Constructor. */
  90     AwhBiasStateHistory() : umbrellaGridpoint(0),
  91                             origin_index_updatelist(0),
  92                             end_index_updatelist(0),
  93                             in_initial(0),
  94                             equilibrateHistogram(0),
  95                             histSize(0),
  96                             logScaledSampleWeight(0),
  97                             maxLogScaledSampleWeight(0),
  98                             numUpdates(0)
  99     {
 100     }
 101 };
 102
 103 //! AWH bias history data. Note that this is a copy of an AWH internal struct.
 104 struct AwhBiasHistory
 105 {
 106     std::vector<AwhPointStateHistory> pointState;           /**< History for grid coordinate points. */
 107
 108     AwhBiasStateHistory               state;                /**< The global state of the AWH bias. */
 109     CorrelationGridHistory            forceCorrelationGrid; /**< History for force correlation statistics. */
 110 };
 111
 112 //! A collection of AWH bias history data. */
 113 struct AwhHistory
 114 {
 115     std::vector<AwhBiasHistory> bias;            /**< History for each bias. */
 116     double                      potentialOffset; /**< The offset of the bias potential due to bias updates. */
 117
 118     /*! \brief Constructor. */
 119     AwhHistory() :
 120         potentialOffset(0)
 121     {
 122     }
 123 };
 124
 125 /*! \endcond */
 126
 127 } // namespace gmx
 128
 129 #endif