Merge branch 'master' of git://git.gromacs.org/gromacs
[gromacs/adressmacs.git] / include / pull.h
blobb9008b8aa23c5ac20fb180ab19f6e391695e4c2d
1 /*
2 *
3 * This source code is part of
4 *
5 * G R O M A C S
6 *
7 * GROningen MAchine for Chemical Simulations
8 *
9 * VERSION 3.2.0
10 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
11 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
12 * Copyright (c) 2001-2004, The GROMACS development team,
13 * check out http://www.gromacs.org for more information.
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version 2
18 * of the License, or (at your option) any later version.
20 * If you want to redistribute modifications, please consider that
21 * scientific software is very special. Version control is crucial -
22 * bugs must be traceable. We will be happy to consider code for
23 * inclusion in the official distribution, but derived work must not
24 * be called official GROMACS. Details are found in the README & COPYING
25 * files - if they are missing, get the official version at www.gromacs.org.
27 * To help us fund GROMACS development, we humbly ask that you cite
28 * the papers on the package - you can find them in the top README file.
30 * For more info, check our website at http://www.gromacs.org
32 * And Hey:
33 * Gromacs Runs On Most of All Computer Systems
36 #ifndef _pull_h
37 #define _pull_h
39 #include "vec.h"
40 #include "typedefs.h"
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
47 /* This file contains datatypes and function declarations necessary
48 for mdrun to interface with the pull code */
50 /* Get the distance to the reference and deviation for pull group g */
51 void get_pullgrp_distance(t_pull *pull,t_pbc *pbc,int g,double t,
52 dvec dr,dvec dev);
54 /* Set the all the pull forces to zero */
55 void clear_pull_forces(t_pull *pull);
57 /* Determine the COM pull forces and add them to f, return the potential */
58 real pull_potential(int ePull,t_pull *pull, t_mdatoms *md, t_pbc *pbc,
59 t_commrec *cr, double t, real lambda,
60 rvec *x, rvec *f, tensor vir, real *dvdlambda);
62 /* Constrain the coordinates xp in the directions in x
63 * and also constrain v when v!=NULL.
65 void pull_constraint(t_pull *pull, t_mdatoms *md, t_pbc *pbc,
66 t_commrec *cr, double dt, double t,
67 rvec *x, rvec *xp, rvec *v, tensor vir);
69 /* Make a selection of the home atoms for all pull groups.
70 * Should be called at every domain decomposition.
72 void dd_make_local_pull_groups(gmx_domdec_t *dd,
73 t_pull *pull,t_mdatoms *md);
75 /* get memory and initialize the fields of pull that still need it, and
76 do runtype specific initialization */
77 void init_pull(FILE *fplog,
78 t_inputrec *ir, /* the inputrec */
79 int nfile,
80 const t_filenm fnm[], /* standard filename struct */
81 gmx_mtop_t *mtop, /* the topology of the whole system */
82 t_commrec * cr, /* struct for communication info */
83 const output_env_t oenv, /* output options */
84 gmx_bool bOutFile, /* open output files */
85 unsigned long Flags);
87 /* Close the pull output files */
88 void finish_pull(FILE *fplog,t_pull *pull);
90 /* Print the pull output (x and/or f) */
91 void pull_print_output(t_pull *pull, gmx_large_int_t step, double time);
93 /* In pullutil.c */
95 /* Calculates centers of mass all pull groups */
96 void pull_calc_coms(t_commrec *cr,
97 t_pull *pull, /* the pull group */
98 t_mdatoms *md, /* all atoms */
99 t_pbc *pbc,
100 double t, /* only used for cylinder ref. */
101 rvec x[], /* local coordinates */
102 rvec *xp /* updated x, can be NULL */
105 #ifdef __cplusplus
107 #endif
109 #endif