src/gromacs/applied_forces/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,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 /*! \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 <variant>
  53 #include <vector>
  54
  55 #include "gromacs/math/vectypes.h"
  56 #include "gromacs/utility/basedefinitions.h"
  57
  58 namespace gmx
  59 {
  60
  61 //! The maximum dimensionality of the AWH coordinate.
  62 static const int c_biasMaxNumDim = 4;
  63
  64 //! A real vector in AWH coordinate space.
  65 typedef double awh_dvec[c_biasMaxNumDim];
  66
  67 //! An integer vector in AWH coordinate space.
  68 typedef int awh_ivec[c_biasMaxNumDim];
  69
  70 /*! \internal \brief Constant parameters for each dimension of the coordinate.
  71  */
  72 struct DimParams
  73 {
  74     /*! \internal \brief Type for storing dimension parameters for pull type dimensions
  75      */
  76     struct PullDimParams
  77     {
  78         const double k;     /**< Force constant (kJ/mol/nm^2) for each coordinate dimension. */
  79         const double betak; /**< Inverse variance (1/nm^2) for each coordinate dimension. */
  80         const double userCoordUnitsToInternal; /**< Conversion factor coordinate units. */
  81     };
  82
  83     /*! \internal \brief Type for storing dimension parameters for free-energy lamdba type dimensions
  84      */
  85     struct FepDimParams
  86     {
  87         const double beta;               /**< 1/(k_B T). */
  88         const int    numFepLambdaStates; /**< Number of lambda points in this dimension. */
  89     };
  90
  91 private:
  92     /*! \brief
  93      * Private constructor called by public builder functions for PullDimParams and FepLambdaDimParams.
  94      */
  95     DimParams(double conversionFactor, std::variant<PullDimParams, FepDimParams> dimParams) :
  96         dimParams(std::move(dimParams)), userCoordUnitsToInternal(conversionFactor)
  97     {
  98     }
  99
 100 public:
 101     /*! \brief
 102      * Builder function for pull dimension parameters.
 103      *
 104      * \param[in] conversionFactor  Conversion factor from user coordinate units to bias internal
 105      * units (=c_deg2Rad for angles).
 106      * \param[in] forceConstant     The harmonic force constant.
 107      * \param[in] beta              1/(k_B T).
 108      */
 109     static DimParams pullDimParams(double conversionFactor, double forceConstant, double beta)
 110     {
 111         PullDimParams pullDimParams = { forceConstant, forceConstant * beta };
 112
 113         return DimParams(conversionFactor, pullDimParams);
 114     }
 115
 116     /*! \brief
 117      * Builder function for FEP lambda dimension parameters.
 118      *
 119      * \param[in] numFepLambdaStates  Number of lambda states in the system.
 120      * \param[in] beta                1/(k_B T).
 121      */
 122     static DimParams fepLambdaDimParams(int numFepLambdaStates, double beta)
 123     {
 124         FepDimParams fepDimParams = { beta, numFepLambdaStates };
 125
 126         return DimParams(1.0, fepDimParams);
 127     }
 128
 129     //! Returns whether this dimension is coupled to a pull coordinate.
 130     bool isPullDimension() const { return std::holds_alternative<PullDimParams>(dimParams); }
 131
 132     //! Returns whether this dimension has lambda states and thereby is a dimension coupled to lambda.
 133     bool isFepLambdaDimension() const { return std::holds_alternative<FepDimParams>(dimParams); }
 134
 135     //! Returns pull dimension parameters, only call for pull dimensions
 136     const PullDimParams& pullDimParams() const { return std::get<PullDimParams>(dimParams); }
 137
 138     //! Returns FEP dimension parameters, only call for FEP dimensions
 139     const FepDimParams& fepDimParams() const { return std::get<FepDimParams>(dimParams); }
 140
 141     /*! \brief Convert internal coordinate units to external, user coordinate units.
 142      *
 143      * \param[in] value               Value to convert.
 144      * \returns the converted value.
 145      */
 146     double scaleInternalToUserInput(double value) const { return value / userCoordUnitsToInternal; }
 147
 148     /*! \brief Convert external, user coordinate units to internal coordinate units.
 149      *
 150      * \param[in] value               Value to convert.
 151      * \returns the converted value.
 152      */
 153     double scaleUserInputToInternal(double value) const { return value * userCoordUnitsToInternal; }
 154
 155     //! Parameters for pull dimensions, either type pull or free-energy lambda
 156     const std::variant<PullDimParams, FepDimParams> dimParams;
 157     //! Conversion factor for ordinate units
 158     const double userCoordUnitsToInternal;
 159 };
 160
 161 } // namespace gmx
 162
 163 #endif /* GMX_AWH_DIMPARAMS_H */