2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
41 #include "gromacs/legacyheaders/network.h"
42 #include "gromacs/legacyheaders/tgroup.h"
43 #include "gromacs/legacyheaders/typedefs.h"
44 #include "gromacs/timing/wallcycle.h"
54 /* Abstract type for stochastic dynamics */
55 typedef struct gmx_update
*gmx_update_t
;
57 /* Initialize the stochastic dynamics struct */
58 gmx_update_t
init_update(t_inputrec
*ir
);
60 /* Store the random state from sd in state */
61 void get_stochd_state(gmx_update_t sd
, t_state
*state
);
63 /* Set the random in sd from state */
64 void set_stochd_state(gmx_update_t sd
, t_state
*state
);
66 /* Store the box at step step
67 * as a reference state for simulations with box deformation.
69 void set_deform_reference_box(gmx_update_t upd
,
70 gmx_int64_t step
, matrix box
);
72 void update_tcouple(gmx_int64_t step
,
75 gmx_ekindata_t
*ekind
,
80 void update_pcouple(FILE *fplog
,
88 void update_coords(FILE *fplog
,
90 t_inputrec
*inputrec
, /* input record and box stuff */
94 rvec
*f
, /* forces on home particles */
97 tensor
*vir_lr_constr
,
99 gmx_ekindata_t
*ekind
,
104 t_commrec
*cr
, /* these shouldn't be here -- need to think about it */
106 struct gmx_constr
*constr
,
109 /* Return TRUE if OK, FALSE in case of Shake Error */
111 extern gmx_bool
update_randomize_velocities(t_inputrec
*ir
, gmx_int64_t step
, const t_commrec
*cr
, t_mdatoms
*md
, t_state
*state
, gmx_update_t upd
, struct gmx_constr
*constr
);
113 void update_constraints(FILE *fplog
,
115 real
*dvdlambda
, /* FEP stuff */
116 t_inputrec
*inputrec
, /* input record and box stuff */
120 struct t_graph
*graph
,
121 rvec force
[], /* forces on home particles */
126 gmx_wallcycle_t wcycle
,
128 struct gmx_constr
*constr
,
132 /* Return TRUE if OK, FALSE in case of Shake Error */
134 void update_box(FILE *fplog
,
136 t_inputrec
*inputrec
, /* input record and box stuff */
139 rvec force
[], /* forces on home particles */
143 /* Return TRUE if OK, FALSE in case of Shake Error */
145 void calc_ke_part(t_state
*state
, t_grpopts
*opts
, t_mdatoms
*md
,
146 gmx_ekindata_t
*ekind
, t_nrnb
*nrnb
, gmx_bool bEkinAveVel
);
148 * Compute the partial kinetic energy for home particles;
149 * will be accumulated in the calling routine.
152 * Ekin = SUM(i) 0.5 m[i] v[i] (x) v[i]
154 * use v[i] = v[i] - u[i] when calculating temperature
156 * u must be accumulated already.
158 * Now also computes the contribution of the kinetic energy to the
165 init_ekinstate(ekinstate_t
*ekinstate
, const t_inputrec
*ir
);
168 update_ekinstate(ekinstate_t
*ekinstate
, gmx_ekindata_t
*ekind
);
171 restore_ekinstate_from_state(t_commrec
*cr
,
172 gmx_ekindata_t
*ekind
, ekinstate_t
*ekinstate
);
174 void berendsen_tcoupl(t_inputrec
*ir
, gmx_ekindata_t
*ekind
, real dt
);
176 void andersen_tcoupl(t_inputrec
*ir
, gmx_int64_t step
,
177 const t_commrec
*cr
, const t_mdatoms
*md
, t_state
*state
, real rate
, const gmx_bool
*randomize
, const real
*boltzfac
);
179 void nosehoover_tcoupl(t_grpopts
*opts
, gmx_ekindata_t
*ekind
, real dt
,
180 double xi
[], double vxi
[], t_extmass
*MassQ
);
182 t_state
*init_bufstate(const t_state
*template_state
);
184 void destroy_bufstate(t_state
*state
);
186 void trotter_update(t_inputrec
*ir
, gmx_int64_t step
, gmx_ekindata_t
*ekind
,
187 gmx_enerdata_t
*enerd
, t_state
*state
, tensor vir
, t_mdatoms
*md
,
188 t_extmass
*MassQ
, int **trotter_seqlist
, int trotter_seqno
);
190 int **init_npt_vars(t_inputrec
*ir
, t_state
*state
, t_extmass
*Mass
, gmx_bool bTrotter
);
192 real
NPT_energy(t_inputrec
*ir
, t_state
*state
, t_extmass
*MassQ
);
193 /* computes all the pressure/tempertature control energy terms to get a conserved energy */
195 void NBaroT_trotter(t_grpopts
*opts
, real dt
,
196 double xi
[], double vxi
[], real
*veta
, t_extmass
*MassQ
);
198 void vrescale_tcoupl(t_inputrec
*ir
, gmx_int64_t step
,
199 gmx_ekindata_t
*ekind
, real dt
,
200 double therm_integral
[]);
201 /* Compute temperature scaling. For V-rescale it is done in update. */
203 real
vrescale_energy(t_grpopts
*opts
, double therm_integral
[]);
204 /* Returns the V-rescale contribution to the conserved energy */
206 void rescale_velocities(gmx_ekindata_t
*ekind
, t_mdatoms
*mdatoms
,
207 int start
, int end
, rvec v
[]);
208 /* Rescale the velocities with the scaling factor in ekind */
210 void update_annealing_target_temp(t_grpopts
*opts
, real t
);
211 /* Set reference temp for simulated annealing at time t*/
213 real
calc_temp(real ekin
, real nrdf
);
214 /* Calculate the temperature */
216 real
calc_pres(int ePBC
, int nwall
, matrix box
, tensor ekin
, tensor vir
,
218 /* Calculate the pressure tensor, returns the scalar pressure.
219 * The unit of pressure is bar.
222 void parrinellorahman_pcoupl(FILE *fplog
, gmx_int64_t step
,
223 t_inputrec
*ir
, real dt
, tensor pres
,
224 tensor box
, tensor box_rel
, tensor boxv
,
226 gmx_bool bFirstStep
);
228 void berendsen_pcoupl(FILE *fplog
, gmx_int64_t step
,
229 t_inputrec
*ir
, real dt
, tensor pres
, matrix box
,
233 void berendsen_pscale(t_inputrec
*ir
, matrix mu
,
234 matrix box
, matrix box_rel
,
235 int start
, int nr_atoms
,
236 rvec x
[], unsigned short cFREEZE
[],
239 void correct_ekin(FILE *log
, int start
, int end
, rvec v
[],
240 rvec vcm
, real mass
[], real tmass
, tensor ekin
);
241 /* Correct ekin for vcm */
248 #endif /* _update_h */