Molecular dynamics parameters (.mdp options)¶
General information¶
Default values are given in parentheses, or listed first among choices. The first option in the list is always the default option. Units are given in square brackets. The difference between a dash and an underscore is ignored.
A sample mdp file is available. This should be appropriate to start a normal simulation. Edit it to suit your specific needs and desires.
Preprocessing¶
- include¶
directories to include in your topology. Format:
-I/home/john/mylib -I../otherlib
- define¶
defines to pass to the preprocessor, default is no defines. You can use any defines to control options in your customized topology files. Options that act on existing top file mechanisms include
-DFLEXIBLE
will use flexible water instead of rigid water into your topology, this can be useful for normal mode analysis.-DPOSRES
will trigger the inclusion ofposre.itp
into your topology, used for implementing position restraints.
Run control¶
- integrator¶
(Despite the name, this list includes algorithms that are not actually integrators over time.
integrator=steep
and all entries following it are in this category)- md¶
A leap-frog algorithm for integrating Newton’s equations of motion.
- md-vv¶
A velocity Verlet algorithm for integrating Newton’s equations of motion. For constant NVE simulations started from corresponding points in the same trajectory, the trajectories are analytically, but not binary, identical to the
integrator=md
leap-frog integrator. The kinetic energy, which is determined from the whole step velocities and is therefore slightly too high. The advantage of this integrator is more accurate, reversible Nose-Hoover and Parrinello-Rahman coupling integration based on Trotter expansion, as well as (slightly too small) full step velocity output. This all comes at the cost off extra computation, especially with constraints and extra communication in parallel. Note that for nearly all production simulations theintegrator=md
integrator is accurate enough.
- md-vv-avek¶
A velocity Verlet algorithm identical to
integrator=md-vv
, except that the kinetic energy is determined as the average of the two half step kinetic energies as in theintegrator=md
integrator, and this thus more accurate. With Nose-Hoover and/or Parrinello-Rahman coupling this comes with a slight increase in computational cost.
- sd¶
An accurate and efficient leap-frog stochastic dynamics integrator. With constraints, coordinates needs to be constrained twice per integration step. Depending on the computational cost of the force calculation, this can take a significant part of the simulation time. The temperature for one or more groups of atoms (
tc-grps
) is set withref-t
, the inverse friction constant for each group is set withtau-t
. The parameterstcoupl
andnsttcouple
are ignored. The random generator is initialized withld-seed
. When used as a thermostat, an appropriate value fortau-t
is 2 ps, since this results in a friction that is lower than the internal friction of water, while it is high enough to remove excess heat NOTE: temperature deviations decay twice as fast as with a Berendsen thermostat with the sametau-t
.
- bd¶
An Euler integrator for Brownian or position Langevin dynamics, the velocity is the force divided by a friction coefficient (
bd-fric
) plus random thermal noise (ref-t
). Whenbd-fric
is 0, the friction coefficient for each particle is calculated as mass/tau-t
, as for the integratorintegrator=sd
. The random generator is initialized withld-seed
.
- steep¶
A steepest descent algorithm for energy minimization. The maximum step size is
emstep
, the tolerance isemtol
.
- cg¶
A conjugate gradient algorithm for energy minimization, the tolerance is
emtol
. CG is more efficient when a steepest descent step is done every once in a while, this is determined bynstcgsteep
. For a minimization prior to a normal mode analysis, which requires a very high accuracy, GROMACS should be compiled in double precision.
- l-bfgs¶
A quasi-Newtonian algorithm for energy minimization according to the low-memory Broyden-Fletcher-Goldfarb-Shanno approach. In practice this seems to converge faster than Conjugate Gradients, but due to the correction steps necessary it is not (yet) parallelized.
- nm¶
Normal mode analysis is performed on the structure in the tpr file. GROMACS should be compiled in double precision.
- tpi¶
Test particle insertion. The last molecule in the topology is the test particle. A trajectory must be provided to
mdrun -rerun
. This trajectory should not contain the molecule to be inserted. Insertions are performednsteps
times in each frame at random locations and with random orientiations of the molecule. Whennstlist
is larger than one,nstlist
insertions are performed in a sphere with radiusrtpi
around a the same random location using the same pair list. Since pair list construction is expensive, one can perform several extra insertions with the same list almost for free. The random seed is set withld-seed
. The temperature for the Boltzmann weighting is set withref-t
, this should match the temperature of the simulation of the original trajectory. Dispersion correction is implemented correctly for TPI. All relevant quantities are written to the file specified withmdrun -tpi
. The distribution of insertion energies is written to the file specified withmdrun -tpid
. No trajectory or energy file is written. Parallel TPI gives identical results to single-node TPI. For charged molecules, using PME with a fine grid is most accurate and also efficient, since the potential in the system only needs to be calculated once per frame.
- tpic¶
Test particle insertion into a predefined cavity location. The procedure is the same as for
integrator=tpi
, except that one coordinate extra is read from the trajectory, which is used as the insertion location. The molecule to be inserted should be centered at 0,0,0. GROMACS does not do this for you, since for different situations a different way of centering might be optimal. Alsortpi
sets the radius for the sphere around this location. Neighbor searching is done only once per frame,nstlist
is not used. Parallelintegrator=tpic
gives identical results to single-rankintegrator=tpic
.
- mimic¶
Enable MiMiC QM/MM coupling to run hybrid molecular dynamics. Keey in mind that its required to launch CPMD compiled with MiMiC as well. In this mode all options regarding integration (T-coupling, P-coupling, timestep and number of steps) are ignored as CPMD will do the integration instead. Options related to forces computation (cutoffs, PME parameters, etc.) are working as usual. Atom selection to define QM atoms is read from
QMMM-grps
- tinit¶
(0) [ps] starting time for your run (only makes sense for time-based integrators)
- dt¶
(0.001) [ps] time step for integration (only makes sense for time-based integrators)
- nsteps¶
(0) maximum number of steps to integrate or minimize, -1 is no maximum
- init-step¶
(0) The starting step. The time at step i in a run is calculated as: t =
tinit
+dt
* (init-step
+ i). The free-energy lambda is calculated as: lambda =init-lambda
+delta-lambda
* (init-step
+ i). Also non-equilibrium MD parameters can depend on the step number. Thus for exact restarts or redoing part of a run it might be necessary to setinit-step
to the step number of the restart frame. gmx convert-tpr does this automatically.
- simulation-part¶
(0) A simulation can consist of multiple parts, each of which has a part number. This option specifies what that number will be, which helps keep track of parts that are logically the same simulation. This option is generally useful to set only when coping with a crashed simulation where files were lost.
- mts¶
- no¶
Evaluate all forces at every integration step.
- yes¶
Use a multiple timing-stepping integrator to evaluate some forces, as specified by
mts-level2-forces
everymts-level2-factor
integration steps. All other forces are evaluated at every step. MTS is currently only supported withintegrator=md
.
- mts-levels¶
(2) The number of levels for the multiple time-stepping scheme. Currently only 2 is supported.
- mts-level2-forces¶
(longrange-nonbonded) A list of one or more force groups that will be evaluated only every
mts-level2-factor
steps. Supported entries are:longrange-nonbonded
,nonbonded
,pair
,dihedral
,angle
,pull
andawh
. Withpair
the listed pair forces (such as 1-4) are selected. Withdihedral
all dihedrals are selected, including cmap. All other forces, including all restraints, are evaluated and integrated every step. When PME or Ewald is used for electrostatics and/or LJ interactions,longrange-nonbonded
can not be omitted here.
- mts-level2-factor¶
(2) [steps] Interval for computing the forces in level 2 of the multiple time-stepping scheme
- comm-mode¶
- Linear¶
Remove center of mass translational velocity
- Angular¶
Remove center of mass translational and rotational velocity
- Linear-acceleration-correction¶
Remove center of mass translational velocity. Correct the center of mass position assuming linear acceleration over
nstcomm
steps. This is useful for cases where an acceleration is expected on the center of mass which is nearly constant overnstcomm
steps. This can occur for example when pulling on a group using an absolute reference.
- None¶
No restriction on the center of mass motion
- nstcomm¶
(100) [steps] frequency for center of mass motion removal
- comm-grps¶
group(s) for center of mass motion removal, default is the whole system
Langevin dynamics¶
Energy minimization¶
- emtol¶
(10.0) [kJ mol-1 nm-1] the minimization is converged when the maximum force is smaller than this value
- emstep¶
(0.01) [nm] initial step-size
- nstcgsteep¶
(1000) [steps] frequency of performing 1 steepest descent step while doing conjugate gradient energy minimization.
- nbfgscorr¶
(10) Number of correction steps to use for L-BFGS minimization. A higher number is (at least theoretically) more accurate, but slower.
Shell Molecular Dynamics¶
When shells or flexible constraints are present in the system the
positions of the shells and the lengths of the flexible constraints
are optimized at every time step until either the RMS force on the
shells and constraints is less than emtol
, or a maximum number
of iterations niter
has been reached. Minimization is converged
when the maximum force is smaller than emtol
. For shell MD this
value should be 1.0 at most.
- niter¶
(20) maximum number of iterations for optimizing the shell positions and the flexible constraints.
- fcstep¶
(0) [ps2] the step size for optimizing the flexible constraints. Should be chosen as mu/(d2V/dq2) where mu is the reduced mass of two particles in a flexible constraint and d2V/dq2 is the second derivative of the potential in the constraint direction. Hopefully this number does not differ too much between the flexible constraints, as the number of iterations and thus the runtime is very sensitive to fcstep. Try several values!
Test particle insertion¶
- rtpi¶
(0.05) [nm] the test particle insertion radius, see integrators
integrator=tpi
andintegrator=tpic
Output control¶
- nstxout¶
(0) [steps] number of steps that elapse between writing coordinates to the output trajectory file (trr), the last coordinates are always written unless 0, which means coordinates are not written into the trajectory file.
- nstvout¶
(0) [steps] number of steps that elapse between writing velocities to the output trajectory file (trr), the last velocities are always written unless 0, which means velocities are not written into the trajectory file.
- nstfout¶
(0) [steps] number of steps that elapse between writing forces to the output trajectory file (trr), the last forces are always written, unless 0, which means forces are not written into the trajectory file.
- nstlog¶
(1000) [steps] number of steps that elapse between writing energies to the log file, the last energies are always written.
- nstcalcenergy¶
(100) number of steps that elapse between calculating the energies, 0 is never. This option is only relevant with dynamics. This option affects the performance in parallel simulations, because calculating energies requires global communication between all processes which can become a bottleneck at high parallelization.
- nstenergy¶
(1000) [steps] number of steps that elapse between writing energies to energy file, the last energies are always written, should be a multiple of
nstcalcenergy
. Note that the exact sums and fluctuations over all MD steps modulonstcalcenergy
are stored in the energy file, so gmx energy can report exact energy averages and fluctuations also whennstenergy
> 1
- nstxout-compressed¶
(0) [steps] number of steps that elapse between writing position coordinates using lossy compression (xtc file), 0 for not writing compressed coordinates output.
- compressed-x-precision¶
(1000) [real] precision with which to write to the compressed trajectory file
- compressed-x-grps¶
group(s) to write to the compressed trajectory file, by default the whole system is written (if
nstxout-compressed
> 0)
- energygrps¶
group(s) for which to write to write short-ranged non-bonded potential energies to the energy file (not supported on GPUs)
Neighbor searching¶
- cutoff-scheme¶
- Verlet¶
Generate a pair list with buffering. The buffer size is automatically set based on
verlet-buffer-tolerance
, unless this is set to -1, in which caserlist
will be used.
- group¶
Generate a pair list for groups of atoms, corresponding to the charge groups in the topology. This option is no longer supported.
- nstlist¶
[steps]
- >0¶
Frequency to update the neighbor list. When dynamics and
verlet-buffer-tolerance
set,nstlist
is actually a minimum value and gmx mdrun might increase it, unless it is set to 1. With parallel simulations and/or non-bonded force calculation on the GPU, a value of 20 or 40 often gives the best performance. With energy minimization this parameter is not used as the pair list is updated when at least one atom has moved by more than half the pair list buffer size.
- 0¶
The neighbor list is only constructed once and never updated. This is mainly useful for vacuum simulations in which all particles see each other. But vacuum simulations are (temporarily) not supported.
- <0¶
Unused.
- pbc¶
- xyz¶
Use periodic boundary conditions in all directions.
- no¶
Use no periodic boundary conditions, ignore the box. To simulate without cut-offs, set all cut-offs and
nstlist
to 0. For best performance without cut-offs on a single MPI rank, setnstlist
to zero andns-type=simple
.
- xy¶
Use periodic boundary conditions in x and y directions only. This works only with
ns-type=grid
and can be used in combination with walls. Without walls or with only one wall the system size is infinite in the z direction. Therefore pressure coupling or Ewald summation methods can not be used. These disadvantages do not apply when two walls are used.
- periodic-molecules¶
- no¶
molecules are finite, fast molecular PBC can be used
- yes¶
for systems with molecules that couple to themselves through the periodic boundary conditions, this requires a slower PBC algorithm and molecules are not made whole in the output
- verlet-buffer-tolerance¶
(0.005) [kJ mol-1 ps-1]
Used when performing a simulation with dynamics. This sets the maximum allowed error for pair interactions per particle caused by the Verlet buffer, which indirectly sets
rlist
. As bothnstlist
and the Verlet buffer size are fixed (for performance reasons), particle pairs not in the pair list can occasionally get within the cut-off distance duringnstlist
-1 steps. This causes very small jumps in the energy. In a constant-temperature ensemble, these very small energy jumps can be estimated for a given cut-off andrlist
. The estimate assumes a homogeneous particle distribution, hence the errors might be slightly underestimated for multi-phase systems. (See the reference manual for details). For longer pair-list life-time (nstlist
-1) *dt
the buffer is overestimated, because the interactions between particles are ignored. Combined with cancellation of errors, the actual drift of the total energy is usually one to two orders of magnitude smaller. Note that the generated buffer size takes into account that the GROMACS pair-list setup leads to a reduction in the drift by a factor 10, compared to a simple particle-pair based list. Without dynamics (energy minimization etc.), the buffer is 5% of the cut-off. For NVE simulations the initial temperature is used, unless this is zero, in which case a buffer of 10% is used. For NVE simulations the tolerance usually needs to be lowered to achieve proper energy conservation on the nanosecond time scale. To override the automated buffer setting, useverlet-buffer-tolerance
=-1 and setrlist
manually.
- rlist¶
(1) [nm] Cut-off distance for the short-range neighbor list. With dynamics, this is by default set by the
verlet-buffer-tolerance
option and the value ofrlist
is ignored. Without dynamics, this is by default set to the maximum cut-off plus 5% buffer, except for test particle insertion, where the buffer is managed exactly and automatically. For NVE simulations, where the automated setting is not possible, the advised procedure is to run gmx grompp with an NVT setup with the expected temperature and copy the resulting value ofrlist
to the NVE setup.
Electrostatics¶
- coulombtype¶
- Cut-off¶
Plain cut-off with pair list radius
rlist
and Coulomb cut-offrcoulomb
, whererlist
>=rcoulomb
.
- Ewald¶
Classical Ewald sum electrostatics. The real-space cut-off
rcoulomb
should be equal torlist
. Use e.g.rlist
=0.9,rcoulomb
=0.9. The highest magnitude of wave vectors used in reciprocal space is controlled byfourierspacing
. The relative accuracy of direct/reciprocal space is controlled byewald-rtol
.NOTE: Ewald scales as O(N3/2) and is thus extremely slow for large systems. It is included mainly for reference - in most cases PME will perform much better.
- PME¶
Fast smooth Particle-Mesh Ewald (SPME) electrostatics. Direct space is similar to the Ewald sum, while the reciprocal part is performed with FFTs. Grid dimensions are controlled with
fourierspacing
and the interpolation order withpme-order
. With a grid spacing of 0.1 nm and cubic interpolation the electrostatic forces have an accuracy of 2-3*10-4. Since the error from the vdw-cutoff is larger than this you might try 0.15 nm. When running in parallel the interpolation parallelizes better than the FFT, so try decreasing grid dimensions while increasing interpolation.
- P3M-AD¶
Particle-Particle Particle-Mesh algorithm with analytical derivative for for long range electrostatic interactions. The method and code is identical to SPME, except that the influence function is optimized for the grid. This gives a slight increase in accuracy.
- Reaction-Field¶
Reaction field electrostatics with Coulomb cut-off
rcoulomb
, whererlist
>=rvdw
. The dielectric constant beyond the cut-off isepsilon-rf
. The dielectric constant can be set to infinity by settingepsilon-rf
=0.
- User¶
Currently unsupported. gmx mdrun will now expect to find a file
table.xvg
with user-defined potential functions for repulsion, dispersion and Coulomb. When pair interactions are present, gmx mdrun also expects to find a filetablep.xvg
for the pair interactions. When the same interactions should be used for non-bonded and pair interactions the user can specify the same file name for both table files. These files should contain 7 columns: thex
value,f(x)
,-f'(x)
,g(x)
,-g'(x)
,h(x)
,-h'(x)
, wheref(x)
is the Coulomb function,g(x)
the dispersion function andh(x)
the repulsion function. Whenvdwtype
is not set to User the values forg
,-g'
,h
and-h'
are ignored. For the non-bonded interactionsx
values should run from 0 to the largest cut-off distance +table-extension
and should be uniformly spaced. For the pair interactions the table length in the file will be used. The optimal spacing, which is used for non-user tables, is0.002 nm
when you run in mixed precision or0.0005 nm
when you run in double precision. The function value atx=0
is not important. More information is in the printed manual.
- PME-Switch¶
Currently unsupported. A combination of PME and a switch function for the direct-space part (see above).
rcoulomb
is allowed to be smaller thanrlist
.
- PME-User¶
Currently unsupported. A combination of PME and user tables (see above).
rcoulomb
is allowed to be smaller thanrlist
. The PME mesh contribution is subtracted from the user table by gmx mdrun. Because of this subtraction the user tables should contain about 10 decimal places.
- PME-User-Switch¶
Currently unsupported. A combination of PME-User and a switching function (see above). The switching function is applied to final particle-particle interaction, i.e. both to the user supplied function and the PME Mesh correction part.
- coulomb-modifier¶
- Potential-shift¶
Shift the Coulomb potential by a constant such that it is zero at the cut-off. This makes the potential the integral of the force. Note that this does not affect the forces or the sampling.
- None¶
Use an unmodified Coulomb potential. This can be useful when comparing energies with those computed with other software.
- rcoulomb-switch¶
(0) [nm] where to start switching the Coulomb potential, only relevant when force or potential switching is used
- rcoulomb¶
(1) [nm] The distance for the Coulomb cut-off. Note that with PME this value can be increased by the PME tuning in gmx mdrun along with the PME grid spacing.
- epsilon-r¶
(1) The relative dielectric constant. A value of 0 means infinity.
- epsilon-rf¶
(0) The relative dielectric constant of the reaction field. This is only used with reaction-field electrostatics. A value of 0 means infinity.
Van der Waals¶
- vdwtype¶
-
- PME¶
Fast smooth Particle-mesh Ewald (SPME) for VdW interactions. The grid dimensions are controlled with
fourierspacing
in the same way as for electrostatics, and the interpolation order is controlled withpme-order
. The relative accuracy of direct/reciprocal space is controlled byewald-rtol-lj
, and the specific combination rules that are to be used by the reciprocal routine are set usinglj-pme-comb-rule
.
- Shift¶
This functionality is deprecated and replaced by using
vdwtype=Cut-off
withvdw-modifier=Force-switch
. The LJ (not Buckingham) potential is decreased over the whole range and the forces decay smoothly to zero betweenrvdw-switch
andrvdw
.
- Switch¶
This functionality is deprecated and replaced by using
vdwtype=Cut-off
withvdw-modifier=Potential-switch
. The LJ (not Buckingham) potential is normal out torvdw-switch
, after which it is switched off to reach zero atrvdw
. Both the potential and force functions are continuously smooth, but be aware that all switch functions will give rise to a bulge (increase) in the force (since we are switching the potential).
- User¶
Currently unsupported. See user for
coulombtype
. The function value at zero is not important. When you want to use LJ correction, make sure thatrvdw
corresponds to the cut-off in the user-defined function. Whencoulombtype
is not set to User the values for thef
and-f'
columns are ignored.
- vdw-modifier¶
- Potential-shift¶
Shift the Van der Waals potential by a constant such that it is zero at the cut-off. This makes the potential the integral of the force. Note that this does not affect the forces or the sampling.
- None¶
Use an unmodified Van der Waals potential. This can be useful when comparing energies with those computed with other software.
- Force-switch¶
Smoothly switches the forces to zero between
rvdw-switch
andrvdw
. This shifts the potential shift over the whole range and switches it to zero at the cut-off. Note that this is more expensive to calculate than a plain cut-off and it is not required for energy conservation, since Potential-shift conserves energy just as well.
- Potential-switch¶
Smoothly switches the potential to zero between
rvdw-switch
andrvdw
. Note that this introduces articifically large forces in the switching region and is much more expensive to calculate. This option should only be used if the force field you are using requires this.
- rvdw-switch¶
(0) [nm] where to start switching the LJ force and possibly the potential, only relevant when force or potential switching is used
- rvdw¶
(1) [nm] distance for the LJ or Buckingham cut-off
Tables¶
- table-extension¶
(1) [nm] Extension of the non-bonded potential lookup tables beyond the largest cut-off distance. With actual non-bonded interactions the tables are never accessed beyond the cut-off. But a longer table length might be needed for the 1-4 interactions, which are always tabulated irrespective of the use of tables for the non-bonded interactions.
- energygrp-table¶
Currently unsupported. When user tables are used for electrostatics and/or VdW, here one can give pairs of energy groups for which separate user tables should be used. The two energy groups will be appended to the table file name, in order of their definition in
energygrps
, separated by underscores. For example, ifenergygrps = Na Cl Sol
andenergygrp-table = Na Na Na Cl
, gmx mdrun will readtable_Na_Na.xvg
andtable_Na_Cl.xvg
in addition to the normaltable.xvg
which will be used for all other energy group pairs.
Ewald¶
- fourierspacing¶
(0.12) [nm] For ordinary Ewald, the ratio of the box dimensions and the spacing determines a lower bound for the number of wave vectors to use in each (signed) direction. For PME and P3M, that ratio determines a lower bound for the number of Fourier-space grid points that will be used along that axis. In all cases, the number for each direction can be overridden by entering a non-zero value for that
fourier-nx
direction. For optimizing the relative load of the particle-particle interactions and the mesh part of PME, it is useful to know that the accuracy of the electrostatics remains nearly constant when the Coulomb cut-off and the PME grid spacing are scaled by the same factor. Note that this spacing can be scaled up along withrcoulomb
by the PME tuning in gmx mdrun.
- fourier-nx¶
- fourier-ny¶
- fourier-nz¶
(0) Highest magnitude of wave vectors in reciprocal space when using Ewald. Grid size when using PME or P3M. These values override
fourierspacing
per direction. The best choice is powers of 2, 3, 5 and 7. Avoid large primes. Note that these grid sizes can be reduced along with scaling uprcoulomb
by the PME tuning in gmx mdrun.
- pme-order¶
(4) Interpolation order for PME. 4 equals cubic interpolation. You might try 6/8/10 when running in parallel and simultaneously decrease grid dimension.
- ewald-rtol¶
(10-5) The relative strength of the Ewald-shifted direct potential at
rcoulomb
is given byewald-rtol
. Decreasing this will give a more accurate direct sum, but then you need more wave vectors for the reciprocal sum.
- ewald-rtol-lj¶
(10-3) When doing PME for VdW-interactions,
ewald-rtol-lj
is used to control the relative strength of the dispersion potential atrvdw
in the same way asewald-rtol
controls the electrostatic potential.
- lj-pme-comb-rule¶
(Geometric) The combination rules used to combine VdW-parameters in the reciprocal part of LJ-PME. Geometric rules are much faster than Lorentz-Berthelot and usually the recommended choice, even when the rest of the force field uses the Lorentz-Berthelot rules.
- Geometric¶
Apply geometric combination rules
- Lorentz-Berthelot¶
Apply Lorentz-Berthelot combination rules
- ewald-geometry¶
- 3d¶
The Ewald sum is performed in all three dimensions.
- 3dc¶
The reciprocal sum is still performed in 3D, but a force and potential correction applied in the
z
dimension to produce a pseudo-2D summation. If your system has a slab geometry in thex-y
plane you can try to increase thez
-dimension of the box (a box height of 3 times the slab height is usually ok) and use this option.
- epsilon-surface¶
(0) This controls the dipole correction to the Ewald summation in 3D. The default value of zero means it is turned off. Turn it on by setting it to the value of the relative permittivity of the imaginary surface around your infinite system. Be careful - you shouldn’t use this if you have free mobile charges in your system. This value does not affect the slab 3DC variant of the long range corrections.
Temperature coupling¶
- tcoupl¶
- no¶
No temperature coupling.
- berendsen¶
Temperature coupling with a Berendsen thermostat to a bath with temperature
ref-t
, with time constanttau-t
. Several groups can be coupled separately, these are specified in thetc-grps
field separated by spaces. This is a historical thermostat needed to be able to reproduce previous simulations, but we strongly recommend not to use it for new production runs. Consult the manual for details.
- nose-hoover¶
Temperature coupling using a Nose-Hoover extended ensemble. The reference temperature and coupling groups are selected as above, but in this case
tau-t
controls the period of the temperature fluctuations at equilibrium, which is slightly different from a relaxation time. For NVT simulations the conserved energy quantity is written to the energy and log files.
- andersen¶
Temperature coupling by randomizing a fraction of the particle velocities at each timestep. Reference temperature and coupling groups are selected as above.
tau-t
is the average time between randomization of each molecule. Inhibits particle dynamics somewhat, but little or no ergodicity issues. Currently only implemented with velocity Verlet, and not implemented with constraints.
- andersen-massive¶
Temperature coupling by randomizing velocities of all particles at infrequent timesteps. Reference temperature and coupling groups are selected as above.
tau-t
is the time between randomization of all molecules. Inhibits particle dynamics somewhat, but little or no ergodicity issues. Currently only implemented with velocity Verlet.
- v-rescale¶
Temperature coupling using velocity rescaling with a stochastic term (JCP 126, 014101). This thermostat is similar to Berendsen coupling, with the same scaling using
tau-t
, but the stochastic term ensures that a proper canonical ensemble is generated. The random seed is set withld-seed
. This thermostat works correctly even fortau-t
=0. For NVT simulations the conserved energy quantity is written to the energy and log file.
- nsttcouple¶
(-1) The frequency for coupling the temperature. The default value of -1 sets
nsttcouple
equal to 10, or fewer steps if required for accurate integration. Note that the default value is not 1 because additional computation and communication is required for obtaining the kinetic energy. For velocity Verlet integratorsnsttcouple
is set to 1.
- nh-chain-length¶
(10) The number of chained Nose-Hoover thermostats for velocity Verlet integrators, the leap-frog
integrator=md
integrator only supports 1. Data for the NH chain variables is not printed to the edr file by default, but can be turned on with theprint-nose-hoover-chain-variables
option.
- print-nose-hoover-chain-variables¶
- no¶
Do not store Nose-Hoover chain variables in the energy file.
- yes¶
Store all positions and velocities of the Nose-Hoover chain in the energy file.
- tc-grps¶
groups to couple to separate temperature baths
Pressure coupling¶
- pcoupl¶
- no¶
No pressure coupling. This means a fixed box size.
- Berendsen¶
Exponential relaxation pressure coupling with time constant
tau-p
. The box is scaled everynstpcouple
steps. This barostat does not yield a correct thermodynamic ensemble; it is only included to be able to reproduce previous runs, and we strongly recommend against using it for new simulations. See the manual for details.
- C-rescale¶
Exponential relaxation pressure coupling with time constant
tau-p
, including a stochastic term to enforce correct volume fluctuations. The box is scaled everynstpcouple
steps. It can be used for both equilibration and production, but presently it cannot be used for full anisotropic coupling.
- Parrinello-Rahman¶
Extended-ensemble pressure coupling where the box vectors are subject to an equation of motion. The equation of motion for the atoms is coupled to this. No instantaneous scaling takes place. As for Nose-Hoover temperature coupling the time constant
tau-p
is the period of pressure fluctuations at equilibrium. This is probably a better method when you want to apply pressure scaling during data collection, but beware that you can get very large oscillations if you are starting from a different pressure. For simulations where the exact fluctations of the NPT ensemble are important, or if the pressure coupling time is very short it may not be appropriate, as the previous time step pressure is used in some steps of the GROMACS implementation for the current time step pressure.
- MTTK¶
Martyna-Tuckerman-Tobias-Klein implementation, only useable with
integrator=md-vv
orintegrator=md-vv-avek
, very similar to Parrinello-Rahman. As for Nose-Hoover temperature coupling the time constanttau-p
is the period of pressure fluctuations at equilibrium. This is probably a better method when you want to apply pressure scaling during data collection, but beware that you can get very large oscillations if you are starting from a different pressure. Currently (as of version 5.1), it only supports isotropic scaling, and only works without constraints.
- pcoupltype¶
Specifies the kind of isotropy of the pressure coupling used. Each kind takes one or more values for
compressibility
andref-p
. Only a single value is permitted fortau-p
.- isotropic¶
Isotropic pressure coupling with time constant
tau-p
. One value each forcompressibility
andref-p
is required.
- semiisotropic¶
Pressure coupling which is isotropic in the
x
andy
direction, but different in thez
direction. This can be useful for membrane simulations. Two values each forcompressibility
andref-p
are required, forx/y
andz
directions respectively.
- anisotropic¶
Same as before, but 6 values are needed for
xx
,yy
,zz
,xy/yx
,xz/zx
andyz/zy
components, respectively. When the off-diagonal compressibilities are set to zero, a rectangular box will stay rectangular. Beware that anisotropic scaling can lead to extreme deformation of the simulation box.
- surface-tension¶
Surface tension coupling for surfaces parallel to the xy-plane. Uses normal pressure coupling for the
z
-direction, while the surface tension is coupled to thex/y
dimensions of the box. The firstref-p
value is the reference surface tension times the number of surfacesbar nm
, the second value is the referencez
-pressurebar
. The twocompressibility
values are the compressibility in thex/y
andz
direction respectively. The value for thez
-compressibility should be reasonably accurate since it influences the convergence of the surface-tension, it can also be set to zero to have a box with constant height.
- nstpcouple¶
(-1) The frequency for coupling the pressure. The default value of -1 sets
nstpcouple
equal to 10, or fewer steps if required for accurate integration. Note that the default value is not 1 because additional computation and communication is required for obtaining the virial. For velocity Verlet integratorsnstpcouple
is set to 1.
- tau-p¶
(1) [ps] The time constant for pressure coupling (one value for all directions).
- compressibility¶
[bar-1] The compressibility (NOTE: this is now really in bar-1) For water at 1 atm and 300 K the compressibility is 4.5e-5 bar-1. The number of required values is implied by
pcoupltype
.
- ref-p¶
[bar] The reference pressure for coupling. The number of required values is implied by
pcoupltype
.
- refcoord-scaling¶
- no¶
The reference coordinates for position restraints are not modified. Note that with this option the virial and pressure might be ill defined, see here for more details.
- all¶
The reference coordinates are scaled with the scaling matrix of the pressure coupling.
- com¶
Scale the center of mass of the reference coordinates with the scaling matrix of the pressure coupling. The vectors of each reference coordinate to the center of mass are not scaled. Only one COM is used, even when there are multiple molecules with position restraints. For calculating the COM of the reference coordinates in the starting configuration, periodic boundary conditions are not taken into account. Note that with this option the virial and pressure might be ill defined, see here for more details.
Simulated annealing¶
Simulated annealing is controlled separately for each temperature group in GROMACS. The reference temperature is a piecewise linear function, but you can use an arbitrary number of points for each group, and choose either a single sequence or a periodic behaviour for each group. The actual annealing is performed by dynamically changing the reference temperature used in the thermostat algorithm selected, so remember that the system will usually not instantaneously reach the reference temperature!
- annealing¶
Type of annealing for each temperature group
- no¶
No simulated annealing - just couple to reference temperature value.
- single¶
A single sequence of annealing points. If your simulation is longer than the time of the last point, the temperature will be coupled to this constant value after the annealing sequence has reached the last time point.
- periodic¶
The annealing will start over at the first reference point once the last reference time is reached. This is repeated until the simulation ends.
- annealing-npoints¶
A list with the number of annealing reference/control points used for each temperature group. Use 0 for groups that are not annealed. The number of entries should equal the number of temperature groups.
- annealing-time¶
List of times at the annealing reference/control points for each group. If you are using periodic annealing, the times will be used modulo the last value, i.e. if the values are 0, 5, 10, and 15, the coupling will restart at the 0ps value after 15ps, 30ps, 45ps, etc. The number of entries should equal the sum of the numbers given in
annealing-npoints
.
- annealing-temp¶
List of temperatures at the annealing reference/control points for each group. The number of entries should equal the sum of the numbers given in
annealing-npoints
.
Confused? OK, let’s use an example. Assume you have two temperature
groups, set the group selections to annealing = single periodic
,
the number of points of each group to annealing-npoints = 3 4
, the
times to annealing-time = 0 3 6 0 2 4 6
and finally temperatures
to annealing-temp = 298 280 270 298 320 320 298
. The first group
will be coupled to 298K at 0ps, but the reference temperature will
drop linearly to reach 280K at 3ps, and then linearly between 280K and
270K from 3ps to 6ps. After this is stays constant, at 270K. The
second group is coupled to 298K at 0ps, it increases linearly to 320K
at 2ps, where it stays constant until 4ps. Between 4ps and 6ps it
decreases to 298K, and then it starts over with the same pattern
again, i.e. rising linearly from 298K to 320K between 6ps and
8ps. Check the summary printed by gmx grompp if you are unsure!
Velocity generation¶
- gen-vel¶
- no¶
Do not generate velocities. The velocities are set to zero when there are no velocities in the input structure file.
- yes¶
Generate velocities in gmx grompp according to a Maxwell distribution at temperature
gen-temp
, with random seedgen-seed
. This is only meaningful withintegrator=md
.
- gen-temp¶
(300) [K] temperature for Maxwell distribution
Bonds¶
- constraints¶
Controls which bonds in the topology will be converted to rigid holonomic constraints. Note that typical rigid water models do not have bonds, but rather a specialized
[settles]
directive, so are not affected by this keyword.- none¶
No bonds converted to constraints.
- h-bonds¶
Convert the bonds with H-atoms to constraints.
- all-bonds¶
Convert all bonds to constraints.
- h-angles¶
Convert all bonds to constraints and convert the angles that involve H-atoms to bond-constraints.
- all-angles¶
Convert all bonds to constraints and all angles to bond-constraints.
- constraint-algorithm¶
Chooses which solver satisfies any non-SETTLE holonomic constraints.
- LINCS¶
LINear Constraint Solver. With domain decomposition the parallel version P-LINCS is used. The accuracy in set with
lincs-order
, which sets the number of matrices in the expansion for the matrix inversion. After the matrix inversion correction the algorithm does an iterative correction to compensate for lengthening due to rotation. The number of such iterations can be controlled withlincs-iter
. The root mean square relative constraint deviation is printed to the log file everynstlog
steps. If a bond rotates more thanlincs-warnangle
in one step, a warning will be printed both to the log file and tostderr
. LINCS should not be used with coupled angle constraints.
- SHAKE¶
SHAKE is slightly slower and less stable than LINCS, but does work with angle constraints. The relative tolerance is set with
shake-tol
, 0.0001 is a good value for “normal” MD. SHAKE does not support constraints between atoms on different decomposition domains, so it can only be used with domain decomposition when so-called update-groups are used, which is usally the case when only bonds involving hydrogens are constrained. SHAKE can not be used with energy minimization.
- continuation¶
This option was formerly known as
unconstrained-start
.- no¶
apply constraints to the start configuration and reset shells
- yes¶
do not apply constraints to the start configuration and do not reset shells, useful for exact coninuation and reruns
- shake-tol¶
(0.0001) relative tolerance for SHAKE
- lincs-order¶
(4) Highest order in the expansion of the constraint coupling matrix. When constraints form triangles, an additional expansion of the same order is applied on top of the normal expansion only for the couplings within such triangles. For “normal” MD simulations an order of 4 usually suffices, 6 is needed for large time-steps with virtual sites or BD. For accurate energy minimization in double precision an order of 8 or more might be required. Note that in single precision an order higher than 6 will often lead to worse accuracy due to amplification of rounding errors. With domain decomposition, the cell size is limited by the distance spanned by
lincs-order
+1 constraints. When one wants to scale further than this limit, one can decreaselincs-order
and increaselincs-iter
, since the accuracy does not deteriorate when (1+lincs-iter
)*lincs-order
remains constant.
- lincs-iter¶
(1) Number of iterations to correct for rotational lengthening in LINCS. For normal runs a single step is sufficient, but for NVE runs where you want to conserve energy accurately or for accurate energy minimization in double precision you might want to increase it to 2. Note that in single precision using more than 1 iteration will often lead to worse accuracy due to amplification of rounding errors.
- lincs-warnangle¶
(30) [deg] maximum angle that a bond can rotate before LINCS will complain
Energy group exclusions¶
- energygrp-excl¶
Pairs of energy groups for which all non-bonded interactions are excluded. An example: if you have two energy groups
Protein
andSOL
, specifyingenergygrp-excl = Protein Protein SOL SOL
would give only the non-bonded interactions between the protein and the solvent. This is especially useful for speeding up energy calculations withmdrun -rerun
and for excluding interactions within frozen groups.
Walls¶
- nwall¶
(0) When set to 1 there is a wall at
z=0
, when set to 2 there is also a wall atz=z-box
. Walls can only be used withpbc
=xy
. When set to 2, pressure coupling and Ewald summation can be used (it is usually best to use semiisotropic pressure coupling with thex/y
compressibility set to 0, as otherwise the surface area will change). Walls interact wit the rest of the system through an optionalwall-atomtype
. Energy groupswall0
andwall1
(fornwall
=2) are added automatically to monitor the interaction of energy groups with each wall. The center of mass motion removal will be turned off in thez
-direction.
- wall-atomtype¶
the atom type name in the force field for each wall. By (for example) defining a special wall atom type in the topology with its own combination rules, this allows for independent tuning of the interaction of each atomtype with the walls.
- wall-type¶
- 9-3¶
LJ integrated over the volume behind the wall: 9-3 potential
- 10-4¶
LJ integrated over the wall surface: 10-4 potential
- 12-6¶
direct LJ potential with the
z
distance from the wall
- table¶
user defined potentials indexed with the
z
distance from the wall, the tables are read analogously to theenergygrp-table
option, where the first name is for a “normal” energy group and the second name iswall0
orwall1
, only the dispersion and repulsion columns are used
- wall-r-linpot¶
(-1) [nm] Below this distance from the wall the potential is continued linearly and thus the force is constant. Setting this option to a postive value is especially useful for equilibration when some atoms are beyond a wall. When the value is <=0 (<0 for
wall-type
=table), a fatal error is generated when atoms are beyond a wall.
- wall-density¶
[nm-3] / [nm-2] the number density of the atoms for each wall for wall types 9-3 and 10-4
- wall-ewald-zfac¶
(3) The scaling factor for the third box vector for Ewald summation only, the minimum is 2. Ewald summation can only be used with
nwall
=2, where one should useewald-geometry
=3dc
. The empty layer in the box serves to decrease the unphysical Coulomb interaction between periodic images.
COM pulling¶
Sets whether pulling on collective variables is active.
Note that where pulling coordinates are applicable, there can be more
than one (set with pull-ncoords
) and multiple related mdp
variables will exist accordingly. Documentation references to things
like pull-coord1-vec
should be understood to apply to to the
applicable pulling coordinate, eg. the second pull coordinate is described by
pull-coord2-vec, pull-coord2-k, and so on.
- pull¶
- no¶
No center of mass pulling. All the following pull options will be ignored (and if present in the mdp file, they unfortunately generate warnings)
- yes¶
Center of mass pulling will be applied on 1 or more groups using 1 or more pull coordinates.
- pull-cylinder-r¶
(1.5) [nm] the radius of the cylinder for
pull-coord1-geometry=cylinder
- pull-constr-tol¶
(10-6) the relative constraint tolerance for constraint pulling
- pull-print-com¶
- no¶
do not print the COM for any group
- yes¶
print the COM of all groups for all pull coordinates
- pull-print-ref-value¶
- no¶
do not print the reference value for each pull coordinate
- yes¶
print the reference value for each pull coordinate
- pull-print-components¶
- no¶
only print the distance for each pull coordinate
- yes¶
print the distance and Cartesian components selected in
pull-coord1-dim
- pull-nstxout¶
(50) frequency for writing out the COMs of all the pull group (0 is never)
- pull-nstfout¶
(50) frequency for writing out the force of all the pulled group (0 is never)
- pull-pbc-ref-prev-step-com¶
- no¶
Use the reference atom (
pull-group1-pbcatom
) for the treatment of periodic boundary conditions.
- yes¶
Use the COM of the previous step as reference for the treatment of periodic boundary conditions. The reference is initialized using the reference atom (
pull-group1-pbcatom
), which should be located centrally in the group. Using the COM from the previous step can be useful if one or more pull groups are large.
- pull-xout-average¶
- no¶
Write the instantaneous coordinates for all the pulled groups.
- yes¶
Write the average coordinates (since last output) for all the pulled groups. N.b., some analysis tools might expect instantaneous pull output.
- pull-fout-average¶
- no¶
Write the instantaneous force for all the pulled groups.
- yes¶
Write the average force (since last output) for all the pulled groups. N.b., some analysis tools might expect instantaneous pull output.
- pull-ngroups¶
(1) The number of pull groups, not including the absolute reference group, when used. Pull groups can be reused in multiple pull coordinates. Below only the pull options for group 1 are given, further groups simply increase the group index number.
- pull-ncoords¶
(1) The number of pull coordinates. Below only the pull options for coordinate 1 are given, further coordinates simply increase the coordinate index number.
- pull-group1-name¶
The name of the pull group, is looked up in the index file or in the default groups to obtain the atoms involved.
- pull-group1-weights¶
Optional relative weights which are multiplied with the masses of the atoms to give the total weight for the COM. The number should be 0, meaning all 1, or the number of atoms in the pull group.
- pull-group1-pbcatom¶
(0) The reference atom for the treatment of periodic boundary conditions inside the group (this has no effect on the treatment of the pbc between groups). This option is only important when the diameter of the pull group is larger than half the shortest box vector. For determining the COM, all atoms in the group are put at their periodic image which is closest to
pull-group1-pbcatom
. A value of 0 means that the middle atom (number wise) is used, which is only safe for small groups. gmx grompp checks that the maximum distance from the reference atom (specifically chosen, or not) to the other atoms in the group is not too large. This parameter is not used withpull-coord1-geometry
cylinder. A value of -1 turns on cosine weighting, which is useful for a group of molecules in a periodic system, e.g. a water slab (see Engin et al. J. Chem. Phys. B 2010).
- pull-coord1-type¶
- umbrella¶
Center of mass pulling using an umbrella potential between the reference group and one or more groups.
- constraint¶
Center of mass pulling using a constraint between the reference group and one or more groups. The setup is identical to the option umbrella, except for the fact that a rigid constraint is applied instead of a harmonic potential. Note that this type is not supported in combination with multiple time stepping.
- constant-force¶
Center of mass pulling using a linear potential and therefore a constant force. For this option there is no reference position and therefore the parameters
pull-coord1-init
andpull-coord1-rate
are not used.
- flat-bottom¶
At distances above
pull-coord1-init
a harmonic potential is applied, otherwise no potential is applied.
- flat-bottom-high¶
At distances below
pull-coord1-init
a harmonic potential is applied, otherwise no potential is applied.
- external-potential¶
An external potential that needs to be provided by another module.
- pull-coord1-potential-provider¶
The name of the external module that provides the potential for the case where
pull-coord1-type
is external-potential.
- pull-coord1-geometry¶
- distance¶
Pull along the vector connecting the two groups. Components can be selected with
pull-coord1-dim
.
- direction¶
Pull in the direction of
pull-coord1-vec
.
- direction-periodic¶
As
pull-coord1-geometry=direction
, but does not apply periodic box vector corrections to keep the distance within half the box length. This is (only) useful for pushing groups apart by more than half the box length by continuously changing the reference location using a pull rate. With this geometry the box should not be dynamic (e.g. no pressure scaling) in the pull dimensions and the pull force is not added to the virial.
- direction-relative¶
As
pull-coord1-geometry=direction
, but the pull vector is the vector that points from the COM of a third to the COM of a fourth pull group. This means that 4 groups need to be supplied inpull-coord1-groups
. Note that the pull force will give rise to a torque on the pull vector, which is turn leads to forces perpendicular to the pull vector on the two groups defining the vector. If you want a pull group to move between the two groups defining the vector, simply use the union of these two groups as the reference group.
- cylinder¶
Designed for pulling with respect to a layer where the reference COM is given by a local cylindrical part of the reference group. The pulling is in the direction of
pull-coord1-vec
. From the first of the two groups inpull-coord1-groups
a cylinder is selected around the axis going through the COM of the second group with directionpull-coord1-vec
with radiuspull-cylinder-r
. Weights of the atoms decrease continously to zero as the radial distance goes from 0 topull-cylinder-r
(mass weighting is also used). The radial dependence gives rise to radial forces on both pull groups. Note that the radius should be smaller than half the box size. For tilted cylinders they should be even smaller than half the box size since the distance of an atom in the reference group from the COM of the pull group has both a radial and an axial component. This geometry is not supported with constraint pulling.
- angle¶
Pull along an angle defined by four groups. The angle is defined as the angle between two vectors: the vector connecting the COM of the first group to the COM of the second group and the vector connecting the COM of the third group to the COM of the fourth group.
- angle-axis¶
As
pull-coord1-geometry=angle
but the second vector is given bypull-coord1-vec
. Thus, only the two groups that define the first vector need to be given.
- dihedral¶
Pull along a dihedral angle defined by six groups. These pairwise define three vectors: the vector connecting the COM of group 1 to the COM of group 2, the COM of group 3 to the COM of group 4, and the COM of group 5 to the COM group 6. The dihedral angle is then defined as the angle between two planes: the plane spanned by the the two first vectors and the plane spanned the two last vectors.
- transformation¶
Transforms other pull coordinates using a mathematical expression defined by
pull-coord1-expression
. Pull coordinates of lower indices can be used as variables to this pull coordinate. Thus, pull transformation coordinates should have a higher pull coordinate index than all pull coordinates they transform.
- pull-coord1-expression¶
Mathematical expression to transform pull coordinates of lower indices to a new one. The pull coordinates are referred to as variables in the equation so that pull-coord1’s value becomes ‘x1’, pull-coord2 value becomes ‘x2’ etc. The mathematical expression are evaluated using muParser. Only relevant if
pull-coord1-geometry
is set totransformation
.
- pull-coord1-dx¶
(1e-9) Size of finite difference to use in numerical derivation of the pull coordinate with respect to other pull coordinates. The current implementation uses a simple first order finite difference method to perform derivation so that f’(x) = (f(x+dx)-f(x))/dx Only relevant if
pull-coord1-geometry
is set totransformation
.
- pull-coord1-groups¶
The group indices on which this pull coordinate will operate. The number of group indices required is geometry dependent. The first index can be 0, in which case an absolute reference of
pull-coord1-origin
is used. With an absolute reference the system is no longer translation invariant and one should think about what to do with the center of mass motion.
- pull-coord1-dim¶
(Y Y Y) Selects the dimensions that this pull coordinate acts on and that are printed to the output files when
pull-print-components
=pull-coord1-start=yes
. Withpull-coord1-geometry
=pull-coord1-geometry=distance
, only Cartesian components set to Y contribute to the distance. Thus setting this to Y Y N results in a distance in the x/y plane. With other geometries all dimensions with non-zero entries inpull-coord1-vec
should be set to Y, the values for other dimensions only affect the output.
- pull-coord1-origin¶
(0.0 0.0 0.0) The pull reference position for use with an absolute reference.
- pull-coord1-vec¶
(0.0 0.0 0.0) The pull direction. gmx grompp normalizes the vector.
- pull-coord1-start¶
- no¶
do not modify
pull-coord1-init
- yes¶
add the COM distance of the starting conformation to
pull-coord1-init
- pull-coord1-init¶
(0.0) [nm] or [deg] The reference distance or reference angle at t=0.
- pull-coord1-rate¶
(0) [nm/ps] or [deg/ps] The rate of change of the reference position or reference angle.
- pull-coord1-k¶
(0) [kJ mol-1 nm-2] or [kJ mol-1 nm-1] or [kJ mol-1 rad-2] or [kJ mol-1 rad-1] The force constant. For umbrella pulling this is the harmonic force constant in kJ mol-1 nm-2 (or kJ mol-1 rad-2 for angles). For constant force pulling this is the force constant of the linear potential, and thus the negative (!) of the constant force in kJ mol-1 nm-1 (or kJ mol-1 rad-1 for angles). Note that for angles the force constant is expressed in terms of radians (while
pull-coord1-init
andpull-coord1-rate
are expressed in degrees).
- pull-coord1-kB¶
(pull-k1) [kJ mol-1 nm-2] or [kJ mol-1 nm-1] or [kJ mol-1 rad-2] or [kJ mol-1 rad-1] As
pull-coord1-k
, but for state B. This is only used whenfree-energy
is turned on. The force constant is then (1 - lambda) *pull-coord1-k
+ lambda *pull-coord1-kB
.
AWH adaptive biasing¶
- awh¶
- no¶
No biasing.
- yes¶
Adaptively bias a reaction coordinate using the AWH method and estimate the corresponding PMF. The PMF and other AWH data are written to energy file at an interval set by
awh-nstout
and can be extracted with thegmx awh
tool. The AWH coordinate can be multidimensional and is defined by mapping each dimension to a pull coordinate index. This is only allowed ifpull-coord1-type=external-potential
andpull-coord1-potential-provider
=awh
for the concerned pull coordinate indices. Pull geometry ‘direction-periodic’ is not supported by AWH.
- awh-potential¶
- convolved¶
The applied biasing potential is the convolution of the bias function and a set of harmonic umbrella potentials (see
awh-potential=umbrella
below). This results in a smooth potential function and force. The resolution of the potential is set by the force constant of each umbrella, seeawh1-dim1-force-constant
. This option is not compatible with using the free energy lambda state as an AWH reaction coordinate.
- umbrella¶
The potential bias is applied by controlling the position of an harmonic potential using Monte-Carlo sampling. The force constant is set with
awh1-dim1-force-constant
. The umbrella location is sampled using Monte-Carlo everyawh-nstsample
steps. This is option is required when using the free energy lambda state as an AWH reaction coordinate. Apart from that, this option is mainly for comparison and testing purposes as there are no advantages to using an umbrella.
AWH will not share biases across simulations started with gmx mdrun option
-multidir
. The biases will be independent.
With gmx mdrun and option
-multidir
the bias and PMF estimates for biases withawh1-share-group
>0 will be shared across simulations with the biases with the sameawh1-share-group
value. The simulations should have the same AWH settings for sharing to make sense. gmx mdrun will check whether the simulations are technically compatible for sharing, but the user should check that bias sharing physically makes sense.
- awh-seed¶
(-1) Random seed for Monte-Carlo sampling the umbrella position, where -1 indicates to generate a seed. Only used with
awh-potential=umbrella
.
- awh-nstout¶
(100000) Number of steps between printing AWH data to the energy file, should be a multiple of
nstenergy
.
- awh-nstsample¶
(10) Number of steps between sampling of the coordinate value. This sampling is the basis for updating the bias and estimating the PMF and other AWH observables.
- awh-nsamples-update¶
(10) The number of coordinate samples used for each AWH update. The update interval in steps is
awh-nstsample
times this value.
- awh-nbias¶
(1) The number of biases, each acting on its own coordinate. The following options should be specified for each bias although below only the options for bias number 1 is shown. Options for other bias indices are obtained by replacing ‘1’ by the bias index.
- awh1-error-init¶
(10.0) [kJ mol-1] Estimated initial average error of the PMF for this bias. This value together with the given diffusion constant(s)
awh1-dim1-diffusion
determine the initial biasing rate. The error is obviously not known a priori. Only a rough estimate ofawh1-error-init
is needed however. As a general guideline, leaveawh1-error-init
to its default value when starting a new simulation. On the other hand, when there is a priori knowledge of the PMF (e.g. when an initial PMF estimate is provided, see theawh1-user-data
option) thenawh1-error-init
should reflect that knowledge.
- awh1-growth¶
- exp-linear¶
Each bias keeps a reference weight histogram for the coordinate samples. Its size sets the magnitude of the bias function and free energy estimate updates (few samples corresponds to large updates and vice versa). Thus, its growth rate sets the maximum convergence rate. By default, there is an initial stage in which the histogram grows close to exponentially (but slower than the sampling rate). In the final stage that follows, the growth rate is linear and equal to the sampling rate (set by
awh-nstsample
). The initial stage is typically necessary for efficient convergence when starting a new simulation where high free energy barriers have not yet been flattened by the bias.- linear¶
As
awh1-growth=exp-linear
but skip the initial stage. This may be useful if there is a priori knowledge (seeawh1-error-init
) which eliminates the need for an initial stage. This is also the setting compatible withawh1-target=local-boltzmann
.
- awh1-equilibrate-histogram¶
- no¶
Do not equilibrate histogram.
- yes¶
Before entering the initial stage (see
awh1-growth=exp-linear
), make sure the histogram of sampled weights is following the target distribution closely enough (specifically, at least 80% of the target region needs to have a local relative error of less than 20%). This option would typically only be used whenawh1-share-group
> 0 and the initial configurations poorly represent the target distribution.
- awh1-target¶
- constant¶
The bias is tuned towards a constant (uniform) coordinate distribution in the defined sampling interval (defined by [
awh1-dim1-start
,awh1-dim1-end
]).
- cutoff¶
Similar to
awh1-target=constant
, but the target distribution is proportional to 1/(1 + exp(F -awh1-target=cutoff
)), where F is the free energy relative to the estimated global minimum. This provides a smooth switch of a flat target distribution in regions with free energy lower than the cut-off to a Boltzmann distribution in regions with free energy higher than the cut-off.
- boltzmann¶
The target distribution is a Boltzmann distribtution with a scaled beta (inverse temperature) factor given by
awh1-target-beta-scaling
. E.g., a value of 0.1 would give the same coordinate distribution as sampling with a simulation temperature scaled by 10.
- local-boltzmann¶
Same target distribution and use of
awh1-target-beta-scaling
but the convergence towards the target distribution is inherently local i.e., the rate of change of the bias only depends on the local sampling. This local convergence property is only compatible withawh1-growth=linear
, since forawh1-growth=exp-linear
histograms are globally rescaled in the initial stage.
- awh1-target-beta-scaling¶
(0) For
awh1-target=boltzmann
andawh1-target=local-boltzmann
it is the unitless beta scaling factor taking values in (0,1).
- awh1-target-cutoff¶
(0) [kJ mol-1] For
awh1-target=cutoff
this is the cutoff, should be > 0.
- awh1-user-data¶
- no¶
Initialize the PMF and target distribution with default values.
- yes¶
Initialize the PMF and target distribution with user provided data. For
awh-nbias
= 1, gmx mdrun will expect a fileawhinit.xvg
to be present in the run directory. For multiple biases, gmx mdrun expects filesawhinit1.xvg
,awhinit2.xvg
, etc. The file name can be changed with the-awh
option. The firstawh1-ndim
columns of each input file should contain the coordinate values, such that each row defines a point in coordinate space. Columnawh1-ndim
+ 1 should contain the PMF value (in kT) for each point. The target distribution column can either follow the PMF (columnawh1-ndim
+ 2) or be in the same column as written by gmx awh.
Do not share the bias.
Share the bias and PMF estimates between simulations. This currently only works between biases with the same index. Note that currently sharing within a single simulation is not supported. The bias will be shared across simulations that specify the same value for
awh1-share-group
. To enable this, useawh-share-multisim=yes
and the gmx mdrun option-multidir
. Sharing may increase convergence initially, although the starting configurations can be critical, especially when sharing between many biases.
- awh1-ndim¶
(1) [integer] Number of dimensions of the coordinate, each dimension maps to 1 pull coordinate. The following options should be specified for each such dimension. Below only the options for dimension number 1 is shown. Options for other dimension indices are obtained by replacing ‘1’ by the dimension index.
- awh1-dim1-coord-provider¶
- pull¶
The pull module is providing the reaction coordinate for this dimension. With multiple time-stepping, AWH and pull should be in the same MTS level.
- fep-lambda¶
The free energy lambda state is the reaction coordinate for this dimension. The lambda states to use are specified by
fep-lambdas
,vdw-lambdas
,coul-lambdas
etc. This is not compatible with delta-lambda. It also requires calc-lambda-neighbors to be -1. With multiple time-stepping, AWH should be in the slow level. This option requiresawh-potential=umbrella
.
- awh1-dim1-coord-index¶
(1) Index of the pull coordinate defining this coordinate dimension.
- awh1-dim1-force-constant¶
(0) [kJ mol-1 nm-2] or [kJ mol-1 rad-2] Force constant for the (convolved) umbrella potential(s) along this coordinate dimension.
- awh1-dim1-start¶
(0.0) [nm] or [deg] Start value of the sampling interval along this dimension. The range of allowed values depends on the relevant pull geometry (see
pull-coord1-geometry
). For dihedral geometriesawh1-dim1-start
greater thanawh1-dim1-end
is allowed. The interval will then wrap around from +period/2 to -period/2. For the direction geometry, the dimension is made periodic when the direction is along a box vector and covers more than 95% of the box length. Note that one should not apply pressure coupling along a periodic dimension.
- awh1-dim1-end¶
(0.0) [nm] or [deg] End value defining the sampling interval together with
awh1-dim1-start
.
- awh1-dim1-diffusion¶
(10-5) [nm2/ps], [rad2/ps] or [ps-1] Estimated diffusion constant for this coordinate dimension determining the initial biasing rate. This needs only be a rough estimate and should not critically affect the results unless it is set to something very low, leading to slow convergence, or very high, forcing the system far from equilibrium. Not setting this value explicitly generates a warning.
- awh1-dim1-cover-diameter¶
(0.0) [nm] or [deg] Diameter that needs to be sampled by a single simulation around a coordinate value before the point is considered covered in the initial stage (see
awh1-growth=exp-linear
). A value > 0 ensures that for each covering there is a continuous transition of this diameter across each coordinate value. This is trivially true for independent simulations but not for for multiple bias-sharing simulations (awh1-share-group
>0). For a diameter = 0, covering occurs as soon as the simulations have sampled the whole interval, which for many sharing simulations does not guarantee transitions across free energy barriers. On the other hand, when the diameter >= the sampling interval length, covering occurs when a single simulation has independently sampled the whole interval.
Enforced rotation¶
These mdp parameters can be used enforce the rotation of a group of atoms, e.g. a protein subunit. The reference manual describes in detail 13 different potentials that can be used to achieve such a rotation.
- rotation¶
- no¶
No enforced rotation will be applied. All enforced rotation options will be ignored (and if present in the mdp file, they unfortunately generate warnings).
- yes¶
Apply the rotation potential specified by
rot-type0
to the group of atoms given under therot-group0
option.
- rot-ngroups¶
(1) Number of rotation groups.
- rot-group0¶
Name of rotation group 0 in the index file.
- rot-type0¶
(iso) Type of rotation potential that is applied to rotation group 0. Can be of of the following:
iso
,iso-pf
,pm
,pm-pf
,rm
,rm-pf
,rm2
,rm2-pf
,flex
,flex-t
,flex2
, orflex2-t
.
- rot-massw0¶
(no) Use mass weighted rotation group positions.
- rot-vec0¶
(1.0 0.0 0.0) Rotation vector, will get normalized.
- rot-pivot0¶
(0.0 0.0 0.0) [nm] Pivot point for the potentials
iso
,pm
,rm
, andrm2
.
- rot-rate0¶
(0) [degree ps-1] Reference rotation rate of group 0.
- rot-k0¶
(0) [kJ mol-1 nm-2] Force constant for group 0.
- rot-slab-dist0¶
(1.5) [nm] Slab distance, if a flexible axis rotation type was chosen.
- rot-min-gauss0¶
(0.001) Minimum value (cutoff) of Gaussian function for the force to be evaluated (for the flexible axis potentials).
- rot-eps0¶
(0.0001) [nm2] Value of additive constant epsilon for
rm2*
andflex2*
potentials.
- rot-fit-method0¶
(rmsd) Fitting method when determining the actual angle of a rotation group (can be one of
rmsd
,norm
, orpotential
).
- rot-potfit-nsteps0¶
(21) For fit type
potential
, the number of angular positions around the reference angle for which the rotation potential is evaluated.
- rot-potfit-step0¶
(0.25) For fit type
potential
, the distance in degrees between two angular positions.
- rot-nstrout¶
(100) Output frequency (in steps) for the angle of the rotation group, as well as for the torque and the rotation potential energy.
- rot-nstsout¶
(1000) Output frequency for per-slab data of the flexible axis potentials, i.e. angles, torques and slab centers.
NMR refinement¶
- disre¶
- no¶
ignore distance restraint information in topology file
- simple¶
simple (per-molecule) distance restraints.
- ensemble¶
distance restraints over an ensemble of molecules in one simulation box. Normally, one would perform ensemble averaging over multiple simulations, using
mdrun -multidir
. The environment variableGMX_DISRE_ENSEMBLE_SIZE
sets the number of systems within each ensemble (usually equal to the number of directories supplied tomdrun -multidir
).
- disre-mixed¶
- no¶
the violation used in the calculation of the restraint force is the time-averaged violation
- yes¶
the violation used in the calculation of the restraint force is the square root of the product of the time-averaged violation and the instantaneous violation
- disre-fc¶
(1000) [kJ mol-1 nm-2] force constant for distance restraints, which is multiplied by a (possibly) different factor for each restraint given in the
fac
column of the interaction in the topology file.
- disre-tau¶
(0) [ps] time constant for distance restraints running average. A value of zero turns off time averaging.
- nstdisreout¶
(100) [steps] period between steps when the running time-averaged and instantaneous distances of all atom pairs involved in restraints are written to the energy file (can make the energy file very large)
- orire¶
- no¶
ignore orientation restraint information in topology file
- yes¶
use orientation restraints, ensemble averaging can be performed with
mdrun -multidir
- orire-fc¶
(0) [kJ mol-1] force constant for orientation restraints, which is multiplied by a (possibly) different weight factor for each restraint, can be set to zero to obtain the orientations from a free simulation
- orire-tau¶
(0) [ps] time constant for orientation restraints running average. A value of zero turns off time averaging.
- orire-fitgrp¶
fit group for orientation restraining. This group of atoms is used to determine the rotation R of the system with respect to the reference orientation. The reference orientation is the starting conformation of the first subsystem. For a protein, backbone is a reasonable choice
- nstorireout¶
(100) [steps] period between steps when the running time-averaged and instantaneous orientations for all restraints, and the molecular order tensor are written to the energy file (can make the energy file very large)
Free energy calculations¶
- free-energy¶
- no¶
Only use topology A.
- yes¶
Interpolate between topology A (lambda=0) to topology B (lambda=1) and write the derivative of the Hamiltonian with respect to lambda (as specified with
dhdl-derivatives
), or the Hamiltonian differences with respect to other lambda values (as specified with foreign lambda) to the energy file and/or todhdl.xvg
, where they can be processed by, for example gmx bar. The potentials, bond-lengths and angles are interpolated linearly as described in the manual. Whensc-alpha
is larger than zero, soft-core potentials are used for the LJ and Coulomb interactions.
- expanded¶
Turns on expanded ensemble simulation, where the alchemical state becomes a dynamic variable, allowing jumping between different Hamiltonians. See the expanded ensemble options for controlling how expanded ensemble simulations are performed. The different Hamiltonians used in expanded ensemble simulations are defined by the other free energy options.
- init-lambda¶
(-1) starting value for lambda (float). Generally, this should only be used with slow growth (i.e. nonzero
delta-lambda
). In other cases,init-lambda-state
should be specified instead. If a lambda vector is given, :mdp:init-lambda
is used to interpolate the vector instead of setting lambda directly. Must be greater than or equal to 0.
- delta-lambda¶
(0) increment per time step for lambda
- init-lambda-state¶
(-1) starting value for the lambda state (integer). Specifies which columm of the lambda vector (
coul-lambdas
,vdw-lambdas
,bonded-lambdas
,restraint-lambdas
,mass-lambdas
,temperature-lambdas
,fep-lambdas
) should be used. This is a zero-based index:init-lambda-state
0 means the first column, and so on.
- fep-lambdas¶
[array] Zero, one or more lambda values for which Delta H values will be determined and written to dhdl.xvg every
nstdhdl
steps. Values must be greater than or equal to 0; values greater than 1 are allowed but should be used carefully. Free energy differences between different lambda values can then be determined with gmx bar.fep-lambdas
is different from the other -lambdas keywords because all components of the lambda vector that are not specified will usefep-lambdas
(includingrestraint-lambdas
and therefore the pull code restraints).
- coul-lambdas¶
[array] Zero, one or more lambda values for which Delta H values will be determined and written to dhdl.xvg every
nstdhdl
steps. Values must be greater than or equal to 0; values greater than 1 are allowed but should be used carefully. If soft-core potentials are used, values must be between 0 and 1. Only the electrostatic interactions are controlled with this component of the lambda vector (and only if the lambda=0 and lambda=1 states have differing electrostatic interactions).
- vdw-lambdas¶
[array] Zero, one or more lambda values for which Delta H values will be determined and written to dhdl.xvg every
nstdhdl
steps. Values must be greater than or equal to 0; values greater than 1 are allowed but should be used carefully. If soft-core potentials are used, values must be between 0 and 1. Only the van der Waals interactions are controlled with this component of the lambda vector.
- bonded-lambdas¶
[array] Zero, one or more lambda values for which Delta H values will be determined and written to dhdl.xvg every
nstdhdl
steps. Values must be greater than or equal to 0; values greater than 1 are allowed but should be used carefully. Only the bonded interactions are controlled with this component of the lambda vector.
- restraint-lambdas¶
[array] Zero, one or more lambda values for which Delta H values will be determined and written to dhdl.xvg every
nstdhdl
steps. Values must be greater than or equal to 0; values greater than 1 are allowed but should be used carefully. Only the restraint interactions: dihedral restraints, and the pull code restraints are controlled with this component of the lambda vector.
- mass-lambdas¶
[array] Zero, one or more lambda values for which Delta H values will be determined and written to dhdl.xvg every
nstdhdl
steps. Values must be greater than or equal to 0; values greater than 1 are allowed but should be used carefully. Only the particle masses are controlled with this component of the lambda vector.
- temperature-lambdas¶
[array] Zero, one or more lambda values for which Delta H values will be determined and written to dhdl.xvg every
nstdhdl
steps. Values must be greater than or equal to 0; values greater than 1 are allowed but should be used carefully. Only the temperatures are controlled with this component of the lambda vector. Note that these lambdas should not be used for replica exchange, only for simulated tempering.
- calc-lambda-neighbors¶
(1) Controls the number of lambda values for which Delta H values will be calculated and written out, if
init-lambda-state
has been set. A positive value will limit the number of lambda points calculated to only the nth neighbors ofinit-lambda-state
: for example, ifinit-lambda-state
is 5 and this parameter has a value of 2, energies for lambda points 3-7 will be calculated and writen out. A value of -1 means all lambda points will be written out. For normal BAR such as with gmx bar, a value of 1 is sufficient, while for MBAR -1 should be used.
- sc-function¶
(beutler)
- beutler¶
Beutler et al. soft-core function
- gapsys¶
Gapsys et al. soft-core function
- sc-alpha¶
(0) for
sc-function=beutler
the soft-core alpha parameter, a value of 0 results in linear interpolation of the LJ and Coulomb interactions. Used only withsc-function=beutler
- sc-r-power¶
(6) power 6 for the radial term in the soft-core equation. Used only with
sc-function=beutler
- sc-coul¶
(no) Whether to apply the soft-core free energy interaction transformation to the Columbic interaction of a molecule. Default is no, as it is generally more efficient to turn off the Coulomic interactions linearly before turning off the van der Waals interactions. Note that it is only taken into account when lambda states are used, not with
couple-lambda0
/couple-lambda1
, and you can still turn off soft-core interactions by settingsc-alpha
to 0. Used only withsc-function=beutler
- sc-power¶
(1) the power for lambda in the soft-core function, only the values 1 and 2 are supported. Used only with
sc-function=beutler
- sc-sigma¶
(0.3) [nm] for
sc-function=beutler
the soft-core sigma for particles which have a C6 or C12 parameter equal to zero or a sigma smaller thansc-sigma
. Used only withsc-function=beutler
- sc-gapsys-scale-linpoint-lj¶
(0.85) for
sc-function=gapsys
it is the unitless alphaLJ parameter. It controls the softness of the van der Waals interactions by scaling the point for linearizing the vdw force. Setting it to 0 will result in the standard hard-core van der Waals interactions. Used only withsc-function=gapsys
- sc-gapsys-scale-linpoint-q¶
(0.3) [nm/e^2] For
sc-function=gapsys
the alphaQ parameter with the unit of [nm/e^2] and default value of 0.3. It controls the softness of the Coulombic interactions. Setting it to 0 will result in the standard hard-core Coulombic interactions. Used only withsc-function=gapsys
- sc-gapsys-sigma-lj¶
(0.3) [nm] for
sc-function=gapsys
the soft-core sigma for particles which have a C6 or C12 parameter equal to zero. Used only withsc-function=gapsys
- couple-moltype¶
Here one can supply a molecule type (as defined in the topology) for calculating solvation or coupling free energies. There is a special option
system
that couples all molecule types in the system. This can be useful for equilibrating a system starting from (nearly) random coordinates.free-energy
has to be turned on. The Van der Waals interactions and/or charges in this molecule type can be turned on or off between lambda=0 and lambda=1, depending on the settings ofcouple-lambda0
andcouple-lambda1
. If you want to decouple one of several copies of a molecule, you need to copy and rename the molecule definition in the topology.
- couple-lambda0¶
- vdw-q¶
all interactions are on at lambda=0
- vdw¶
the charges are zero (no Coulomb interactions) at lambda=0
- q¶
the Van der Waals interactions are turned at lambda=0; soft-core interactions will be required to avoid singularities
- none¶
the Van der Waals interactions are turned off and the charges are zero at lambda=0; soft-core interactions will be required to avoid singularities.
- couple-lambda1¶
analogous to
couple-lambda1
, but for lambda=1
- couple-intramol¶
- no¶
All intra-molecular non-bonded interactions for moleculetype
couple-moltype
are replaced by exclusions and explicit pair interactions. In this manner the decoupled state of the molecule corresponds to the proper vacuum state without periodicity effects.
- yes¶
The intra-molecular Van der Waals and Coulomb interactions are also turned on/off. This can be useful for partitioning free-energies of relatively large molecules, where the intra-molecular non-bonded interactions might lead to kinetically trapped vacuum conformations. The 1-4 pair interactions are not turned off.
- nstdhdl¶
(100) the frequency for writing dH/dlambda and possibly Delta H to dhdl.xvg, 0 means no ouput, should be a multiple of
nstcalcenergy
.
- dhdl-derivatives¶
(yes)
If yes (the default), the derivatives of the Hamiltonian with respect to lambda at each
nstdhdl
step are written out. These values are needed for interpolation of linear energy differences with gmx bar (although the same can also be achieved with the right foreign lambda setting, that may not be as flexible), or with thermodynamic integration
- dhdl-print-energy¶
(no)
Include either the total or the potential energy in the dhdl file. Options are ‘no’, ‘potential’, or ‘total’. This information is needed for later free energy analysis if the states of interest are at different temperatures. If all states are at the same temperature, this information is not needed. ‘potential’ is useful in case one is using
mdrun -rerun
to generate thedhdl.xvg
file. When rerunning from an existing trajectory, the kinetic energy will often not be correct, and thus one must compute the residual free energy from the potential alone, with the kinetic energy component computed analytically.
- separate-dhdl-file¶
- yes¶
The free energy values that are calculated (as specified with the foreign lambda and
dhdl-derivatives
settings) are written out to a separate file, with the default namedhdl.xvg
. This file can be used directly with gmx bar.
- no¶
The free energy values are written out to the energy output file (
ener.edr
, in accumulated blocks at everynstenergy
steps), where they can be extracted with gmx energy or used directly with gmx bar.
- dh-hist-size¶
(0) If nonzero, specifies the size of the histogram into which the Delta H values (specified with foreign lambda) and the derivative dH/dl values are binned, and written to ener.edr. This can be used to save disk space while calculating free energy differences. One histogram gets written for each foreign lambda and two for the dH/dl, at every
nstenergy
step. Be aware that incorrect histogram settings (too small size or too wide bins) can introduce errors. Do not use histograms unless you’re certain you need it.
- dh-hist-spacing¶
(0.1) Specifies the bin width of the histograms, in energy units. Used in conjunction with
dh-hist-size
. This size limits the accuracy with which free energies can be calculated. Do not use histograms unless you’re certain you need it.
Expanded Ensemble calculations¶
- nstexpanded¶
The number of integration steps beween attempted moves changing the system Hamiltonian in expanded ensemble simulations. Must be a multiple of
nstcalcenergy
, but can be greater or less thannstdhdl
.
- lmc-stats¶
- no¶
No Monte Carlo in state space is performed.
- metropolis-transition¶
Uses the Metropolis weights to update the expanded ensemble weight of each state. Min{1,exp(-(beta_new u_new - beta_old u_old)}
- barker-transition¶
Uses the Barker transition critera to update the expanded ensemble weight of each state i, defined by exp(-beta_new u_new)/(exp(-beta_new u_new)+exp(-beta_old u_old))
- wang-landau¶
Uses the Wang-Landau algorithm (in state space, not energy space) to update the expanded ensemble weights.
- min-variance¶
Uses the minimum variance updating method of Escobedo et al. to update the expanded ensemble weights. Weights will not be the free energies, but will rather emphasize states that need more sampling to give even uncertainty.
- lmc-mc-move¶
- no¶
No Monte Carlo in state space is performed.
- metropolis-transition¶
Randomly chooses a new state up or down, then uses the Metropolis critera to decide whether to accept or reject: Min{1,exp(-(beta_new u_new - beta_old u_old)}
- barker-transition¶
Randomly chooses a new state up or down, then uses the Barker transition critera to decide whether to accept or reject: exp(-beta_new u_new)/(exp(-beta_new u_new)+exp(-beta_old u_old))
- gibbs¶
Uses the conditional weights of the state given the coordinate (exp(-beta_i u_i) / sum_k exp(beta_i u_i) to decide which state to move to.
- metropolized-gibbs¶
Uses the conditional weights of the state given the coordinate (exp(-beta_i u_i) / sum_k exp(beta_i u_i) to decide which state to move to, EXCLUDING the current state, then uses a rejection step to ensure detailed balance. Always more efficient that Gibbs, though only marginally so in many situations, such as when only the nearest neighbors have decent phase space overlap.
- lmc-seed¶
(-1) random seed to use for Monte Carlo moves in state space. When
lmc-seed
is set to -1, a pseudo random seed is us
- mc-temperature¶
Temperature used for acceptance/rejection for Monte Carlo moves. If not specified, the temperature of the simulation specified in the first group of
ref-t
is used.
- wl-ratio¶
(0.8) The cutoff for the histogram of state occupancies to be reset, and the free energy incrementor to be changed from delta to delta *
wl-scale
. If we define the Nratio = (number of samples at each histogram) / (average number of samples at each histogram).wl-ratio
of 0.8 means that means that the histogram is only considered flat if all Nratio > 0.8 AND simultaneously all 1/Nratio > 0.8.
- wl-scale¶
(0.8) Each time the histogram is considered flat, then the current value of the Wang-Landau incrementor for the free energies is multiplied by
wl-scale
. Value must be between 0 and 1.
- init-wl-delta¶
(1.0) The initial value of the Wang-Landau incrementor in kT. Some value near 1 kT is usually most efficient, though sometimes a value of 2-3 in units of kT works better if the free energy differences are large.
- wl-oneovert¶
(no) Set Wang-Landau incrementor to scale with 1/(simulation time) in the large sample limit. There is significant evidence that the standard Wang-Landau algorithms in state space presented here result in free energies getting ‘burned in’ to incorrect values that depend on the initial state. when
wl-oneovert
is true, then when the incrementor becomes less than 1/N, where N is the mumber of samples collected (and thus proportional to the data collection time, hence ‘1 over t’), then the Wang-Lambda incrementor is set to 1/N, decreasing every step. Once this occurs,wl-ratio
is ignored, but the weights will still stop updating when the equilibration criteria set inlmc-weights-equil
is achieved.
- lmc-repeats¶
(1) Controls the number of times that each Monte Carlo swap type is performed each iteration. In the limit of large numbers of Monte Carlo repeats, then all methods converge to Gibbs sampling. The value will generally not need to be different from 1.
- lmc-gibbsdelta¶
(-1) Limit Gibbs sampling to selected numbers of neighboring states. For Gibbs sampling, it is sometimes inefficient to perform Gibbs sampling over all of the states that are defined. A positive value of
lmc-gibbsdelta
means that only states plus or minuslmc-gibbsdelta
are considered in exchanges up and down. A value of -1 means that all states are considered. For less than 100 states, it is probably not that expensive to include all states.
- lmc-forced-nstart¶
(0) Force initial state space sampling to generate weights. In order to come up with reasonable initial weights, this setting allows the simulation to drive from the initial to the final lambda state, with
lmc-forced-nstart
steps at each state before moving on to the next lambda state. Iflmc-forced-nstart
is sufficiently long (thousands of steps, perhaps), then the weights will be close to correct. However, in most cases, it is probably better to simply run the standard weight equilibration algorithms.
- nst-transition-matrix¶
(-1) Frequency of outputting the expanded ensemble transition matrix. A negative number means it will only be printed at the end of the simulation.
- symmetrized-transition-matrix¶
(no) Whether to symmetrize the empirical transition matrix. In the infinite limit the matrix will be symmetric, but will diverge with statistical noise for short timescales. Forced symmetrization, by using the matrix T_sym = 1/2 (T + transpose(T)), removes problems like the existence of (small magnitude) negative eigenvalues.
- mininum-var-min¶
(100) The min-variance strategy (option of
lmc-stats
is only valid for larger number of samples, and can get stuck if too few samples are used at each state.mininum-var-min
is the minimum number of samples that each state that are allowed before the min-variance strategy is activated if selected.
- init-lambda-weights¶
The initial weights (free energies) used for the expanded ensemble states. Default is a vector of zero weights. format is similar to the lambda vector settings in
fep-lambdas
, except the weights can be any floating point number. Units are kT. Its length must match the lambda vector lengths.
- lmc-weights-equil¶
- no¶
Expanded ensemble weights continue to be updated throughout the simulation.
- yes¶
The input expanded ensemble weights are treated as equilibrated, and are not updated throughout the simulation.
- wl-delta¶
Expanded ensemble weight updating is stopped when the Wang-Landau incrementor falls below this value.
- number-all-lambda¶
Expanded ensemble weight updating is stopped when the number of samples at all of the lambda states is greater than this value.
- number-steps¶
Expanded ensemble weight updating is stopped when the number of steps is greater than the level specified by this value.
- number-samples¶
Expanded ensemble weight updating is stopped when the number of total samples across all lambda states is greater than the level specified by this value.
- count-ratio¶
Expanded ensemble weight updating is stopped when the ratio of samples at the least sampled lambda state and most sampled lambda state greater than this value.
- simulated-tempering¶
(no) Turn simulated tempering on or off. Simulated tempering is implemented as expanded ensemble sampling with different temperatures instead of different Hamiltonians.
- sim-temp-low¶
(300) [K] Low temperature for simulated tempering.
- sim-temp-high¶
(300) [K] High temperature for simulated tempering.
- simulated-tempering-scaling¶
Controls the way that the temperatures at intermediate lambdas are calculated from the
temperature-lambdas
part of the lambda vector.- linear¶
Linearly interpolates the temperatures using the values of
temperature-lambdas
, i.e. ifsim-temp-low
=300,sim-temp-high
=400, then lambda=0.5 correspond to a temperature of 350. A nonlinear set of temperatures can always be implemented with uneven spacing in lambda.
- geometric¶
Interpolates temperatures geometrically between
sim-temp-low
andsim-temp-high
. The i:th state has temperaturesim-temp-low
* (sim-temp-high
/sim-temp-low
) raised to the power of (i/(ntemps-1)). This should give roughly equal exchange for constant heat capacity, though of course things simulations that involve protein folding have very high heat capacity peaks.
- exponential¶
Interpolates temperatures exponentially between
sim-temp-low
andsim-temp-high
. The i:th state has temperaturesim-temp-low
+ (sim-temp-high
-sim-temp-low
)*((exp(temperature-lambdas
(i))-1)/(exp(1.0)-i)).
Non-equilibrium MD¶
- acc-grps¶
groups for constant acceleration (e.g.
Protein Sol
) all atoms in groups Protein and Sol will experience constant acceleration as specified in theaccelerate
line. Note that the kinetic energy of the center of mass of accelarated groups contributes to the kinetic energy and temperature of the system. If this is not desired, make each accelerate group also a separate temperature coupling group.
- accelerate¶
(0) [nm ps-2] acceleration for
acc-grps
; x, y and z for each group (e.g.0.1 0.0 0.0 -0.1 0.0 0.0
means that first group has constant acceleration of 0.1 nm ps-2 in X direction, second group the opposite).
- freezegrps¶
Groups that are to be frozen (i.e. their X, Y, and/or Z position will not be updated; e.g.
Lipid SOL
).freezedim
specifies for which dimension(s) the freezing applies. To avoid spurious contributions to the virial and pressure due to large forces between completely frozen atoms you need to use energy group exclusions, this also saves computing time. Note that coordinates of frozen atoms are not scaled by pressure-coupling algorithms.
- freezedim¶
dimensions for which groups in
freezegrps
should be frozen, specifyY
orN
for X, Y and Z and for each group (e.g.Y Y N N N N
means that particles in the first group can move only in Z direction. The particles in the second group can move in any direction).
- cos-acceleration¶
(0) [nm ps-2] the amplitude of the acceleration profile for calculating the viscosity. The acceleration is in the X-direction and the magnitude is
cos-acceleration
cos(2 pi z/boxheight). Two terms are added to the energy file: the amplitude of the velocity profile and 1/viscosity.
- deform¶
(0 0 0 0 0 0) [nm ps-1] The velocities of deformation for the box elements: a(x) b(y) c(z) b(x) c(x) c(y). Each step the box elements for which
deform
is non-zero are calculated as: box(ts)+(t-ts)*deform, off-diagonal elements are corrected for periodicity. The coordinates are transformed accordingly. Frozen degrees of freedom are (purposely) also transformed. The time ts is set to t at the first step and at steps at which x and v are written to trajectory to ensure exact restarts. Deformation can be used together with semiisotropic or anisotropic pressure coupling when the appropriate compressibilities are set to zero. The diagonal elements can be used to strain a solid. The off-diagonal elements can be used to shear a solid or a liquid.
Electric fields¶
- electric-field-x¶
- electric-field-y¶
- electric-field-z¶
Here you can specify an electric field that optionally can be alternating and pulsed. The general expression for the field has the form of a gaussian laser pulse:
\[E(t) = E_0 \exp\left[-\frac{(t-t_0)^2}{2\sigma^2}\right]\cos\left[\omega (t-t_0)\right]\]For example, the four parameters for direction x are set in the fields of
electric-field-x
(and similar forelectric-field-y
andelectric-field-z
) likeelectric-field-x = E0 omega t0 sigma
with units (respectively) V nm-1, ps-1, ps, ps.
In the special case that
sigma = 0
, the exponential term is omitted and only the cosine term is used. In this case,t0
must be set to 0. If alsoomega = 0
a static electric field is applied.Read more at Electric fields and in ref. 146.
Mixed quantum/classical molecular dynamics¶
- QMMM-grps¶
groups to be descibed at the QM level for MiMiC QM/MM
Computational Electrophysiology¶
Use these options to switch on and control ion/water position exchanges in “Computational Electrophysiology” simulation setups. (See the reference manual for details).
- swapcoords¶
- no¶
Do not enable ion/water position exchanges.
- X ; Y ; Z¶
Allow for ion/water position exchanges along the chosen direction. In a typical setup with the membranes parallel to the x-y plane, ion/water pairs need to be exchanged in Z direction to sustain the requested ion concentrations in the compartments.
- swap-frequency¶
(1) The swap attempt frequency, i.e. every how many time steps the ion counts per compartment are determined and exchanges made if necessary. Normally it is not necessary to check at every time step. For typical Computational Electrophysiology setups, a value of about 100 is sufficient and yields a negligible performance impact.
- split-group0¶
Name of the index group of the membrane-embedded part of channel #0. The center of mass of these atoms defines one of the compartment boundaries and should be chosen such that it is near the center of the membrane.
- split-group1¶
Channel #1 defines the position of the other compartment boundary.
- massw-split0¶
(no) Defines whether or not mass-weighting is used to calculate the split group center.
- no¶
Use the geometrical center.
- yes¶
Use the center of mass.
- massw-split1¶
(no) As above, but for split-group #1.
- solvent-group¶
Name of the index group of solvent molecules.
- coupl-steps¶
(10) Average the number of ions per compartment over these many swap attempt steps. This can be used to prevent that ions near a compartment boundary (diffusing through a channel, e.g.) lead to unwanted back and forth swaps.
- iontypes¶
(1) The number of different ion types to be controlled. These are during the simulation exchanged with solvent molecules to reach the desired reference numbers.
- iontype0-name¶
Name of the first ion type.
- iontype0-in-A¶
(-1) Requested (=reference) number of ions of type 0 in compartment A. The default value of -1 means: use the number of ions as found in time step 0 as reference value.
- iontype0-in-B¶
(-1) Reference number of ions of type 0 for compartment B.
- bulk-offsetA¶
(0.0) Offset of the first swap layer from the compartment A midplane. By default (i.e. bulk offset = 0.0), ion/water exchanges happen between layers at maximum distance (= bulk concentration) to the split group layers. However, an offset b (-1.0 < b < +1.0) can be specified to offset the bulk layer from the middle at 0.0 towards one of the compartment-partitioning layers (at +/- 1.0).
- bulk-offsetB¶
(0.0) Offset of the other swap layer from the compartment B midplane.
- threshold¶
(1) Only swap ions if threshold difference to requested count is reached.
- cyl0-r¶
(2.0) [nm] Radius of the split cylinder #0. Two split cylinders (mimicking the channel pores) can optionally be defined relative to the center of the split group. With the help of these cylinders it can be counted which ions have passed which channel. The split cylinder definition has no impact on whether or not ion/water swaps are done.
- cyl0-up¶
(1.0) [nm] Upper extension of the split cylinder #0.
- cyl0-down¶
(1.0) [nm] Lower extension of the split cylinder #0.
- cyl1-r¶
(2.0) [nm] Radius of the split cylinder #1.
- cyl1-up¶
(1.0) [nm] Upper extension of the split cylinder #1.
- cyl1-down¶
(1.0) [nm] Lower extension of the split cylinder #1.
Density-guided simulations¶
These options enable and control the calculation and application of additional forces that are derived from three-dimensional densities, e.g., from cryo electron-microscopy experiments. (See the reference manual for details)
- density-guided-simulation-active¶
(no) Activate density-guided simulations.
- density-guided-simulation-group¶
(protein) The atoms that are subject to the forces from the density-guided simulation and contribute to the simulated density.
- density-guided-simulation-similarity-measure¶
(inner-product) Similarity measure between the density that is calculated from the atom positions and the reference density.
- inner-product¶
Takes the sum of the product of reference density and simulated density voxel values.
- relative-entropy¶
Uses the negative relative entropy (or Kullback-Leibler divergence) between reference density and simulated density as similarity measure. Negative density values are ignored.
- cross-correlation¶
Uses the Pearson correlation coefficient between reference density and simulated density as similarity measure.
- density-guided-simulation-atom-spreading-weight¶
(unity) Determines the multiplication factor for the Gaussian kernel when spreading atoms on the grid.
- unity¶
Every atom in the density fitting group is assigned the same unit factor.
- mass¶
Atoms contribute to the simulated density proportional to their mass.
- charge¶
Atoms contribute to the simulated density proportional to their charge.
- density-guided-simulation-force-constant¶
(1e+09) [kJ mol-1] The scaling factor for density-guided simulation forces. May also be negative.
- density-guided-simulation-gaussian-transform-spreading-width¶
(0.2) [nm] The Gaussian RMS width for the spread kernel for the simulated density.
- density-guided-simulation-gaussian-transform-spreading-range-in-multiples-of-width¶
(4) The range after which the gaussian is cut off in multiples of the Gaussian RMS width described above.
- density-guided-simulation-reference-density-filename¶
(reference.mrc) Reference density file name using an absolute path or a path relative to the to the folder from which gmx mdrun is called.
- density-guided-simulation-nst¶
(1) Interval in steps at which the density fitting forces are evaluated and applied. The forces are scaled by this number when applied (See the reference manual for details).
- density-guided-simulation-normalize-densities¶
(true) Normalize the sum of density voxel values to one for the reference density as well as the simulated density.
- density-guided-simulation-adaptive-force-scaling¶
(false) Adapt the force constant to ensure a steady increase in similarity between simulated and reference density.
- true¶
Use adaptive force scaling.
- density-guided-simulation-adaptive-force-scaling-time-constant¶
(4) [ps] Couple force constant to increase in similarity with reference density with this time constant. Larger times result in looser coupling.
- density-guided-simulation-shift-vector¶
(0,0,0) [nm] Add this vector to all atoms in the density-guided-simulation-group before calculating forces and energies for density-guided-simulations. Affects only the density-guided-simulation forces and energies. Corresponds to a shift of the input density in the opposite direction by (-1) * density-guided-simulation-shift-vector.
- density-guided-simulation-transformation-matrix¶
(1,0,0,0,1,0,0,0,1) Multiply all atoms with this matrix in the density-guided-simulation-group before calculating forces and energies for density-guided-simulations. Affects only the density-guided-simulation forces and energies. Corresponds to a transformation of the input density by the inverse of this matrix. The matrix is given in row-major order. This option allows, e.g., rotation of the density-guided atom group around the z-axis by \(\theta\) degress by using following input: \((\cos \theta , -\sin \theta , 0 , \sin \theta , \cos \theta , 0 , 0 , 0 , 1)\) .
QM/MM simulations with CP2K Interface¶
These options enable and control the calculation and application of additional QM/MM forces that are computed by the CP2K package if it is linked into GROMACS. For further details about QM/MM interface implementation follow Hybrid Quantum-Classical simulations (QM/MM) with CP2K interface.
- qmmm-cp2k-active¶
(false) Activate QM/MM simulations. Requires CP2K to be linked with GROMACS
- qmmm-cp2k-qmgroup¶
(System) Index group with atoms that are treated with QM.
- qmmm-cp2k-qmmethod¶
(PBE) Method used to describe the QM part of the system.
- PBE¶
DFT using PBE functional and DZVP-MOLOPT basis set.
- BLYP¶
DFT using BLYP functional and DZVP-MOLOPT basis set.
- INPUT¶
Provide an external input file for CP2K when running gmx grompp with the
-qmi
command-line option. External input files are subject to the limitations that are described in Hybrid Quantum-Classical simulations (QM/MM) with CP2K interface.
- qmmm-cp2k-qmcharge¶
Total charge of the QM part.
- qmmm-cp2k-qmmultiplicity¶
Multiplicity or spin-state of QM part. Default value 1 means singlet state.
- qmmm-cp2k-qmfilenames¶
() Names of the CP2K files that will be generated during the simulation. When using the default, empty, value the name of the simulation input file will be used with an additional
_cp2k
suffix.
User defined thingies¶
- user1-grps¶
- user2-grps¶
- userint1 (0)¶
- userint2 (0)¶
- userint3 (0)¶
- userint4 (0)¶
- userreal1 (0)¶
- userreal2 (0)¶
- userreal3 (0)¶
- userreal4 (0)¶
These you can use if you modify code. You can pass integers and reals and groups to your subroutine. Check the inputrec definition in
src/gromacs/mdtypes/inputrec.h
Removed features¶
These features have been removed from GROMACS, but so that old mdp and tpr files cannot be mistakenly misused, we still parse this option. gmx grompp and gmx mdrun will issue a fatal error if this is set.
- adress¶
(no)
- implicit-solvent¶
(no)