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, 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 "gromacs/math/vectypes.h"
  52 #include "gromacs/mdtypes/md_enums.h"
  53 #include "gromacs/utility/basedefinitions.h"
  54 #include "gromacs/utility/real.h"
  55
  56 /*! \cond INTERNAL */
  57
  58 /*! \brief Struct that defines a pull group */
  59 typedef struct
  60 {
  61     int   nat;     /**< Number of atoms in the pull group */
  62     int*  ind;     /**< The global atoms numbers */
  63     int   nweight; /**< The number of weights (0 or nat) */
  64     real* weight;  /**< Weights (use all 1 when weight==NULL) */
  65     int   pbcatom; /**< The reference atom for pbc (global number) */
  66     int   pbcatom_input; /**< The reference atom for pbc (global number) as specified in the input parameters */
  67 } t_pull_group;
  68
  69 /*! Maximum number of pull groups that can be used in a pull coordinate */
  70 static const int c_pullCoordNgroupMax = 6;
  71
  72 /*! \brief Struct that defines a pull coordinate */
  73 typedef struct
  74 {
  75     int      eType; /**< The pull type: umbrella, constraint, ... */
  76     char*    externalPotentialProvider; /**< Name of the module providing the external potential, only used with eType==epullEXTERNAL */
  77     int      eGeom;                       /**< The pull geometry */
  78     int      ngroup;                      /**< The number of groups, depends on eGeom */
  79     int      group[c_pullCoordNgroupMax]; /**< The pull groups: indices into the group arrays in pull_t and pull_params_t, ngroup indices are used */
  80     ivec     dim;                         /**< Used to select components for constraint */
  81     rvec     origin;                      /**< The origin for the absolute reference */
  82     rvec     vec;                         /**< The pull vector, direction or position */
  83     gmx_bool bStart;                      /**< Set init based on the initial structure */
  84     real     init;                        /**< Initial reference displacement (nm) or (deg) */
  85     real     rate;                        /**< Rate of motion (nm/ps) or (deg/ps) */
  86     real     k; /**< Force constant (kJ/(mol nm^2) or kJ/(mol rad^2) for umbrella pull type, or kJ/(mol nm) or kJ/(mol rad) for constant force pull type */
  87     real     kB; /**< Force constant for state B */
  88 } t_pull_coord;
  89
  90 /*! \brief Struct containing all pull parameters */
  91 typedef struct pull_params_t
  92 {
  93     int      ngroup;         /**< Number of pull groups */
  94     int      ncoord;         /**< Number of pull coordinates */
  95     real     cylinder_r;     /**< Radius of cylinder for dynamic COM (nm) */
  96     real     constr_tol;     /**< Absolute tolerance for constraints in (nm) */
  97     gmx_bool bPrintCOM;      /**< Print coordinates of COM for each coord */
  98     gmx_bool bPrintRefValue; /**< Print the reference value for each coord */
  99     gmx_bool bPrintComp; /**< Print cartesian components for each coord with geometry=distance */
 100     gmx_bool bSetPbcRefToPrevStepCOM; /**< Use the COM of each group from the previous step as reference */
 101     int      nstxout;                 /**< Output interval for pull x */
 102     int      nstfout;                 /**< Output interval for pull f */
 103     bool     bXOutAverage; /**< Write the average coordinate during the output interval */
 104     bool     bFOutAverage; /**< Write the average force during the output interval */
 105
 106     t_pull_group* group; /**< groups to pull/restrain/etc/ */
 107     t_pull_coord* coord; /**< the pull coordinates */
 108 } pull_params_t;
 109
 110 /*! \endcond */
 111
 112 #endif /* GMX_MDTYPES_PULL_PARAMS_H */