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, 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.
42 #include "../sysstuff.h"
50 int n; /* Number of terms */
51 real *a; /* Coeffients (V / nm ) */
52 real *phi; /* Phase angles */
56 real E0; /* Field strength (V/nm) */
57 real omega; /* Frequency (1/ps) */
58 real t0; /* Centre of the Gaussian pulse (ps) */
59 real sigma; /* Width of the Gaussian pulse (FWHM) (ps) */
62 #define EGP_EXCL (1<<0)
63 #define EGP_TABLE (1<<1)
66 int ngtc; /* # T-Coupl groups */
67 int nhchainlength; /* # of nose-hoover chains per group */
68 int ngacc; /* # Accelerate groups */
69 int ngfrz; /* # Freeze groups */
70 int ngener; /* # Ener groups */
71 real *nrdf; /* Nr of degrees of freedom in a group */
72 real *ref_t; /* Coupling temperature per group */
73 int *annealing; /* No/simple/periodic SA for each group */
74 int *anneal_npoints; /* Number of annealing time points per grp */
75 real **anneal_time; /* For ea. group: Time points */
76 real **anneal_temp; /* For ea. grp: Temperature at these times */
77 /* Final temp after all intervals is ref_t */
78 real *tau_t; /* Tau coupling time */
79 rvec *acc; /* Acceleration per group */
80 ivec *nFreeze; /* Freeze the group in each direction ? */
81 int *egp_flags; /* Exclusions/tables of energy group pairs */
84 int ngQM; /* nr of QM groups */
85 int *QMmethod; /* Level of theory in the QM calculation */
86 int *QMbasis; /* Basisset in the QM calculation */
87 int *QMcharge; /* Total charge in the QM region */
88 int *QMmult; /* Spin multiplicicty in the QM region */
89 gmx_bool *bSH; /* surface hopping (diabatic hop only) */
90 int *CASorbitals; /* number of orbiatls in the active space */
91 int *CASelectrons; /* number of electrons in the active space */
92 real *SAon; /* at which gap (A.U.) the SA is switched on */
94 int *SAsteps; /* in how many steps SA goes from 1-1 to 0.5-0.5*/
100 epgrppbcNONE, epgrppbcREFAT, epgrppbcCOS
104 int nat; /* Number of atoms in the pull group */
105 atom_id *ind; /* The global atoms numbers */
106 int nat_loc; /* Number of local pull atoms */
107 int nalloc_loc; /* Allocation size for ind_loc and weight_loc */
108 atom_id *ind_loc; /* Local pull indices */
109 int nweight; /* The number of weights (0 or nat) */
110 real *weight; /* Weights (use all 1 when weight==NULL) */
111 real *weight_loc; /* Weights for the local indices */
112 int epgrppbc; /* The type of pbc for this pull group, see enum above */
113 atom_id pbcatom; /* The reference atom for pbc (global number) */
114 rvec vec; /* The pull vector, direction or position */
115 rvec init; /* Initial reference displacement */
116 real rate; /* Rate of motion (nm/ps) */
117 real k; /* force constant */
118 real kB; /* force constant for state B */
119 real wscale; /* scaling factor for the weights: sum w m/sum w w m */
120 real invtm; /* inverse total mass of the group: 1/wscale sum w m */
121 dvec x; /* center of mass before update */
122 dvec xp; /* center of mass after update before constraining */
123 dvec dr; /* The distance from the reference group */
124 double f_scal; /* Scalar force for directional pulling */
125 dvec f; /* force due to the pulling/constraining */
129 int eSimTempScale; /* simulated temperature scaling; linear or exponential */
130 real simtemp_low; /* the low temperature for simulated tempering */
131 real simtemp_high; /* the high temperature for simulated tempering */
132 real *temperatures; /* the range of temperatures used for simulated tempering */
136 int nstdhdl; /* The frequency for calculating dhdl */
137 double init_lambda; /* fractional value of lambda (usually will use
138 init_fep_state, this will only be for slow growth,
139 and for legacy free energy code. Only has a
140 valid value if positive) */
141 int init_fep_state; /* the initial number of the state */
142 double delta_lambda; /* change of lambda per time step (fraction of (0.1) */
143 gmx_bool bPrintEnergy; /* Whether to print the energy in the dhdl */
144 int n_lambda; /* The number of foreign lambda points */
145 double **all_lambda; /* The array of all lambda values */
146 int lambda_neighbors; /* The number of neighboring lambda states to
147 calculate the energy for in up and down directions
149 int lambda_start_n; /* The first lambda to calculate energies for */
150 int lambda_stop_n; /* The last lambda +1 to calculate energies for */
151 real sc_alpha; /* free energy soft-core parameter */
152 int sc_power; /* lambda power for soft-core interactions */
153 real sc_r_power; /* r power for soft-core interactions */
154 real sc_sigma; /* free energy soft-core sigma when c6 or c12=0 */
155 real sc_sigma_min; /* free energy soft-core sigma for ????? */
156 gmx_bool bScCoul; /* use softcore for the coulomb portion as well (default FALSE) */
157 gmx_bool separate_dvdl[efptNR]; /* whether to print the dvdl term associated with
158 this term; if it is not specified as separate,
159 it is lumped with the FEP term */
160 int separate_dhdl_file; /* whether to write a separate dhdl.xvg file
161 note: NOT a gmx_bool, but an enum */
162 int dhdl_derivatives; /* whether to calculate+write dhdl derivatives
163 note: NOT a gmx_bool, but an enum */
164 int dh_hist_size; /* The maximum table size for the dH histogram */
165 double dh_hist_spacing; /* The spacing for the dH histogram */
169 int nstexpanded; /* The frequency of expanded ensemble state changes */
170 int elamstats; /* which type of move updating do we use for lambda monte carlo (or no for none) */
171 int elmcmove; /* what move set will be we using for state space moves */
172 int elmceq; /* the method we use to decide of we have equilibrated the weights */
173 int equil_n_at_lam; /* the minumum number of samples at each lambda for deciding whether we have reached a minimum */
174 real equil_wl_delta; /* WL delta at which we stop equilibrating weights */
175 real equil_ratio; /* use the ratio of weights (ratio of minimum to maximum) to decide when to stop equilibrating */
176 int equil_steps; /* after equil_steps steps we stop equilibrating the weights */
177 int equil_samples; /* after equil_samples total samples (steps/nstfep), we stop equilibrating the weights */
178 int lmc_seed; /* random number seed for lambda mc switches */
179 gmx_bool minvar; /* whether to use minumum variance weighting */
180 int minvarmin; /* the number of samples needed before kicking into minvar routine */
181 real minvar_const; /* the offset for the variance in MinVar */
182 int c_range; /* range of cvalues used for BAR */
183 gmx_bool bSymmetrizedTMatrix; /* whether to print symmetrized matrices */
184 int nstTij; /* How frequently to print the transition matrices */
185 int lmc_repeats; /* number of repetitions in the MC lambda jumps */ /*MRS -- VERIFY THIS */
186 int lmc_forced_nstart; /* minimum number of samples for each state before free sampling */ /* MRS -- VERIFY THIS! */
187 int gibbsdeltalam; /* distance in lambda space for the gibbs interval */
188 real wl_scale; /* scaling factor for wang-landau */
189 real wl_ratio; /* ratio between largest and smallest number for freezing the weights */
190 real init_wl_delta; /* starting delta for wang-landau */
191 gmx_bool bWLoneovert; /* use one over t convergece for wang-landau when the delta get sufficiently small */
192 gmx_bool bInit_weights; /* did we initialize the weights? TODO: REMOVE FOR 5.0, no longer needed with new logic */
193 real mc_temp; /* To override the main temperature, or define it if it's not defined */
194 real *init_lambda_weights; /* user-specified initial weights to start with */
198 int ngrp; /* number of groups */
199 int eGeom; /* pull geometry */
200 ivec dim; /* used to select components for constraint */
201 real cyl_r1; /* radius of cylinder for dynamic COM */
202 real cyl_r0; /* radius of cylinder including switch length */
203 real constr_tol; /* absolute tolerance for constraints in (nm) */
204 int nstxout; /* Output frequency for pull x */
205 int nstfout; /* Output frequency for pull f */
206 int ePBC; /* the boundary conditions */
207 int npbcdim; /* do pbc in dims 0 <= dim < npbcdim */
208 gmx_bool bRefAt; /* do we need reference atoms for a group COM ? */
209 int cosdim; /* dimension for cosine weighting, -1 if none */
210 gmx_bool bVirial; /* do we need to add the pull virial? */
211 t_pullgrp *grp; /* groups to pull/restrain/etc/ */
212 t_pullgrp *dyna; /* dynamic groups for use with local constraints */
213 rvec *rbuf; /* COM calculation buffer */
214 dvec *dbuf; /* COM calculation buffer */
215 double *dbuf_cyl; /* cylinder ref. groups COM calculation buffer */
217 FILE *out_x; /* output file for pull data */
218 FILE *out_f; /* output file for pull data */
222 /* Abstract types for enforced rotation only defined in pull_rotation.c */
223 typedef struct gmx_enfrot *gmx_enfrot_t;
224 typedef struct gmx_enfrotgrp *gmx_enfrotgrp_t;
227 int eType; /* Rotation type for this group */
228 int bMassW; /* Use mass-weighed positions? */
229 int nat; /* Number of atoms in the group */
230 atom_id *ind; /* The global atoms numbers */
231 rvec *x_ref; /* The reference positions */
232 rvec vec; /* The normalized rotation vector */
233 real rate; /* Rate of rotation (degree/ps) */
234 real k; /* Force constant (kJ/(mol nm^2) */
235 rvec pivot; /* Pivot point of rotation axis (nm) */
236 int eFittype; /* Type of fit to determine actual group angle */
237 int PotAngle_nstep; /* Number of angles around the reference angle
238 for which the rotation potential is also
239 evaluated (for fit type 'potential' only) */
240 real PotAngle_step; /* Distance between two angles in degrees (for
241 fit type 'potential' only) */
242 real slab_dist; /* Slab distance (nm) */
243 real min_gaussian; /* Minimum value the gaussian must have so that
244 the force is actually evaluated */
245 real eps; /* Additive constant for radial motion2 and
246 flexible2 potentials (nm^2) */
247 gmx_enfrotgrp_t enfrotgrp; /* Stores non-inputrec rotation data per group */
251 int ngrp; /* Number of rotation groups */
252 int nstrout; /* Output frequency for main rotation outfile */
253 int nstsout; /* Output frequency for per-slab data */
254 t_rotgrp *grp; /* Groups to rotate */
255 gmx_enfrot_t enfrot; /* Stores non-inputrec enforced rotation data */
260 int type; /* type of AdResS simulation */
261 gmx_bool bnew_wf; /* enable new AdResS weighting function */
262 gmx_bool bchempot_dx; /*true:interaction table format input is F=-dmu/dx false: dmu_dwp */
263 gmx_bool btf_full_box; /* true: appy therm force everywhere in the box according to table false: only in hybrid region */
264 real const_wf; /* value of weighting function for eAdressConst */
265 real ex_width; /* center of the explicit zone */
266 real hy_width; /* width of the hybrid zone */
267 int icor; /* type of interface correction */
268 int site; /* AdResS CG site location */
269 rvec refs; /* Coordinates for AdResS reference */
270 real ex_forcecap; /* in the hybrid zone, cap forces large then this to adress_ex_forcecap */
271 gmx_bool do_hybridpairs; /* If true pair interaction forces are also scaled in an adress way*/
273 int * tf_table_index; /* contains mapping of energy group index -> i-th adress tf table*/
280 int eI; /* Integration method */
281 gmx_large_int_t nsteps; /* number of steps to be taken */
282 int simulation_part; /* Used in checkpointing to separate chunks */
283 gmx_large_int_t init_step; /* start at a stepcount >0 (used w. tpbconv) */
284 int nstcalcenergy; /* frequency of energy calc. and T/P coupl. upd. */
285 int cutoff_scheme; /* group or verlet cutoffs */
286 int ns_type; /* which ns method should we use? */
287 int nstlist; /* number of steps before pairlist is generated */
288 int ndelta; /* number of cells per rlong */
289 int nstcomm; /* number of steps after which center of mass */
290 /* motion is removed */
291 int comm_mode; /* Center of mass motion removal algorithm */
292 int nstcheckpoint; /* checkpointing frequency */
293 int nstlog; /* number of steps after which print to logfile */
294 int nstxout; /* number of steps after which X is output */
295 int nstvout; /* id. for V */
296 int nstfout; /* id. for F */
297 int nstenergy; /* number of steps after which energies printed */
298 int nstxtcout; /* id. for compressed trj (.xtc) */
299 double init_t; /* initial time (ps) */
300 double delta_t; /* time step (ps) */
301 real xtcprec; /* precision of xtc file */
302 real fourier_spacing; /* requested fourier_spacing, when nk? not set */
303 int nkx, nky, nkz; /* number of k vectors in each spatial dimension*/
304 /* for fourier methods for long range electrost.*/
305 int pme_order; /* interpolation order for PME */
306 real ewald_rtol; /* Real space tolerance for Ewald, determines */
307 /* the real/reciprocal space relative weight */
308 real ewald_rtol_lj; /* Real space tolerance for LJ-Ewald */
309 int ewald_geometry; /* normal/3d ewald, or pseudo-2d LR corrections */
310 real epsilon_surface; /* Epsilon for PME dipole correction */
311 gmx_bool bOptFFT; /* optimize the fft plan at start */
312 int ljpme_combination_rule; /* Type of combination rule in LJ-PME */
313 int ePBC; /* Type of periodic boundary conditions */
314 int bPeriodicMols; /* Periodic molecules */
315 gmx_bool bContinuation; /* Continuation run: starting state is correct */
316 int etc; /* temperature coupling */
317 int nsttcouple; /* interval in steps for temperature coupling */
318 gmx_bool bPrintNHChains; /* whether to print nose-hoover chains */
319 int epc; /* pressure coupling */
320 int epct; /* pressure coupling type */
321 int nstpcouple; /* interval in steps for pressure coupling */
322 real tau_p; /* pressure coupling time (ps) */
323 tensor ref_p; /* reference pressure (kJ/(mol nm^3)) */
324 tensor compress; /* compressability ((mol nm^3)/kJ) */
325 int refcoord_scaling; /* How to scale absolute reference coordinates */
326 rvec posres_com; /* The COM of the posres atoms */
327 rvec posres_comB; /* The B-state COM of the posres atoms */
328 int andersen_seed; /* Random seed for Andersen thermostat (obsolete) */
329 real verletbuf_drift; /* Max. drift (kJ/mol/ps/atom) for list buffer */
330 real rlist; /* short range pairlist cut-off (nm) */
331 real rlistlong; /* long range pairlist cut-off (nm) */
332 int nstcalclr; /* Frequency of evaluating direct space long-range interactions */
333 real rtpi; /* Radius for test particle insertion */
334 int coulombtype; /* Type of electrostatics treatment */
335 int coulomb_modifier; /* Modify the Coulomb interaction */
336 real rcoulomb_switch; /* Coulomb switch range start (nm) */
337 real rcoulomb; /* Coulomb cutoff (nm) */
338 real epsilon_r; /* relative dielectric constant */
339 real epsilon_rf; /* relative dielectric constant of the RF */
340 int implicit_solvent; /* No (=explicit water), or GBSA solvent models */
341 int gb_algorithm; /* Algorithm to use for calculation Born radii */
342 int nstgbradii; /* Frequency of updating Generalized Born radii */
343 real rgbradii; /* Cutoff for GB radii calculation */
344 real gb_saltconc; /* Salt concentration (M) for GBSA models */
345 real gb_epsilon_solvent; /* dielectric coeff. of implicit solvent */
346 real gb_obc_alpha; /* 1st scaling factor for Bashford-Case GB */
347 real gb_obc_beta; /* 2nd scaling factor for Bashford-Case GB */
348 real gb_obc_gamma; /* 3rd scaling factor for Bashford-Case GB */
349 real gb_dielectric_offset; /* Dielectric offset for Still/HCT/OBC */
350 int sa_algorithm; /* Algorithm for SA part of GBSA */
351 real sa_surface_tension; /* Energy factor for SA part of GBSA */
352 int vdwtype; /* Type of Van der Waals treatment */
353 int vdw_modifier; /* Modify the VdW interaction */
354 real rvdw_switch; /* Van der Waals switch range start (nm) */
355 real rvdw; /* Van der Waals cutoff (nm) */
356 int eDispCorr; /* Perform Long range dispersion corrections */
357 real tabext; /* Extension of the table beyond the cut-off, *
358 * as well as the table length for 1-4 interac. */
359 real shake_tol; /* tolerance for shake */
360 int efep; /* free energy calculations */
361 t_lambda *fepvals; /* Data for the FEP state */
362 gmx_bool bSimTemp; /* Whether to do simulated tempering */
363 t_simtemp *simtempvals; /* Variables for simulated tempering */
364 gmx_bool bExpanded; /* Whether expanded ensembles are used */
365 t_expanded *expandedvals; /* Expanded ensemble parameters */
366 int eDisre; /* Type of distance restraining */
367 real dr_fc; /* force constant for ta_disre */
368 int eDisreWeighting; /* type of weighting of pairs in one restraints */
369 gmx_bool bDisreMixed; /* Use comb of time averaged and instan. viol's */
370 int nstdisreout; /* frequency of writing pair distances to enx */
371 real dr_tau; /* time constant for memory function in disres */
372 real orires_fc; /* force constant for orientational restraints */
373 real orires_tau; /* time constant for memory function in orires */
374 int nstorireout; /* frequency of writing tr(SD) to enx */
375 real dihre_fc; /* force constant for dihedral restraints (obsolete) */
376 real em_stepsize; /* The stepsize for updating */
377 real em_tol; /* The tolerance */
378 int niter; /* Number of iterations for convergence of */
379 /* steepest descent in relax_shells */
380 real fc_stepsize; /* Stepsize for directional minimization */
381 /* in relax_shells */
382 int nstcgsteep; /* number of steps after which a steepest */
383 /* descents step is done while doing cg */
384 int nbfgscorr; /* Number of corrections to the hessian to keep */
385 int eConstrAlg; /* Type of constraint algorithm */
386 int nProjOrder; /* Order of the LINCS Projection Algorithm */
387 real LincsWarnAngle; /* If bond rotates more than %g degrees, warn */
388 int nLincsIter; /* Number of iterations in the final Lincs step */
389 gmx_bool bShakeSOR; /* Use successive overrelaxation for shake */
390 real bd_fric; /* Friction coefficient for BD (amu/ps) */
391 int ld_seed; /* Random seed for SD and BD */
392 int nwall; /* The number of walls */
393 int wall_type; /* The type of walls */
394 real wall_r_linpot; /* The potentail is linear for r<=wall_r_linpot */
395 int wall_atomtype[2]; /* The atom type for walls */
396 real wall_density[2]; /* Number density for walls */
397 real wall_ewald_zfac; /* Scaling factor for the box for Ewald */
398 int ePull; /* Type of pulling: no, umbrella or constraint */
399 t_pull *pull; /* The data for center of mass pulling */
400 gmx_bool bRot; /* Calculate enforced rotation potential(s)? */
401 t_rot *rot; /* The data for enforced rotation potentials */
402 real cos_accel; /* Acceleration for viscosity calculation */
403 tensor deform; /* Triclinic deformation velocities (nm/ps) */
404 int userint1; /* User determined parameters */
412 t_grpopts opts; /* Group options */
413 t_cosines ex[DIM]; /* Electric field stuff (spatial part) */
414 t_cosines et[DIM]; /* Electric field stuff (time part) */
415 gmx_bool bQMMM; /* QM/MM calculation */
416 int QMconstraints; /* constraints on QM bonds */
417 int QMMMscheme; /* Scheme: ONIOM or normal */
418 real scalefactor; /* factor for scaling the MM charges in QM calc.*/
419 /* parameter needed for AdResS simulation */
420 gmx_bool bAdress; /* Is AdResS enabled ? */
421 t_adress *adress; /* The data for adress simulations */
424 #define DEFORM(ir) ((ir).deform[XX][XX] != 0 || (ir).deform[YY][YY] != 0 || (ir).deform[ZZ][ZZ] != 0 || (ir).deform[YY][XX] != 0 || (ir).deform[ZZ][XX] != 0 || (ir).deform[ZZ][YY] != 0)
426 #define DYNAMIC_BOX(ir) ((ir).epc != epcNO || (ir).eI == eiTPI || DEFORM(ir))
428 #define PRESERVE_SHAPE(ir) ((ir).epc != epcNO && (ir).deform[XX][XX] == 0 && ((ir).epct == epctISOTROPIC || (ir).epct == epctSEMIISOTROPIC))
430 #define NEED_MUTOT(ir) (((ir).coulombtype == eelEWALD || EEL_PME((ir).coulombtype)) && ((ir).ewald_geometry == eewg3DC || (ir).epsilon_surface != 0))
432 #define IR_TWINRANGE(ir) ((ir).rlist > 0 && ((ir).rlistlong == 0 || (ir).rlistlong > (ir).rlist))
434 #define IR_ELEC_FIELD(ir) ((ir).ex[XX].n > 0 || (ir).ex[YY].n > 0 || (ir).ex[ZZ].n > 0)
436 #define IR_EXCL_FORCES(ir) (EEL_FULL((ir).coulombtype) || (EEL_RF((ir).coulombtype) && (ir).coulombtype != eelRF_NEC) || (ir).implicit_solvent != eisNO)
437 /* use pointer definitions of ir here, since that's what's usually used in the code */
438 #define IR_NPT_TROTTER(ir) ((((ir)->eI == eiVV) || ((ir)->eI == eiVVAK)) && (((ir)->epc == epcMTTK) && ((ir)->etc == etcNOSEHOOVER)))
440 #define IR_NVT_TROTTER(ir) ((((ir)->eI == eiVV) || ((ir)->eI == eiVVAK)) && ((!((ir)->epc == epcMTTK)) && ((ir)->etc == etcNOSEHOOVER)))
442 #define IR_NPH_TROTTER(ir) ((((ir)->eI == eiVV) || ((ir)->eI == eiVVAK)) && (((ir)->epc == epcMTTK) && (!(((ir)->etc == etcNOSEHOOVER)))))