src/gromacs/pulling/pull.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 /*! \libinternal \file
  39  *
  40  *
  41  * \brief
  42  * This file contains datatypes and function declarations necessary
  43    for mdrun to interface with the pull code.
  44  *
  45  * \author Berk Hess
  46  *
  47  * \inlibraryapi
  48  */
  49
  50 #ifndef GMX_PULLING_PULL_H
  51 #define GMX_PULLING_PULL_H
  52
  53 #include "gromacs/fileio/filenm.h"
  54 #include "gromacs/legacyheaders/typedefs.h"
  55
  56 #ifdef __cplusplus
  57 extern "C" {
  58 #endif
  59
  60 struct t_pbc;
  61
  62
  63 /*! \brief Get the value for pull coord coord_ind.
  64  *
  65  * \param[in,out] pull      The pull struct.
  66  * \param[in]     coord_ind Number of the pull coordinate.
  67  * \param[in]     pbc       Information structure about periodicity.
  68  * \param[out]    value     The value of the pull coordinate.
  69  */
  70 void get_pull_coord_value(struct pull_t      *pull,
  71                           int                 coord_ind,
  72                           const struct t_pbc *pbc,
  73                           double             *value);
  74
  75
  76 /*! \brief Set the all the pull forces to zero.
  77  *
  78  * \param pull              The pull group.
  79  */
  80 void clear_pull_forces(struct pull_t *pull);
  81
  82
  83 /*! \brief Determine the COM pull forces and add them to f, return the potential
  84  *
  85  * \param[in,out] pull   The pull struct.
  86  * \param[in]     md     All atoms.
  87  * \param[in]     pbc    Information struct about periodicity.
  88  * \param[in]     cr     Struct for communication info.
  89  * \param[in]     t      Time.
  90  * \param[in]     lambda The value of lambda in FEP calculations.
  91  * \param[in]     x      Positions.
  92  * \param[in]     f      Forces.
  93  * \param[in,out] vir    The virial, which, if != NULL, gets a pull correction.
  94  * \param[out] dvdlambda Pull contribution to dV/d(lambda).
  95  *
  96  * \returns The pull potential energy.
  97  */
  98 real pull_potential(struct pull_t *pull, t_mdatoms *md, struct t_pbc *pbc,
  99                     t_commrec *cr, double t, real lambda,
 100                     rvec *x, rvec *f, tensor vir, real *dvdlambda);
 101
 102
 103 /*! \brief Constrain the coordinates xp in the directions in x
 104  * and also constrain v when v != NULL.
 105  *
 106  * \param[in,out] pull   The pull data.
 107  * \param[in]     md     All atoms.
 108  * \param[in]     pbc    Information struct about periodicity.
 109  * \param[in]     cr     Struct for communication info.
 110  * \param[in]     dt     The time step length.
 111  * \param[in]     t      The time.
 112  * \param[in]     x      Positions.
 113  * \param[in,out] xp     Updated x, can be NULL.
 114  * \param[in,out] v      Velocities, which may get a pull correction.
 115  * \param[in,out] vir    The virial, which, if != NULL, gets a pull correction.
 116  */
 117 void pull_constraint(struct pull_t *pull, t_mdatoms *md, struct t_pbc *pbc,
 118                      t_commrec *cr, double dt, double t,
 119                      rvec *x, rvec *xp, rvec *v, tensor vir);
 120
 121
 122 /*! \brief Make a selection of the home atoms for all pull groups.
 123  * Should be called at every domain decomposition.
 124  *
 125  * \param cr             Structure for communication info.
 126  * \param pull           The pull group.
 127  * \param md             All atoms.
 128  */
 129 void dd_make_local_pull_groups(t_commrec *cr,
 130                                struct pull_t *pull, t_mdatoms *md);
 131
 132
 133 /*! \brief Allocate, initialize and return a pull work struct.
 134  *
 135  * \param fplog       General output file, normally md.log.
 136  * \param pull_params The pull input parameters containing all pull settings.
 137  * \param ir          The inputrec.
 138  * \param nfile       Number of files.
 139  * \param fnm         Standard filename struct.
 140  * \param mtop        The topology of the whole system.
 141  * \param cr          Struct for communication info.
 142  * \param oenv        Output options.
 143  * \param lambda      FEP lambda.
 144  * \param bOutFile    Open output files?
 145  * \param Flags       Flags passed over from main, used to determine
 146  *                    whether or not we are appending.
 147  */
 148 struct pull_t *init_pull(FILE                *fplog,
 149                          const pull_params_t *pull_params,
 150                          const t_inputrec    *ir,
 151                          int                  nfile,
 152                          const t_filenm       fnm[],
 153                          gmx_mtop_t          *mtop,
 154                          t_commrec          * cr,
 155                          const output_env_t   oenv,
 156                          real                 lambda,
 157                          gmx_bool             bOutFile,
 158                          unsigned long        Flags);
 159
 160
 161 /*! \brief Close the pull output files.
 162  *
 163  * \param pull       The pull group.
 164  */
 165 void finish_pull(struct pull_t *pull);
 166
 167
 168 /*! \brief Print the pull output (x and/or f)
 169  *
 170  * \param pull     The pull data structure.
 171  * \param step     Time step number.
 172  * \param time     Time.
 173  */
 174 void pull_print_output(struct pull_t *pull, gmx_int64_t step, double time);
 175
 176
 177 /*! \brief Calculates centers of mass all pull groups.
 178  *
 179  * \param[in] cr       Struct for communication info.
 180  * \param[in] pull     The pull data structure.
 181  * \param[in] md       All atoms.
 182  * \param[in] pbc      Information struct about periodicity.
 183  * \param[in] t        Time, only used for cylinder ref.
 184  * \param[in] x        The local positions.
 185  * \param[in,out] xp   Updated x, can be NULL.
 186  *
 187  */
 188 void pull_calc_coms(t_commrec        *cr,
 189                     struct pull_t    *pull,
 190                     t_mdatoms        *md,
 191                     struct t_pbc     *pbc,
 192                     double            t,
 193                     rvec              x[],
 194                     rvec             *xp);
 195
 196
 197 /*! \brief Returns if we have pull coordinates with potential pulling.
 198  *
 199  * \param[in] pull     The pull data structure.
 200  */
 201 gmx_bool pull_have_potential(const struct pull_t *pull);
 202
 203
 204 /*! \brief Returns if we have pull coordinates with constraint pulling.
 205  *
 206  * \param[in] pull     The pull data structure.
 207  */
 208 gmx_bool pull_have_constraint(const struct pull_t *pull);
 209
 210 #ifdef __cplusplus
 211 }
 212 #endif
 213
 214 #endif