src/gromacs/legacyheaders/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, 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 #ifndef _pull_h
  39 #define _pull_h
  40
  41 #include "vec.h"
  42 #include "typedefs.h"
  43 #include "../fileio/filenm.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49
  50 /* This file contains datatypes and function declarations necessary
  51    for mdrun to interface with the pull code */
  52
  53 /* Get the distance to the reference and deviation for pull coord coord_ind */
  54 void get_pull_coord_distance(const t_pull *pull,
  55                              int coord_ind,
  56                              const t_pbc *pbc, double t,
  57                              dvec dr, double *dev);
  58
  59 /* Set the all the pull forces to zero */
  60 void clear_pull_forces(t_pull *pull);
  61
  62 /* Determine the COM pull forces and add them to f, return the potential */
  63 real pull_potential(int ePull, t_pull *pull, t_mdatoms *md, t_pbc *pbc,
  64                     t_commrec *cr, double t, real lambda,
  65                     rvec *x, rvec *f, tensor vir, real *dvdlambda);
  66
  67 /* Constrain the coordinates xp in the directions in x
  68  * and also constrain v when v!=NULL.
  69  */
  70 void pull_constraint(t_pull *pull, t_mdatoms *md, t_pbc *pbc,
  71                      t_commrec *cr, double dt, double t,
  72                      rvec *x, rvec *xp, rvec *v, tensor vir);
  73
  74 /* Make a selection of the home atoms for all pull groups.
  75  * Should be called at every domain decomposition.
  76  */
  77 void dd_make_local_pull_groups(gmx_domdec_t *dd,
  78                                t_pull *pull, t_mdatoms *md);
  79
  80 /* get memory and initialize the fields of pull that still need it, and
  81    do runtype specific initialization */
  82 void init_pull(FILE              *fplog,
  83                t_inputrec        *ir,       /* the inputrec */
  84                int                nfile,
  85                const t_filenm     fnm[],    /* standard filename struct */
  86                gmx_mtop_t        *mtop,     /* the topology of the whole system */
  87                t_commrec        * cr,       /* struct for communication info */
  88                const output_env_t oenv,     /* output options */
  89                real               lambda,   /* FEP lambda */
  90                gmx_bool           bOutFile, /* open output files */
  91                unsigned long      Flags);
  92
  93 /* Close the pull output files */
  94 void finish_pull(t_pull *pull);
  95
  96 /* Print the pull output (x and/or f) */
  97 void pull_print_output(t_pull *pull, gmx_int64_t step, double time);
  98
  99 /* In pullutil.c */
 100
 101 /* Calculates centers of mass all pull groups */
 102 void pull_calc_coms(t_commrec *cr,
 103                     t_pull    *pull, /* the pull group */
 104                     t_mdatoms *md,   /* all atoms */
 105                     t_pbc     *pbc,
 106                     double     t,    /* only used for cylinder ref. */
 107                     rvec       x[],  /* local coordinates */
 108                     rvec      *xp    /* updated x, can be NULL */
 109                     );
 110
 111 #ifdef __cplusplus
 112 }
 113 #endif
 114
 115 #endif