src/gromacs/mdtypes/pull_params.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,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 /*! \libinternal \file
  37  *
  38  *
  39  * \brief
  40  * This file contains datatypes for the mdp options used by the pull code.
  41  *
  42  * \author Berk Hess
  43  *
  44  * \inlibraryapi
  45  * \ingroup module_mdtypes
  46  */
  47
  48 #ifndef GMX_MDTYPES_PULL_PARAMS_H
  49 #define GMX_MDTYPES_PULL_PARAMS_H
  50
  51 #include <array>
  52 #include <string>
  53 #include <vector>
  54
  55 #include "gromacs/math/vectypes.h"
  56 #include "gromacs/mdtypes/md_enums.h"
  57 #include "gromacs/utility/basedefinitions.h"
  58 #include "gromacs/utility/real.h"
  59
  60 /*! \cond INTERNAL */
  61
  62 /*! \brief Struct that defines a pull group */
  63 struct t_pull_group
  64 {
  65     std::vector<int>  ind;     /**< The global atoms numbers */
  66     std::vector<real> weight;  /**< Weights (use all 1 when weight==NULL) */
  67     int               pbcatom; /**< The reference atom for pbc (global number) */
  68     int               pbcatom_input; /**< The reference atom for pbc (global number) as specified in the input parameters */
  69 };
  70
  71 /*! Maximum number of pull groups that can be used in a pull coordinate */
  72 static constexpr int c_pullCoordNgroupMax = 6;
  73
  74 /*! \brief Struct that defines a pull coordinate */
  75 struct t_pull_coord
  76 {
  77     //! The pull type: umbrella, constraint, ...
  78     PullingAlgorithm eType = PullingAlgorithm::Umbrella;
  79     //! Name of the module providing   the external potential, only used with eType==epullEXTERNAL
  80     std::string externalPotentialProvider;
  81     //! The pull geometry
  82     PullGroupGeometry eGeom = PullGroupGeometry::Distance;
  83     //! Mathematical expression evaluated by the pull code for transformation coordinates.
  84     std::string expression;
  85     //! The finite difference to use in numerical derivation of mathematical expressions
  86     double dx = 1e-9;
  87     //! The number of groups, depends on eGeom
  88     int ngroup = 0;
  89     /*! \brief The pull groups:
  90      *
  91      *  indices into the group arrays in pull_t and pull_params_t,
  92      *   ngroup indices are used
  93      */
  94     std::array<int, c_pullCoordNgroupMax> group;
  95     //! Used to select components for constraint
  96     gmx::IVec dim = { 0, 0, 0 };
  97     //! The origin for the absolute reference
  98     gmx::RVec origin = { 0, 0, 0 };
  99     //! The pull vector, direction or position
 100     gmx::RVec vec = { 0, 0, 0 };
 101     //! Set init based on the initial structure
 102     bool bStart = false;
 103     //! Initial reference displacement (nm) or (deg)
 104     real init = 0.0;
 105     //! Rate of motion (nm/ps) or (deg/ps)
 106     real rate = 0.0;
 107     /*! \brief Force constant
 108      *
 109      * For umbrella pull type this is (kJ/(mol nm^2) or kJ/(mol rad^2).
 110      * For constant force pull type it is kJ/(mol nm) or kJ/(mol rad).
 111      */
 112     real k = 0.0;
 113     //! Force constant for state B
 114     real kB = 0.0;
 115     //! The index of this coordinate in the list of coordinates
 116     int coordIndex = -1;
 117 };
 118
 119 /*! \brief Struct containing all pull parameters */
 120 struct pull_params_t
 121 {
 122     //! Number of pull groups
 123     int ngroup = 0;
 124     //! Number of pull coordinates
 125     int ncoord = 0;
 126     //! Radius of cylinder for dynamic COM (nm)
 127     real cylinder_r = 0.0;
 128     //! Absolute tolerance for constraints in (nm)
 129     real constr_tol = 0.0;
 130     //! Print coordinates of COM for each coord
 131     bool bPrintCOM = false;
 132     //! Print the reference value for each coord
 133     bool bPrintRefValue = false;
 134     //! Print cartesian components for each coord with geometry=distance
 135     bool bPrintComp = false;
 136     //! Use the COM of each group from the previous step as reference
 137     bool bSetPbcRefToPrevStepCOM = false;
 138     //! Output interval for pull x
 139     int nstxout = 0;
 140     //! Output interval for pull f
 141     int nstfout = 0;
 142     //! Write the average coordinate during the output interval
 143     bool bXOutAverage = false;
 144     //! Write the average force during the output interval
 145     bool bFOutAverage = false;
 146     //! groups to pull/restrain/etc/
 147     std::vector<t_pull_group> group;
 148     //! the pull coordinates
 149     std::vector<t_pull_coord> coord;
 150 };
 151
 152 /*! \endcond */
 153
 154 #endif /* GMX_MDTYPES_PULL_PARAMS_H */