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,2016,2017,2018, 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.
37 #ifndef GMX_MDLIB_UPDATE_H
38 #define GMX_MDLIB_UPDATE_H
40 #include "gromacs/math/paddedvector.h"
41 #include "gromacs/math/vectypes.h"
42 #include "gromacs/timing/wallcycle.h"
43 #include "gromacs/utility/arrayref.h"
44 #include "gromacs/utility/basedefinitions.h"
45 #include "gromacs/utility/real.h"
48 struct gmx_ekindata_t
;
49 struct gmx_enerdata_t
;
50 struct gmx_multisim_t
;
61 /* Abstract type for update */
69 /* Initialize the stochastic dynamics struct */
70 gmx_update_t
*init_update(const t_inputrec
*ir
);
72 /* Update pre-computed constants that depend on the reference
73 * temperature for coupling.
75 * This could change e.g. in simulated annealing. */
76 void update_temperature_constants(gmx_update_t
*upd
, const t_inputrec
*ir
);
78 /* Update the size of per-atom arrays (e.g. after DD re-partitioning,
79 which might increase the number of home atoms). */
80 void update_realloc(gmx_update_t
*upd
, int natoms
);
82 /* Store the box at step step
83 * as a reference state for simulations with box deformation.
85 void set_deform_reference_box(gmx_update_t
*upd
,
86 gmx_int64_t step
, matrix box
);
88 void update_tcouple(gmx_int64_t step
,
91 gmx_ekindata_t
*ekind
,
96 /* Update Parrinello-Rahman, to be called before the coordinate update */
97 void update_pcouple_before_coordinates(FILE *fplog
,
99 const t_inputrec
*inputrec
,
101 matrix parrinellorahmanMu
,
105 /* Update the box, to be called after the coordinate update.
106 * For Berendsen P-coupling, also calculates the scaling factor
107 * and scales the coordinates.
108 * When the deform option is used, scales coordinates and box here.
110 void update_pcouple_after_coordinates(FILE *fplog
,
112 const t_inputrec
*inputrec
,
114 const matrix pressure
,
115 const matrix forceVirial
,
116 const matrix constraintVirial
,
117 const matrix parrinellorahmanMu
,
122 void update_coords(gmx_int64_t step
,
123 t_inputrec
*inputrec
, /* input record and box stuff */
126 gmx::PaddedArrayRef
<gmx::RVec
> f
, /* forces on home particles */
128 gmx_ekindata_t
*ekind
,
132 const t_commrec
*cr
, /* these shouldn't be here -- need to think about it */
133 gmx::Constraints
*constr
);
135 /* Return TRUE if OK, FALSE in case of Shake Error */
137 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
, gmx::Constraints
*constr
);
139 void constrain_velocities(gmx_int64_t step
,
140 real
*dvdlambda
, /* the contribution to be added to the bonded interactions */
141 const t_inputrec
*inputrec
, /* input record and box stuff */
148 const gmx_multisim_t
*ms
,
150 gmx_wallcycle_t wcycle
,
151 gmx::Constraints
*constr
,
156 void constrain_coordinates(gmx_int64_t step
,
157 real
*dvdlambda
, /* the contribution to be added to the bonded interactions */
158 const t_inputrec
*inputrec
, /* input record and box stuff */
165 const gmx_multisim_t
*ms
,
167 gmx_wallcycle_t wcycle
,
169 gmx::Constraints
*constr
,
174 void update_sd_second_half(gmx_int64_t step
,
175 real
*dvdlambda
, /* the contribution to be added to the bonded interactions */
176 const t_inputrec
*inputrec
, /* input record and box stuff */
180 gmx::PaddedArrayRef
<gmx::RVec
> force
, /* forces on home particles */
183 const gmx_multisim_t
*ms
,
185 gmx_wallcycle_t wcycle
,
187 gmx::Constraints
*constr
,
191 void finish_update(const t_inputrec
*inputrec
,
196 gmx_wallcycle_t wcycle
,
198 gmx::Constraints
*constr
);
200 /* Return TRUE if OK, FALSE in case of Shake Error */
202 void calc_ke_part(t_state
*state
, t_grpopts
*opts
, t_mdatoms
*md
,
203 gmx_ekindata_t
*ekind
, t_nrnb
*nrnb
, gmx_bool bEkinAveVel
);
205 * Compute the partial kinetic energy for home particles;
206 * will be accumulated in the calling routine.
209 * Ekin = SUM(i) 0.5 m[i] v[i] (x) v[i]
211 * use v[i] = v[i] - u[i] when calculating temperature
213 * u must be accumulated already.
215 * Now also computes the contribution of the kinetic energy to the
222 init_ekinstate(ekinstate_t
*ekinstate
, const t_inputrec
*ir
);
225 update_ekinstate(ekinstate_t
*ekinstate
, gmx_ekindata_t
*ekind
);
227 /*! \brief Restores data from \p ekinstate to \p ekind, then broadcasts it
228 to the rest of the simulation */
230 restore_ekinstate_from_state(const t_commrec
*cr
,
231 gmx_ekindata_t
*ekind
, const ekinstate_t
*ekinstate
);
233 void berendsen_tcoupl(const t_inputrec
*ir
, const gmx_ekindata_t
*ekind
, real dt
,
234 std::vector
<double> &therm_integral
);
236 void andersen_tcoupl(t_inputrec
*ir
, gmx_int64_t step
,
237 const t_commrec
*cr
, const t_mdatoms
*md
, t_state
*state
, real rate
, const gmx_bool
*randomize
, const real
*boltzfac
);
239 void nosehoover_tcoupl(t_grpopts
*opts
, gmx_ekindata_t
*ekind
, real dt
,
240 double xi
[], double vxi
[], t_extmass
*MassQ
);
242 void trotter_update(t_inputrec
*ir
, gmx_int64_t step
, gmx_ekindata_t
*ekind
,
243 gmx_enerdata_t
*enerd
, t_state
*state
, tensor vir
, t_mdatoms
*md
,
244 t_extmass
*MassQ
, int **trotter_seqlist
, int trotter_seqno
);
246 int **init_npt_vars(t_inputrec
*ir
, t_state
*state
, t_extmass
*Mass
, gmx_bool bTrotter
);
248 real
NPT_energy(const t_inputrec
*ir
, const t_state
*state
, const t_extmass
*MassQ
);
249 /* computes all the pressure/tempertature control energy terms to get a conserved energy */
251 void NBaroT_trotter(t_grpopts
*opts
, real dt
,
252 double xi
[], double vxi
[], real
*veta
, t_extmass
*MassQ
);
254 void vrescale_tcoupl(t_inputrec
*ir
, gmx_int64_t step
,
255 gmx_ekindata_t
*ekind
, real dt
,
256 double therm_integral
[]);
257 /* Compute temperature scaling. For V-rescale it is done in update. */
259 void rescale_velocities(gmx_ekindata_t
*ekind
, t_mdatoms
*mdatoms
,
260 int start
, int end
, rvec v
[]);
261 /* Rescale the velocities with the scaling factor in ekind */
263 void update_annealing_target_temp(t_inputrec
*ir
, real t
, gmx_update_t
*upd
);
264 /* Set reference temp for simulated annealing at time t*/
266 real
calc_temp(real ekin
, real nrdf
);
267 /* Calculate the temperature */
269 real
calc_pres(int ePBC
, int nwall
, matrix box
, tensor ekin
, tensor vir
,
271 /* Calculate the pressure tensor, returns the scalar pressure.
272 * The unit of pressure is bar.
275 void parrinellorahman_pcoupl(FILE *fplog
, gmx_int64_t step
,
276 const t_inputrec
*ir
, real dt
, const tensor pres
,
277 tensor box
, tensor box_rel
, tensor boxv
,
279 gmx_bool bFirstStep
);
281 void berendsen_pcoupl(FILE *fplog
, gmx_int64_t step
,
282 const t_inputrec
*ir
, real dt
,
283 const tensor pres
, const matrix box
,
284 const matrix force_vir
, const matrix constraint_vir
,
285 matrix mu
, double *baros_integral
);
287 void berendsen_pscale(const t_inputrec
*ir
, const matrix mu
,
288 matrix box
, matrix box_rel
,
289 int start
, int nr_atoms
,
290 rvec x
[], const unsigned short cFREEZE
[],
293 void correct_ekin(FILE *log
, int start
, int end
, rvec v
[],
294 rvec vcm
, real mass
[], real tmass
, tensor ekin
);
295 /* Correct ekin for vcm */