src/gromacs/awh/dimparams.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 /*! \internal \file
  37  *
  38  * \brief
  39  * Declares the DimParams struct and AWH vector types.
  40  *
  41  * This class holds the physical information for a dimension
  42  * of the bias reaction-coordinate grid.
  43  *
  44  * \author Viveca Lindahl
  45  * \author Berk Hess <hess@kth.se>
  46  * \ingroup module_awh
  47  */
  48
  49 #ifndef GMX_AWH_DIMPARAMS_H
  50 #define GMX_AWH_DIMPARAMS_H
  51
  52 #include <vector>
  53
  54 #include "gromacs/math/vectypes.h"
  55 #include "gromacs/utility/basedefinitions.h"
  56
  57 namespace gmx
  58 {
  59
  60 //! The maximum dimensionality of the AWH coordinate.
  61 static const int c_biasMaxNumDim = 4;
  62
  63 //! A real vector in AWH coordinate space.
  64 typedef double awh_dvec[c_biasMaxNumDim];
  65
  66 //! An integer vector in AWH coordinate space.
  67 typedef int awh_ivec[c_biasMaxNumDim];
  68
  69 /*! \internal \brief Constant parameters for each dimension of the coordinate.
  70  */
  71 struct DimParams
  72 {
  73     /*! \brief
  74      * Constructor.
  75      *
  76      * \param[in] conversionFactor  Conversion factor from user coordinate units to bias internal
  77      * units (=DEG2RAD for angles).
  78      * \param[in] forceConstant     The harmonic force constant.
  79      * \param[in] beta              1/(k_B T).
  80      */
  81     DimParams(double conversionFactor, double forceConstant, double beta) :
  82         k(forceConstant),
  83         beta(beta),
  84         betak(beta * forceConstant),
  85         userCoordUnitsToInternal(conversionFactor),
  86         numFepLambdaStates(0)
  87     {
  88     }
  89
  90     /*! \brief
  91      * Constructor for lambda dimension.
  92      *
  93      * \param[in] forceConstant       The harmonic force constant.
  94      * \param[in] beta                1/(k_B T).
  95      * \param[in] numFepLambdaStates  Number of lambda states in the system.
  96      */
  97     DimParams(double forceConstant, double beta, int numFepLambdaStates) :
  98         k(forceConstant),
  99         beta(beta),
 100         betak(beta * forceConstant),
 101         userCoordUnitsToInternal(1.0),
 102         numFepLambdaStates(numFepLambdaStates)
 103     {
 104     }
 105
 106     /*! \brief Convert internal coordinate units to external, user coordinate units.
 107      *
 108      * \param[in] value               Value to convert.
 109      * \returns the converted value.
 110      */
 111     double scaleInternalToUserInput(double value) const { return value / userCoordUnitsToInternal; }
 112
 113     /*! \brief Convert external, user coordinate units to internal coordinate units.
 114      *
 115      * \param[in] value               Value to convert.
 116      * \returns the converted value.
 117      */
 118     double scaleUserInputToInternal(double value) const { return value * userCoordUnitsToInternal; }
 119
 120     /*! \brief Returns if this dimension has lambda states and thereby is a dimension coupled to lambda.
 121      *
 122      *  \returns true if this dimension is related to the lambda state of the system.
 123      */
 124     bool isFepLambdaDimension() const { return numFepLambdaStates > 0; }
 125
 126     const double k;     /**< Force constant (kJ/mol/nm^2) for each coordinate dimension. */
 127     const double beta;  /**< 1/(k_B T). */
 128     const double betak; /**< Inverse variance (1/nm^2) for each coordinate dimension. */
 129     const double userCoordUnitsToInternal; /**< Conversion factor coordinate units. */
 130     const double numFepLambdaStates;       /**< Number of lambda points in this dimension. */
 131 };
 132
 133 } // namespace gmx
 134
 135 #endif /* GMX_AWH_DIMPARAMS_H */