2 See the "run control" section for a working example of the
3 syntax to use when making .mdp entries, with and without detailed
4 documentation for values those entries might take. Everything can
5 be cross-referenced, see the examples there. TODO Make more
8 Molecular dynamics parameters (.mdp options)
9 ============================================
16 Default values are given in parentheses, or listed first among
17 choices. The first option in the list is always the default
18 option. Units are given in square brackets. The difference between a
19 dash and an underscore is ignored.
21 A :ref:`sample mdp file <mdp>` is available. This should be
22 appropriate to start a normal simulation. Edit it to suit your
23 specific needs and desires.
31 directories to include in your topology. Format:
32 ``-I/home/john/mylib -I../otherlib``
36 defines to pass to the preprocessor, default is no defines. You can
37 use any defines to control options in your customized topology
38 files. Options that act on existing :ref:`top` file mechanisms
41 ``-DFLEXIBLE`` will use flexible water instead of rigid water
42 into your topology, this can be useful for normal mode analysis.
44 ``-DPOSRES`` will trigger the inclusion of ``posre.itp`` into
45 your topology, used for implementing position restraints.
53 (Despite the name, this list includes algorithms that are not
54 actually integrators over time. :mdp-value:`integrator=steep` and
55 all entries following it are in this category)
59 A leap-frog algorithm for integrating Newton's equations of motion.
63 A velocity Verlet algorithm for integrating Newton's equations
64 of motion. For constant NVE simulations started from
65 corresponding points in the same trajectory, the trajectories
66 are analytically, but not binary, identical to the
67 :mdp-value:`integrator=md` leap-frog integrator. The the kinetic
68 energy, which is determined from the whole step velocities and
69 is therefore slightly too high. The advantage of this integrator
70 is more accurate, reversible Nose-Hoover and Parrinello-Rahman
71 coupling integration based on Trotter expansion, as well as
72 (slightly too small) full step velocity output. This all comes
73 at the cost off extra computation, especially with constraints
74 and extra communication in parallel. Note that for nearly all
75 production simulations the :mdp-value:`integrator=md` integrator
78 .. mdp-value:: md-vv-avek
80 A velocity Verlet algorithm identical to
81 :mdp-value:`integrator=md-vv`, except that the kinetic energy is
82 determined as the average of the two half step kinetic energies
83 as in the :mdp-value:`integrator=md` integrator, and this thus
84 more accurate. With Nose-Hoover and/or Parrinello-Rahman
85 coupling this comes with a slight increase in computational
90 An accurate and efficient leap-frog stochastic dynamics
91 integrator. With constraints, coordinates needs to be
92 constrained twice per integration step. Depending on the
93 computational cost of the force calculation, this can take a
94 significant part of the simulation time. The temperature for one
95 or more groups of atoms (:mdp:`tc-grps`) is set with
96 :mdp:`ref-t`, the inverse friction constant for each group is
97 set with :mdp:`tau-t`. The parameter :mdp:`tcoupl` is
98 ignored. The random generator is initialized with
99 :mdp:`ld-seed`. When used as a thermostat, an appropriate value
100 for :mdp:`tau-t` is 2 ps, since this results in a friction that
101 is lower than the internal friction of water, while it is high
102 enough to remove excess heat NOTE: temperature deviations decay
103 twice as fast as with a Berendsen thermostat with the same
108 An Euler integrator for Brownian or position Langevin dynamics,
109 the velocity is the force divided by a friction coefficient
110 (:mdp:`bd-fric`) plus random thermal noise (:mdp:`ref-t`). When
111 :mdp:`bd-fric` is 0, the friction coefficient for each particle
112 is calculated as mass/ :mdp:`tau-t`, as for the integrator
113 :mdp-value:`integrator=sd`. The random generator is initialized
118 A steepest descent algorithm for energy minimization. The
119 maximum step size is :mdp:`emstep`, the tolerance is
124 A conjugate gradient algorithm for energy minimization, the
125 tolerance is :mdp:`emtol`. CG is more efficient when a steepest
126 descent step is done every once in a while, this is determined
127 by :mdp:`nstcgsteep`. For a minimization prior to a normal mode
128 analysis, which requires a very high accuracy, |Gromacs| should be
129 compiled in double precision.
131 .. mdp-value:: l-bfgs
133 A quasi-Newtonian algorithm for energy minimization according to
134 the low-memory Broyden-Fletcher-Goldfarb-Shanno approach. In
135 practice this seems to converge faster than Conjugate Gradients,
136 but due to the correction steps necessary it is not (yet)
141 Normal mode analysis is performed on the structure in the :ref:`tpr`
142 file. |Gromacs| should be compiled in double precision.
146 Test particle insertion. The last molecule in the topology is
147 the test particle. A trajectory must be provided to ``mdrun
148 -rerun``. This trajectory should not contain the molecule to be
149 inserted. Insertions are performed :mdp:`nsteps` times in each
150 frame at random locations and with random orientiations of the
151 molecule. When :mdp:`nstlist` is larger than one,
152 :mdp:`nstlist` insertions are performed in a sphere with radius
153 :mdp:`rtpi` around a the same random location using the same
154 pair list. Since pair list construction is expensive,
155 one can perform several extra insertions with the same list
156 almost for free. The random seed is set with
157 :mdp:`ld-seed`. The temperature for the Boltzmann weighting is
158 set with :mdp:`ref-t`, this should match the temperature of the
159 simulation of the original trajectory. Dispersion correction is
160 implemented correctly for TPI. All relevant quantities are
161 written to the file specified with ``mdrun -tpi``. The
162 distribution of insertion energies is written to the file
163 specified with ``mdrun -tpid``. No trajectory or energy file is
164 written. Parallel TPI gives identical results to single-node
165 TPI. For charged molecules, using PME with a fine grid is most
166 accurate and also efficient, since the potential in the system
167 only needs to be calculated once per frame.
171 Test particle insertion into a predefined cavity location. The
172 procedure is the same as for :mdp-value:`integrator=tpi`, except
173 that one coordinate extra is read from the trajectory, which is
174 used as the insertion location. The molecule to be inserted
175 should be centered at 0,0,0. |Gromacs| does not do this for you,
176 since for different situations a different way of centering
177 might be optimal. Also :mdp:`rtpi` sets the radius for the
178 sphere around this location. Neighbor searching is done only
179 once per frame, :mdp:`nstlist` is not used. Parallel
180 :mdp-value:`integrator=tpic` gives identical results to
181 single-rank :mdp-value:`integrator=tpic`.
186 starting time for your run (only makes sense for time-based
192 time step for integration (only makes sense for time-based
198 maximum number of steps to integrate or minimize, -1 is no
204 The starting step. The time at an step i in a run is
205 calculated as: t = :mdp:`tinit` + :mdp:`dt` *
206 (:mdp:`init-step` + i). The free-energy lambda is calculated
207 as: lambda = :mdp:`init-lambda` + :mdp:`delta-lambda` *
208 (:mdp:`init-step` + i). Also non-equilibrium MD parameters can
209 depend on the step number. Thus for exact restarts or redoing
210 part of a run it might be necessary to set :mdp:`init-step` to
211 the step number of the restart frame. :ref:`gmx convert-tpr`
212 does this automatically.
214 .. mdp:: simulation-part
217 A simulation can consist of multiple parts, each of which has
218 a part number. This option specifies what that number will
219 be, which helps keep track of parts that are logically the
220 same simulation. This option is generally useful to set only
221 when coping with a crashed simulation where files were lost.
225 .. mdp-value:: Linear
227 Remove center of mass translational velocity
229 .. mdp-value:: Angular
231 Remove center of mass translational and rotational velocity around
234 .. mdp-value:: Linear-acceleration-correction
236 Remove center of mass translational velocity. Correct the center of
237 mass position assuming linear acceleration over :mdp:`nstcomm` steps.
238 This is useful for cases where an acceleration is expected on the
239 center of mass which is nearly constant over mdp:`nstcomm` steps.
240 This can occur for example when pulling on a group using an absolute
245 No restriction on the center of mass motion
250 frequency for center of mass motion removal
254 group(s) for center of mass motion removal, default is the whole
264 Brownian dynamics friction coefficient. When :mdp:`bd-fric` is 0,
265 the friction coefficient for each particle is calculated as mass/
271 used to initialize random generator for thermal noise for
272 stochastic and Brownian dynamics. When :mdp:`ld-seed` is set to -1,
273 a pseudo random seed is used. When running BD or SD on multiple
274 processors, each processor uses a seed equal to :mdp:`ld-seed` plus
275 the processor number.
283 (10.0) \[kJ mol-1 nm-1\]
284 the minimization is converged when the maximum force is smaller
295 frequency of performing 1 steepest descent step while doing
296 conjugate gradient energy minimization.
301 Number of correction steps to use for L-BFGS minimization. A higher
302 number is (at least theoretically) more accurate, but slower.
305 Shell Molecular Dynamics
306 ^^^^^^^^^^^^^^^^^^^^^^^^
308 When shells or flexible constraints are present in the system the
309 positions of the shells and the lengths of the flexible constraints
310 are optimized at every time step until either the RMS force on the
311 shells and constraints is less than :mdp:`emtol`, or a maximum number
312 of iterations :mdp:`niter` has been reached. Minimization is converged
313 when the maximum force is smaller than :mdp:`emtol`. For shell MD this
314 value should be 1.0 at most.
319 maximum number of iterations for optimizing the shell positions and
320 the flexible constraints.
325 the step size for optimizing the flexible constraints. Should be
326 chosen as mu/(d2V/dq2) where mu is the reduced mass of two
327 particles in a flexible constraint and d2V/dq2 is the second
328 derivative of the potential in the constraint direction. Hopefully
329 this number does not differ too much between the flexible
330 constraints, as the number of iterations and thus the runtime is
331 very sensitive to fcstep. Try several values!
334 Test particle insertion
335 ^^^^^^^^^^^^^^^^^^^^^^^
340 the test particle insertion radius, see integrators
341 :mdp-value:`integrator=tpi` and :mdp-value:`integrator=tpic`
350 number of steps that elapse between writing coordinates to output
351 trajectory file, the last coordinates are always written
356 number of steps that elapse between writing velocities to output
357 trajectory, the last velocities are always written
362 number of steps that elapse between writing forces to output
368 number of steps that elapse between writing energies to the log
369 file, the last energies are always written
371 .. mdp:: nstcalcenergy
374 number of steps that elapse between calculating the energies, 0 is
375 never. This option is only relevant with dynamics. This option affects the
376 performance in parallel simulations, because calculating energies
377 requires global communication between all processes which can
378 become a bottleneck at high parallelization.
383 number of steps that else between writing energies to energy file,
384 the last energies are always written, should be a multiple of
385 :mdp:`nstcalcenergy`. Note that the exact sums and fluctuations
386 over all MD steps modulo :mdp:`nstcalcenergy` are stored in the
387 energy file, so :ref:`gmx energy` can report exact energy averages
388 and fluctuations also when :mdp:`nstenergy` > 1
390 .. mdp:: nstxout-compressed
393 number of steps that elapse between writing position coordinates
394 using lossy compression
396 .. mdp:: compressed-x-precision
399 precision with which to write to the compressed trajectory file
401 .. mdp:: compressed-x-grps
403 group(s) to write to the compressed trajectory file, by default the
404 whole system is written (if :mdp:`nstxout-compressed` > 0)
408 group(s) for which to write to write short-ranged non-bonded
409 potential energies to the energy file (not supported on GPUs)
415 .. mdp:: cutoff-scheme
417 .. mdp-value:: Verlet
419 Generate a pair list with buffering. The buffer size is
420 automatically set based on :mdp:`verlet-buffer-tolerance`,
421 unless this is set to -1, in which case :mdp:`rlist` will be
422 used. This option has an explicit, exact cut-off at :mdp:`rvdw`
423 equal to :mdp:`rcoulomb`, unless PME or Ewald is used, in which
424 case :mdp:`rcoulomb` > :mdp:`rvdw` is allowed. Currently only
425 cut-off, reaction-field, PME or Ewald electrostatics and plain
426 LJ are supported. Some :ref:`gmx mdrun` functionality is not yet
427 supported with the :mdp-value:`cutoff-scheme=Verlet` scheme, but :ref:`gmx grompp`
428 checks for this. Native GPU acceleration is only supported with
429 :mdp-value:`cutoff-scheme=Verlet`. With GPU-accelerated PME or with separate PME
430 ranks, :ref:`gmx mdrun` will automatically tune the CPU/GPU load
431 balance by scaling :mdp:`rcoulomb` and the grid spacing. This
432 can be turned off with ``mdrun -notunepme``. :mdp-value:`cutoff-scheme=Verlet` is
433 faster than :mdp-value:`cutoff-scheme=group` when there is no water, or if
434 :mdp-value:`cutoff-scheme=group` would use a pair-list buffer to conserve energy.
438 Generate a pair list for groups of atoms. These groups
439 correspond to the charge groups in the topology. This was the
440 only cut-off treatment scheme before version 4.6, and is
441 **deprecated since 5.1**. There is no explicit buffering of
442 the pair list. This enables efficient force calculations for
443 water, but energy is only conserved when a buffer is explicitly
452 Frequency to update the neighbor list. When this is 0, the
453 neighbor list is made only once. With energy minimization the
454 pair list will be updated for every energy evaluation when
455 :mdp:`nstlist` is greater than 0. With :mdp-value:`cutoff-scheme=Verlet` and
456 :mdp:`verlet-buffer-tolerance` set, :mdp:`nstlist` is actually
457 a minimum value and :ref:`gmx mdrun` might increase it, unless
458 it is set to 1. With parallel simulations and/or non-bonded
459 force calculation on the GPU, a value of 20 or 40 often gives
460 the best performance. With :mdp-value:`cutoff-scheme=group` and non-exact
461 cut-off's, :mdp:`nstlist` will affect the accuracy of your
462 simulation and it can not be chosen freely.
466 The neighbor list is only constructed once and never
467 updated. This is mainly useful for vacuum simulations in which
468 all particles see each other.
478 Make a grid in the box and only check atoms in neighboring grid
479 cells when constructing a new neighbor list every
480 :mdp:`nstlist` steps. In large systems grid search is much
481 faster than simple search.
483 .. mdp-value:: simple
485 Check every atom in the box when constructing a new neighbor
486 list every :mdp:`nstlist` steps (only with :mdp-value:`cutoff-scheme=group`
493 Use periodic boundary conditions in all directions.
497 Use no periodic boundary conditions, ignore the box. To simulate
498 without cut-offs, set all cut-offs and :mdp:`nstlist` to 0. For
499 best performance without cut-offs on a single MPI rank, set
500 :mdp:`nstlist` to zero and :mdp:`ns-type` =simple.
504 Use periodic boundary conditions in x and y directions
505 only. This works only with :mdp:`ns-type` =grid and can be used
506 in combination with walls_. Without walls or with only one wall
507 the system size is infinite in the z direction. Therefore
508 pressure coupling or Ewald summation methods can not be
509 used. These disadvantages do not apply when two walls are used.
511 .. mdp:: periodic-molecules
515 molecules are finite, fast molecular PBC can be used
519 for systems with molecules that couple to themselves through the
520 periodic boundary conditions, this requires a slower PBC
521 algorithm and molecules are not made whole in the output
523 .. mdp:: verlet-buffer-tolerance
525 (0.005) \[kJ/mol/ps\]
527 Useful only with the :mdp-value:`cutoff-scheme=Verlet` :mdp:`cutoff-scheme`. This sets
528 the maximum allowed error for pair interactions per particle caused
529 by the Verlet buffer, which indirectly sets :mdp:`rlist`. As both
530 :mdp:`nstlist` and the Verlet buffer size are fixed (for
531 performance reasons), particle pairs not in the pair list can
532 occasionally get within the cut-off distance during
533 :mdp:`nstlist` -1 steps. This causes very small jumps in the
534 energy. In a constant-temperature ensemble, these very small energy
535 jumps can be estimated for a given cut-off and :mdp:`rlist`. The
536 estimate assumes a homogeneous particle distribution, hence the
537 errors might be slightly underestimated for multi-phase
538 systems. (See the `reference manual`_ for details). For longer
539 pair-list life-time (:mdp:`nstlist` -1) * :mdp:`dt` the buffer is
540 overestimated, because the interactions between particles are
541 ignored. Combined with cancellation of errors, the actual drift of
542 the total energy is usually one to two orders of magnitude
543 smaller. Note that the generated buffer size takes into account
544 that the |Gromacs| pair-list setup leads to a reduction in the
545 drift by a factor 10, compared to a simple particle-pair based
546 list. Without dynamics (energy minimization etc.), the buffer is 5%
547 of the cut-off. For NVE simulations the initial temperature is
548 used, unless this is zero, in which case a buffer of 10% is
549 used. For NVE simulations the tolerance usually needs to be lowered
550 to achieve proper energy conservation on the nanosecond time
551 scale. To override the automated buffer setting, use
552 :mdp:`verlet-buffer-tolerance` =-1 and set :mdp:`rlist` manually.
557 Cut-off distance for the short-range neighbor list. With the
558 :mdp-value:`cutoff-scheme=Verlet` :mdp:`cutoff-scheme`, this is by default set by the
559 :mdp:`verlet-buffer-tolerance` option and the value of
560 :mdp:`rlist` is ignored.
568 .. mdp-value:: Cut-off
570 Plain cut-off with pair list radius :mdp:`rlist` and
571 Coulomb cut-off :mdp:`rcoulomb`, where :mdp:`rlist` >=
576 Classical Ewald sum electrostatics. The real-space cut-off
577 :mdp:`rcoulomb` should be equal to :mdp:`rlist`. Use *e.g.*
578 :mdp:`rlist` =0.9, :mdp:`rcoulomb` =0.9. The highest magnitude
579 of wave vectors used in reciprocal space is controlled by
580 :mdp:`fourierspacing`. The relative accuracy of
581 direct/reciprocal space is controlled by :mdp:`ewald-rtol`.
583 NOTE: Ewald scales as O(N^3/2) and is thus extremely slow for
584 large systems. It is included mainly for reference - in most
585 cases PME will perform much better.
589 Fast smooth Particle-Mesh Ewald (SPME) electrostatics. Direct
590 space is similar to the Ewald sum, while the reciprocal part is
591 performed with FFTs. Grid dimensions are controlled with
592 :mdp:`fourierspacing` and the interpolation order with
593 :mdp:`pme-order`. With a grid spacing of 0.1 nm and cubic
594 interpolation the electrostatic forces have an accuracy of
595 2-3*10^-4. Since the error from the vdw-cutoff is larger than
596 this you might try 0.15 nm. When running in parallel the
597 interpolation parallelizes better than the FFT, so try
598 decreasing grid dimensions while increasing interpolation.
600 .. mdp-value:: P3M-AD
602 Particle-Particle Particle-Mesh algorithm with analytical
603 derivative for for long range electrostatic interactions. The
604 method and code is identical to SPME, except that the influence
605 function is optimized for the grid. This gives a slight increase
608 .. mdp-value:: Reaction-Field
610 Reaction field electrostatics with Coulomb cut-off
611 :mdp:`rcoulomb`, where :mdp:`rlist` >= :mdp:`rvdw`. The
612 dielectric constant beyond the cut-off is
613 :mdp:`epsilon-rf`. The dielectric constant can be set to
614 infinity by setting :mdp:`epsilon-rf` =0.
616 .. mdp-value:: Generalized-Reaction-Field
618 Generalized reaction field with Coulomb cut-off
619 :mdp:`rcoulomb`, where :mdp:`rlist` >= :mdp:`rcoulomb`. The
620 dielectric constant beyond the cut-off is
621 :mdp:`epsilon-rf`. The ionic strength is computed from the
622 number of charged (*i.e.* with non zero charge) charge
623 groups. The temperature for the GRF potential is set with
626 .. mdp-value:: Reaction-Field-zero
628 In |Gromacs|, normal reaction-field electrostatics with
629 :mdp:`cutoff-scheme` = :mdp-value:`cutoff-scheme=group` leads to bad energy
630 conservation. :mdp-value:`coulombtype=Reaction-Field-zero` solves this by making
631 the potential zero beyond the cut-off. It can only be used with
632 an infinite dielectric constant (:mdp:`epsilon-rf` =0), because
633 only for that value the force vanishes at the
634 cut-off. :mdp:`rlist` should be 0.1 to 0.3 nm larger than
635 :mdp:`rcoulomb` to accommodate for the size of charge groups
636 and diffusion between neighbor list updates. This, and the fact
637 that table lookups are used instead of analytical functions make
638 :mdp-value:`coulombtype=Reaction-Field-zero` computationally more expensive than
639 normal reaction-field.
643 Analogous to :mdp-value:`vdwtype=Shift` for :mdp:`vdwtype`. You
644 might want to use :mdp-value:`coulombtype=Reaction-Field-zero` instead, which has
645 a similar potential shape, but has a physical interpretation and
646 has better energies due to the exclusion correction terms.
648 .. mdp-value:: Encad-Shift
650 The Coulomb potential is decreased over the whole range, using
651 the definition from the Encad simulation package.
653 .. mdp-value:: Switch
655 Analogous to :mdp-value:`vdwtype=Switch` for
656 :mdp:`vdwtype`. Switching the Coulomb potential can lead to
657 serious artifacts, advice: use :mdp-value:`coulombtype=Reaction-Field-zero`
662 :ref:`gmx mdrun` will now expect to find a file ``table.xvg``
663 with user-defined potential functions for repulsion, dispersion
664 and Coulomb. When pair interactions are present, :ref:`gmx
665 mdrun` also expects to find a file ``tablep.xvg`` for the pair
666 interactions. When the same interactions should be used for
667 non-bonded and pair interactions the user can specify the same
668 file name for both table files. These files should contain 7
669 columns: the ``x`` value, ``f(x)``, ``-f'(x)``, ``g(x)``,
670 ``-g'(x)``, ``h(x)``, ``-h'(x)``, where ``f(x)`` is the Coulomb
671 function, ``g(x)`` the dispersion function and ``h(x)`` the
672 repulsion function. When :mdp:`vdwtype` is not set to User the
673 values for ``g``, ``-g'``, ``h`` and ``-h'`` are ignored. For
674 the non-bonded interactions ``x`` values should run from 0 to
675 the largest cut-off distance + :mdp:`table-extension` and
676 should be uniformly spaced. For the pair interactions the table
677 length in the file will be used. The optimal spacing, which is
678 used for non-user tables, is ``0.002 nm`` when you run in mixed
679 precision or ``0.0005 nm`` when you run in double precision. The
680 function value at ``x=0`` is not important. More information is
681 in the printed manual.
683 .. mdp-value:: PME-Switch
685 A combination of PME and a switch function for the direct-space
686 part (see above). :mdp:`rcoulomb` is allowed to be smaller than
687 :mdp:`rlist`. This is mainly useful constant energy simulations
688 (note that using PME with :mdp:`cutoff-scheme` = :mdp-value:`cutoff-scheme=Verlet`
689 will be more efficient).
691 .. mdp-value:: PME-User
693 A combination of PME and user tables (see
694 above). :mdp:`rcoulomb` is allowed to be smaller than
695 :mdp:`rlist`. The PME mesh contribution is subtracted from the
696 user table by :ref:`gmx mdrun`. Because of this subtraction the
697 user tables should contain about 10 decimal places.
699 .. mdp-value:: PME-User-Switch
701 A combination of PME-User and a switching function (see
702 above). The switching function is applied to final
703 particle-particle interaction, *i.e.* both to the user supplied
704 function and the PME Mesh correction part.
706 .. mdp:: coulomb-modifier
708 .. mdp-value:: Potential-shift-Verlet
710 Selects Potential-shift with the Verlet cutoff-scheme, as it is
711 (nearly) free; selects None with the group cutoff-scheme.
713 .. mdp-value:: Potential-shift
715 Shift the Coulomb potential by a constant such that it is zero
716 at the cut-off. This makes the potential the integral of the
717 force. Note that this does not affect the forces or the
722 Use an unmodified Coulomb potential. With the group scheme this
723 means no exact cut-off is used, energies and forces are
724 calculated for all pairs in the pair list.
726 .. mdp:: rcoulomb-switch
729 where to start switching the Coulomb potential, only relevant
730 when force or potential switching is used
735 distance for the Coulomb cut-off
740 The relative dielectric constant. A value of 0 means infinity.
745 The relative dielectric constant of the reaction field. This
746 is only used with reaction-field electrostatics. A value of 0
755 .. mdp-value:: Cut-off
757 Plain cut-off with pair list radius :mdp:`rlist` and VdW
758 cut-off :mdp:`rvdw`, where :mdp:`rlist` >= :mdp:`rvdw`.
762 Fast smooth Particle-mesh Ewald (SPME) for VdW interactions. The
763 grid dimensions are controlled with :mdp:`fourierspacing` in
764 the same way as for electrostatics, and the interpolation order
765 is controlled with :mdp:`pme-order`. The relative accuracy of
766 direct/reciprocal space is controlled by :mdp:`ewald-rtol-lj`,
767 and the specific combination rules that are to be used by the
768 reciprocal routine are set using :mdp:`lj-pme-comb-rule`.
772 This functionality is deprecated and replaced by
773 :mdp:`vdw-modifier` = Force-switch. The LJ (not Buckingham)
774 potential is decreased over the whole range and the forces decay
775 smoothly to zero between :mdp:`rvdw-switch` and
776 :mdp:`rvdw`. The neighbor search cut-off :mdp:`rlist` should
777 be 0.1 to 0.3 nm larger than :mdp:`rvdw` to accommodate for the
778 size of charge groups and diffusion between neighbor list
781 .. mdp-value:: Switch
783 This functionality is deprecated and replaced by
784 :mdp:`vdw-modifier` = Potential-switch. The LJ (not Buckingham)
785 potential is normal out to :mdp:`rvdw-switch`, after which it
786 is switched off to reach zero at :mdp:`rvdw`. Both the
787 potential and force functions are continuously smooth, but be
788 aware that all switch functions will give rise to a bulge
789 (increase) in the force (since we are switching the
790 potential). The neighbor search cut-off :mdp:`rlist` should be
791 0.1 to 0.3 nm larger than :mdp:`rvdw` to accommodate for the
792 size of charge groups and diffusion between neighbor list
795 .. mdp-value:: Encad-Shift
797 The LJ (not Buckingham) potential is decreased over the whole
798 range, using the definition from the Encad simulation package.
802 See user for :mdp:`coulombtype`. The function value at zero is
803 not important. When you want to use LJ correction, make sure
804 that :mdp:`rvdw` corresponds to the cut-off in the user-defined
805 function. When :mdp:`coulombtype` is not set to User the values
806 for the ``f`` and ``-f'`` columns are ignored.
808 .. mdp:: vdw-modifier
810 .. mdp-value:: Potential-shift-Verlet
812 Selects Potential-shift with the Verlet cutoff-scheme, as it is
813 (nearly) free; selects None with the group cutoff-scheme.
815 .. mdp-value:: Potential-shift
817 Shift the Van der Waals potential by a constant such that it is
818 zero at the cut-off. This makes the potential the integral of
819 the force. Note that this does not affect the forces or the
824 Use an unmodified Van der Waals potential. With the group scheme
825 this means no exact cut-off is used, energies and forces are
826 calculated for all pairs in the pair list.
828 .. mdp-value:: Force-switch
830 Smoothly switches the forces to zero between :mdp:`rvdw-switch`
831 and :mdp:`rvdw`. This shifts the potential shift over the whole
832 range and switches it to zero at the cut-off. Note that this is
833 more expensive to calculate than a plain cut-off and it is not
834 required for energy conservation, since Potential-shift
835 conserves energy just as well.
837 .. mdp-value:: Potential-switch
839 Smoothly switches the potential to zero between
840 :mdp:`rvdw-switch` and :mdp:`rvdw`. Note that this introduces
841 articifically large forces in the switching region and is much
842 more expensive to calculate. This option should only be used if
843 the force field you are using requires this.
849 where to start switching the LJ force and possibly the potential,
850 only relevant when force or potential switching is used
855 distance for the LJ or Buckingham cut-off
861 don't apply any correction
863 .. mdp-value:: EnerPres
865 apply long range dispersion corrections for Energy and Pressure
869 apply long range dispersion corrections for Energy only
875 .. mdp:: table-extension
878 Extension of the non-bonded potential lookup tables beyond the
879 largest cut-off distance. The value should be large enough to
880 account for charge group sizes and the diffusion between
881 neighbor-list updates. Without user defined potential the same
882 table length is used for the lookup tables for the 1-4
883 interactions, which are always tabulated irrespective of the use of
884 tables for the non-bonded interactions. The value of
885 :mdp:`table-extension` in no way affects the values of
886 :mdp:`rlist`, :mdp:`rcoulomb`, or :mdp:`rvdw`.
888 .. mdp:: energygrp-table
890 When user tables are used for electrostatics and/or VdW, here one
891 can give pairs of energy groups for which seperate user tables
892 should be used. The two energy groups will be appended to the table
893 file name, in order of their definition in :mdp:`energygrps`,
894 seperated by underscores. For example, if ``energygrps = Na Cl
895 Sol`` and ``energygrp-table = Na Na Na Cl``, :ref:`gmx mdrun` will
896 read ``table_Na_Na.xvg`` and ``table_Na_Cl.xvg`` in addition to the
897 normal ``table.xvg`` which will be used for all other energy group
904 .. mdp:: fourierspacing
907 For ordinary Ewald, the ratio of the box dimensions and the spacing
908 determines a lower bound for the number of wave vectors to use in
909 each (signed) direction. For PME and P3M, that ratio determines a
910 lower bound for the number of Fourier-space grid points that will
911 be used along that axis. In all cases, the number for each
912 direction can be overridden by entering a non-zero value for that
913 :mdp:`fourier-nx` direction. For optimizing the relative load of
914 the particle-particle interactions and the mesh part of PME, it is
915 useful to know that the accuracy of the electrostatics remains
916 nearly constant when the Coulomb cut-off and the PME grid spacing
917 are scaled by the same factor.
924 Highest magnitude of wave vectors in reciprocal space when using Ewald.
925 Grid size when using PME or P3M. These values override
926 :mdp:`fourierspacing` per direction. The best choice is powers of
927 2, 3, 5 and 7. Avoid large primes.
932 Interpolation order for PME. 4 equals cubic interpolation. You
933 might try 6/8/10 when running in parallel and simultaneously
934 decrease grid dimension.
939 The relative strength of the Ewald-shifted direct potential at
940 :mdp:`rcoulomb` is given by :mdp:`ewald-rtol`. Decreasing this
941 will give a more accurate direct sum, but then you need more wave
942 vectors for the reciprocal sum.
944 .. mdp:: ewald-rtol-lj
947 When doing PME for VdW-interactions, :mdp:`ewald-rtol-lj` is used
948 to control the relative strength of the dispersion potential at
949 :mdp:`rvdw` in the same way as :mdp:`ewald-rtol` controls the
950 electrostatic potential.
952 .. mdp:: lj-pme-comb-rule
955 The combination rules used to combine VdW-parameters in the
956 reciprocal part of LJ-PME. Geometric rules are much faster than
957 Lorentz-Berthelot and usually the recommended choice, even when the
958 rest of the force field uses the Lorentz-Berthelot rules.
960 .. mdp-value:: Geometric
962 Apply geometric combination rules
964 .. mdp-value:: Lorentz-Berthelot
966 Apply Lorentz-Berthelot combination rules
968 .. mdp:: ewald-geometry
972 The Ewald sum is performed in all three dimensions.
976 The reciprocal sum is still performed in 3D, but a force and
977 potential correction applied in the `z` dimension to produce a
978 pseudo-2D summation. If your system has a slab geometry in the
979 `x-y` plane you can try to increase the `z`-dimension of the box
980 (a box height of 3 times the slab height is usually ok) and use
983 .. mdp:: epsilon-surface
986 This controls the dipole correction to the Ewald summation in
987 3D. The default value of zero means it is turned off. Turn it on by
988 setting it to the value of the relative permittivity of the
989 imaginary surface around your infinite system. Be careful - you
990 shouldn't use this if you have free mobile charges in your
991 system. This value does not affect the slab 3DC variant of the long
1002 No temperature coupling.
1004 .. mdp-value:: berendsen
1006 Temperature coupling with a Berendsen-thermostat to a bath with
1007 temperature :mdp:`ref-t`, with time constant
1008 :mdp:`tau-t`. Several groups can be coupled separately, these
1009 are specified in the :mdp:`tc-grps` field separated by spaces.
1011 .. mdp-value:: nose-hoover
1013 Temperature coupling using a Nose-Hoover extended ensemble. The
1014 reference temperature and coupling groups are selected as above,
1015 but in this case :mdp:`tau-t` controls the period of the
1016 temperature fluctuations at equilibrium, which is slightly
1017 different from a relaxation time. For NVT simulations the
1018 conserved energy quantity is written to energy and log file.
1020 .. mdp-value:: andersen
1022 Temperature coupling by randomizing a fraction of the particles
1023 at each timestep. Reference temperature and coupling groups are
1024 selected as above. :mdp:`tau-t` is the average time between
1025 randomization of each molecule. Inhibits particle dynamics
1026 somewhat, but little or no ergodicity issues. Currently only
1027 implemented with velocity Verlet, and not implemented with
1030 .. mdp-value:: andersen-massive
1032 Temperature coupling by randomizing all particles at infrequent
1033 timesteps. Reference temperature and coupling groups are
1034 selected as above. :mdp:`tau-t` is the time between
1035 randomization of all molecules. Inhibits particle dynamics
1036 somewhat, but little or no ergodicity issues. Currently only
1037 implemented with velocity Verlet.
1039 .. mdp-value:: v-rescale
1041 Temperature coupling using velocity rescaling with a stochastic
1042 term (JCP 126, 014101). This thermostat is similar to Berendsen
1043 coupling, with the same scaling using :mdp:`tau-t`, but the
1044 stochastic term ensures that a proper canonical ensemble is
1045 generated. The random seed is set with :mdp:`ld-seed`. This
1046 thermostat works correctly even for :mdp:`tau-t` =0. For NVT
1047 simulations the conserved energy quantity is written to the
1048 energy and log file.
1053 The frequency for coupling the temperature. The default value of -1
1054 sets :mdp:`nsttcouple` equal to :mdp:`nstlist`, unless
1055 :mdp:`nstlist` <=0, then a value of 10 is used. For velocity
1056 Verlet integrators :mdp:`nsttcouple` is set to 1.
1058 .. mdp:: nh-chain-length
1061 The number of chained Nose-Hoover thermostats for velocity Verlet
1062 integrators, the leap-frog :mdp-value:`integrator=md` integrator
1063 only supports 1. Data for the NH chain variables is not printed
1064 to the :ref:`edr` file by default, but can be turned on with the
1065 :mdp:`print-nose-hoover-chains` option.
1067 .. mdp:: print-nose-hoover-chain-variables
1071 Do not store Nose-Hoover chain variables in the energy file.
1075 Store all positions and velocities of the Nose-Hoover chain
1080 groups to couple to separate temperature baths
1085 time constant for coupling (one for each group in
1086 :mdp:`tc-grps`), -1 means no temperature coupling
1091 reference temperature for coupling (one for each group in
1102 No pressure coupling. This means a fixed box size.
1104 .. mdp-value:: Berendsen
1106 Exponential relaxation pressure coupling with time constant
1107 :mdp:`tau-p`. The box is scaled every timestep. It has been
1108 argued that this does not yield a correct thermodynamic
1109 ensemble, but it is the most efficient way to scale a box at the
1112 .. mdp-value:: Parrinello-Rahman
1114 Extended-ensemble pressure coupling where the box vectors are
1115 subject to an equation of motion. The equation of motion for the
1116 atoms is coupled to this. No instantaneous scaling takes
1117 place. As for Nose-Hoover temperature coupling the time constant
1118 :mdp:`tau-p` is the period of pressure fluctuations at
1119 equilibrium. This is probably a better method when you want to
1120 apply pressure scaling during data collection, but beware that
1121 you can get very large oscillations if you are starting from a
1122 different pressure. For simulations where the exact fluctation
1123 of the NPT ensemble are important, or if the pressure coupling
1124 time is very short it may not be appropriate, as the previous
1125 time step pressure is used in some steps of the |Gromacs|
1126 implementation for the current time step pressure.
1130 Martyna-Tuckerman-Tobias-Klein implementation, only useable with
1131 :mdp-value:`integrator=md-vv` or :mdp-value:`integrator=md-vv-avek`, very similar to
1132 Parrinello-Rahman. As for Nose-Hoover temperature coupling the
1133 time constant :mdp:`tau-p` is the period of pressure
1134 fluctuations at equilibrium. This is probably a better method
1135 when you want to apply pressure scaling during data collection,
1136 but beware that you can get very large oscillations if you are
1137 starting from a different pressure. Currently (as of version
1138 5.1), it only supports isotropic scaling, and only works without
1143 Specifies the kind of isotropy of the pressure coupling used. Each
1144 kind takes one or more values for :mdp:`compressibility` and
1145 :mdp:`ref-p`. Only a single value is permitted for :mdp:`tau-p`.
1147 .. mdp-value:: isotropic
1149 Isotropic pressure coupling with time constant
1150 :mdp:`tau-p`. One value each for :mdp:`compressibility` and
1151 :mdp:`ref-p` is required.
1153 .. mdp-value:: semiisotropic
1155 Pressure coupling which is isotropic in the ``x`` and ``y``
1156 direction, but different in the ``z`` direction. This can be
1157 useful for membrane simulations. Two values each for
1158 :mdp:`compressibility` and :mdp:`ref-p` are required, for
1159 ``x/y`` and ``z`` directions respectively.
1161 .. mdp-value:: anisotropic
1163 Same as before, but 6 values are needed for ``xx``, ``yy``, ``zz``,
1164 ``xy/yx``, ``xz/zx`` and ``yz/zy`` components,
1165 respectively. When the off-diagonal compressibilities are set to
1166 zero, a rectangular box will stay rectangular. Beware that
1167 anisotropic scaling can lead to extreme deformation of the
1170 .. mdp-value:: surface-tension
1172 Surface tension coupling for surfaces parallel to the
1173 xy-plane. Uses normal pressure coupling for the `z`-direction,
1174 while the surface tension is coupled to the `x/y` dimensions of
1175 the box. The first :mdp:`ref-p` value is the reference surface
1176 tension times the number of surfaces ``bar nm``, the second
1177 value is the reference `z`-pressure ``bar``. The two
1178 :mdp:`compressibility` values are the compressibility in the
1179 `x/y` and `z` direction respectively. The value for the
1180 `z`-compressibility should be reasonably accurate since it
1181 influences the convergence of the surface-tension, it can also
1182 be set to zero to have a box with constant height.
1187 The frequency for coupling the pressure. The default value of -1
1188 sets :mdp:`nstpcouple` equal to :mdp:`nstlist`, unless
1189 :mdp:`nstlist` <=0, then a value of 10 is used. For velocity
1190 Verlet integrators :mdp:`nstpcouple` is set to 1.
1195 The time constant for pressure coupling (one value for all
1198 .. mdp:: compressibility
1201 The compressibility (NOTE: this is now really in bar^-1) For water at 1
1202 atm and 300 K the compressibility is 4.5e-5 bar^-1. The number of
1203 required values is implied by :mdp:`pcoupltype`.
1208 The reference pressure for coupling. The number of required values
1209 is implied by :mdp:`pcoupltype`.
1211 .. mdp:: refcoord-scaling
1215 The reference coordinates for position restraints are not
1216 modified. Note that with this option the virial and pressure
1217 will depend on the absolute positions of the reference
1222 The reference coordinates are scaled with the scaling matrix of
1223 the pressure coupling.
1227 Scale the center of mass of the reference coordinates with the
1228 scaling matrix of the pressure coupling. The vectors of each
1229 reference coordinate to the center of mass are not scaled. Only
1230 one COM is used, even when there are multiple molecules with
1231 position restraints. For calculating the COM of the reference
1232 coordinates in the starting configuration, periodic boundary
1233 conditions are not taken into account.
1239 Simulated annealing is controlled separately for each temperature
1240 group in |Gromacs|. The reference temperature is a piecewise linear
1241 function, but you can use an arbitrary number of points for each
1242 group, and choose either a single sequence or a periodic behaviour for
1243 each group. The actual annealing is performed by dynamically changing
1244 the reference temperature used in the thermostat algorithm selected,
1245 so remember that the system will usually not instantaneously reach the
1246 reference temperature!
1250 Type of annealing for each temperature group
1254 No simulated annealing - just couple to reference temperature value.
1256 .. mdp-value:: single
1258 A single sequence of annealing points. If your simulation is
1259 longer than the time of the last point, the temperature will be
1260 coupled to this constant value after the annealing sequence has
1261 reached the last time point.
1263 .. mdp-value:: periodic
1265 The annealing will start over at the first reference point once
1266 the last reference time is reached. This is repeated until the
1269 .. mdp:: annealing-npoints
1271 A list with the number of annealing reference/control points used
1272 for each temperature group. Use 0 for groups that are not
1273 annealed. The number of entries should equal the number of
1276 .. mdp:: annealing-time
1278 List of times at the annealing reference/control points for each
1279 group. If you are using periodic annealing, the times will be used
1280 modulo the last value, *i.e.* if the values are 0, 5, 10, and 15,
1281 the coupling will restart at the 0ps value after 15ps, 30ps, 45ps,
1282 etc. The number of entries should equal the sum of the numbers
1283 given in :mdp:`annealing-npoints`.
1285 .. mdp:: annealing-temp
1287 List of temperatures at the annealing reference/control points for
1288 each group. The number of entries should equal the sum of the
1289 numbers given in :mdp:`annealing-npoints`.
1291 Confused? OK, let's use an example. Assume you have two temperature
1292 groups, set the group selections to ``annealing = single periodic``,
1293 the number of points of each group to ``annealing-npoints = 3 4``, the
1294 times to ``annealing-time = 0 3 6 0 2 4 6`` and finally temperatures
1295 to ``annealing-temp = 298 280 270 298 320 320 298``. The first group
1296 will be coupled to 298K at 0ps, but the reference temperature will
1297 drop linearly to reach 280K at 3ps, and then linearly between 280K and
1298 270K from 3ps to 6ps. After this is stays constant, at 270K. The
1299 second group is coupled to 298K at 0ps, it increases linearly to 320K
1300 at 2ps, where it stays constant until 4ps. Between 4ps and 6ps it
1301 decreases to 298K, and then it starts over with the same pattern
1302 again, *i.e.* rising linearly from 298K to 320K between 6ps and
1303 8ps. Check the summary printed by :ref:`gmx grompp` if you are unsure!
1313 Do not generate velocities. The velocities are set to zero
1314 when there are no velocities in the input structure file.
1318 Generate velocities in :ref:`gmx grompp` according to a
1319 Maxwell distribution at temperature :mdp:`gen-temp`, with
1320 random seed :mdp:`gen-seed`. This is only meaningful with
1321 integrator :mdp-value:`integrator=md`.
1326 temperature for Maxwell distribution
1331 used to initialize random generator for random velocities,
1332 when :mdp:`gen-seed` is set to -1, a pseudo random seed is
1339 .. mdp:: constraints
1341 Controls which bonds in the topology will be converted to rigid
1342 holonomic constraints. Note that typical rigid water models do not
1343 have bonds, but rather a specialized ``[settles]`` directive, so
1344 are not affected by this keyword.
1348 No bonds converted to constraints.
1350 .. mdp-value:: h-bonds
1352 Convert the bonds with H-atoms to constraints.
1354 .. mdp-value:: all-bonds
1356 Convert all bonds to constraints.
1358 .. mdp-value:: h-angles
1360 Convert all bonds to constraints and convert the angles that
1361 involve H-atoms to bond-constraints.
1363 .. mdp-value:: all-angles
1365 Convert all bonds to constraints and all angles to bond-constraints.
1367 .. mdp:: constraint-algorithm
1369 Chooses which solver satisfies any non-SETTLE holonomic
1372 .. mdp-value:: LINCS
1374 LINear Constraint Solver. With domain decomposition the parallel
1375 version P-LINCS is used. The accuracy in set with
1376 :mdp:`lincs-order`, which sets the number of matrices in the
1377 expansion for the matrix inversion. After the matrix inversion
1378 correction the algorithm does an iterative correction to
1379 compensate for lengthening due to rotation. The number of such
1380 iterations can be controlled with :mdp:`lincs-iter`. The root
1381 mean square relative constraint deviation is printed to the log
1382 file every :mdp:`nstlog` steps. If a bond rotates more than
1383 :mdp:`lincs-warnangle` in one step, a warning will be printed
1384 both to the log file and to ``stderr``. LINCS should not be used
1385 with coupled angle constraints.
1387 .. mdp-value:: SHAKE
1389 SHAKE is slightly slower and less stable than LINCS, but does
1390 work with angle constraints. The relative tolerance is set with
1391 :mdp:`shake-tol`, 0.0001 is a good value for "normal" MD. SHAKE
1392 does not support constraints between atoms on different nodes,
1393 thus it can not be used with domain decompositon when inter
1394 charge-group constraints are present. SHAKE can not be used with
1395 energy minimization.
1397 .. mdp:: continuation
1399 This option was formerly known as ``unconstrained-start``.
1403 apply constraints to the start configuration and reset shells
1407 do not apply constraints to the start configuration and do not
1408 reset shells, useful for exact coninuation and reruns
1413 relative tolerance for SHAKE
1415 .. mdp:: lincs-order
1418 Highest order in the expansion of the constraint coupling
1419 matrix. When constraints form triangles, an additional expansion of
1420 the same order is applied on top of the normal expansion only for
1421 the couplings within such triangles. For "normal" MD simulations an
1422 order of 4 usually suffices, 6 is needed for large time-steps with
1423 virtual sites or BD. For accurate energy minimization an order of 8
1424 or more might be required. With domain decomposition, the cell size
1425 is limited by the distance spanned by :mdp:`lincs-order` +1
1426 constraints. When one wants to scale further than this limit, one
1427 can decrease :mdp:`lincs-order` and increase :mdp:`lincs-iter`,
1428 since the accuracy does not deteriorate when (1+ :mdp:`lincs-iter`
1429 )* :mdp:`lincs-order` remains constant.
1434 Number of iterations to correct for rotational lengthening in
1435 LINCS. For normal runs a single step is sufficient, but for NVE
1436 runs where you want to conserve energy accurately or for accurate
1437 energy minimization you might want to increase it to 2.
1439 .. mdp:: lincs-warnangle
1442 maximum angle that a bond can rotate before LINCS will complain
1448 bonds are represented by a harmonic potential
1452 bonds are represented by a Morse potential
1455 Energy group exclusions
1456 ^^^^^^^^^^^^^^^^^^^^^^^
1458 .. mdp:: energygrp-excl
1460 Pairs of energy groups for which all non-bonded interactions are
1461 excluded. An example: if you have two energy groups ``Protein`` and
1462 ``SOL``, specifying ``energygrp-excl = Protein Protein SOL SOL``
1463 would give only the non-bonded interactions between the protein and
1464 the solvent. This is especially useful for speeding up energy
1465 calculations with ``mdrun -rerun`` and for excluding interactions
1466 within frozen groups.
1475 When set to 1 there is a wall at ``z=0``, when set to 2 there is
1476 also a wall at ``z=z-box``. Walls can only be used with :mdp:`pbc`
1477 ``=xy``. When set to 2 pressure coupling and Ewald summation can be
1478 used (it is usually best to use semiisotropic pressure coupling
1479 with the ``x/y`` compressibility set to 0, as otherwise the surface
1480 area will change). Walls interact wit the rest of the system
1481 through an optional :mdp:`wall-atomtype`. Energy groups ``wall0``
1482 and ``wall1`` (for :mdp:`nwall` =2) are added automatically to
1483 monitor the interaction of energy groups with each wall. The center
1484 of mass motion removal will be turned off in the ``z``-direction.
1486 .. mdp:: wall-atomtype
1488 the atom type name in the force field for each wall. By (for
1489 example) defining a special wall atom type in the topology with its
1490 own combination rules, this allows for independent tuning of the
1491 interaction of each atomtype with the walls.
1497 LJ integrated over the volume behind the wall: 9-3 potential
1501 LJ integrated over the wall surface: 10-4 potential
1505 direct LJ potential with the ``z`` distance from the wall
1509 user defined potentials indexed with the ``z`` distance from the
1510 wall, the tables are read analogously to the
1511 :mdp:`energygrp-table` option, where the first name is for a
1512 "normal" energy group and the second name is ``wall0`` or
1513 ``wall1``, only the dispersion and repulsion columns are used
1515 .. mdp:: wall-r-linpot
1518 Below this distance from the wall the potential is continued
1519 linearly and thus the force is constant. Setting this option to a
1520 postive value is especially useful for equilibration when some
1521 atoms are beyond a wall. When the value is <=0 (<0 for
1522 :mdp:`wall-type` =table), a fatal error is generated when atoms
1525 .. mdp:: wall-density
1528 the number density of the atoms for each wall for wall types 9-3
1531 .. mdp:: wall-ewald-zfac
1534 The scaling factor for the third box vector for Ewald summation
1535 only, the minimum is 2. Ewald summation can only be used with
1536 :mdp:`nwall` =2, where one should use :mdp:`ewald-geometry`
1537 ``=3dc``. The empty layer in the box serves to decrease the
1538 unphysical Coulomb interaction between periodic images.
1544 Note that where pulling coordinate are applicable, there can be more
1545 than one (set with :mdp:`pull-ncoords`) and multiple related :ref:`mdp`
1546 variables will exist accordingly. Documentation references to things
1547 like :mdp:`pull-coord1-vec` should be understood to apply to to the
1548 applicable pulling coordinate.
1554 No center of mass pulling. All the following pull options will
1555 be ignored (and if present in the :ref:`mdp` file, they unfortunately
1560 Center of mass pulling will be applied on 1 or more groups using
1561 1 or more pull coordinates.
1563 .. mdp:: pull-cylinder-r
1566 the radius of the cylinder for
1567 :mdp:`pull-coord1-geometry` = :mdp-value:`pull-coord1-geometry=cylinder`
1569 .. mdp:: pull-constr-tol
1572 the relative constraint tolerance for constraint pulling
1574 .. mdp:: pull-print-com
1578 do not print the COM for any group
1582 print the COM of all groups for all pull coordinates
1584 .. mdp:: pull-print-ref-value
1588 do not print the reference value for each pull coordinate
1592 print the reference value for each pull coordinate
1594 .. mdp:: pull-print-components
1598 only print the distance for each pull coordinate
1602 print the distance and Cartesian components selected in
1603 :mdp:`pull-coord1-dim`
1605 .. mdp:: pull-nstxout
1608 frequency for writing out the COMs of all the pull group (0 is
1611 .. mdp:: pull-nstfout
1614 frequency for writing out the force of all the pulled group
1618 .. mdp:: pull-ngroups
1621 The number of pull groups, not including the absolute reference
1622 group, when used. Pull groups can be reused in multiple pull
1623 coordinates. Below only the pull options for group 1 are given,
1624 further groups simply increase the group index number.
1626 .. mdp:: pull-ncoords
1629 The number of pull coordinates. Below only the pull options for
1630 coordinate 1 are given, further coordinates simply increase the
1631 coordinate index number.
1633 .. mdp:: pull-group1-name
1635 The name of the pull group, is looked up in the index file or in
1636 the default groups to obtain the atoms involved.
1638 .. mdp:: pull-group1-weights
1640 Optional relative weights which are multiplied with the masses of
1641 the atoms to give the total weight for the COM. The number should
1642 be 0, meaning all 1, or the number of atoms in the pull group.
1644 .. mdp:: pull-group1-pbcatom
1647 The reference atom for the treatment of periodic boundary
1648 conditions inside the group (this has no effect on the treatment of
1649 the pbc between groups). This option is only important when the
1650 diameter of the pull group is larger than half the shortest box
1651 vector. For determining the COM, all atoms in the group are put at
1652 their periodic image which is closest to
1653 :mdp:`pull-group1-pbcatom`. A value of 0 means that the middle
1654 atom (number wise) is used. This parameter is not used with
1655 :mdp:`pull-coord1-geometry` cylinder. A value of -1 turns on cosine
1656 weighting, which is useful for a group of molecules in a periodic
1657 system, *e.g.* a water slab (see Engin et al. J. Chem. Phys. B
1660 .. mdp:: pull-coord1-type
1662 .. mdp-value:: umbrella
1664 Center of mass pulling using an umbrella potential between the
1665 reference group and one or more groups.
1667 .. mdp-value:: constraint
1669 Center of mass pulling using a constraint between the reference
1670 group and one or more groups. The setup is identical to the
1671 option umbrella, except for the fact that a rigid constraint is
1672 applied instead of a harmonic potential.
1674 .. mdp-value:: constant-force
1676 Center of mass pulling using a linear potential and therefore a
1677 constant force. For this option there is no reference position
1678 and therefore the parameters :mdp:`pull-coord1-init` and
1679 :mdp:`pull-coord1-rate` are not used.
1681 .. mdp-value:: flat-bottom
1683 At distances above :mdp:`pull-coord1-init` a harmonic potential
1684 is applied, otherwise no potential is applied.
1686 .. mdp-value:: flat-bottom-high
1688 At distances below :mdp:`pull-coord1-init` a harmonic potential
1689 is applied, otherwise no potential is applied.
1691 .. mdp-value:: external-potential
1693 An external potential that needs to be provided by another
1696 .. mdp:: pull-coord1-potential-provider
1698 The name of the external module that provides the potential for
1699 the case where :mdp:`pull-coord1-type` is external-potential.
1701 .. mdp:: pull-coord1-geometry
1703 .. mdp-value:: distance
1705 Pull along the vector connecting the two groups. Components can
1706 be selected with :mdp:`pull-coord1-dim`.
1708 .. mdp-value:: direction
1710 Pull in the direction of :mdp:`pull-coord1-vec`.
1712 .. mdp-value:: direction-periodic
1714 As :mdp-value:`pull-coord1-geometry=direction`, but allows the distance to be larger
1715 than half the box size. With this geometry the box should not be
1716 dynamic (*e.g.* no pressure scaling) in the pull dimensions and
1717 the pull force is not added to virial.
1719 .. mdp-value:: direction-relative
1721 As :mdp-value:`pull-coord1-geometry=direction`, but the pull vector is the vector
1722 that points from the COM of a third to the COM of a fourth pull
1723 group. This means that 4 groups need to be supplied in
1724 :mdp:`pull-coord1-groups`. Note that the pull force will give
1725 rise to a torque on the pull vector, which is turn leads to
1726 forces perpendicular to the pull vector on the two groups
1727 defining the vector. If you want a pull group to move between
1728 the two groups defining the vector, simply use the union of
1729 these two groups as the reference group.
1731 .. mdp-value:: cylinder
1733 Designed for pulling with respect to a layer where the reference
1734 COM is given by a local cylindrical part of the reference group.
1735 The pulling is in the direction of :mdp:`pull-coord1-vec`. From
1736 the first of the two groups in :mdp:`pull-coord1-groups` a
1737 cylinder is selected around the axis going through the COM of
1738 the second group with direction :mdp:`pull-coord1-vec` with
1739 radius :mdp:`pull-cylinder-r`. Weights of the atoms decrease
1740 continously to zero as the radial distance goes from 0 to
1741 :mdp:`pull-cylinder-r` (mass weighting is also used). The radial
1742 dependence gives rise to radial forces on both pull groups.
1743 Note that the radius should be smaller than half the box size.
1744 For tilted cylinders they should be even smaller than half the
1745 box size since the distance of an atom in the reference group
1746 from the COM of the pull group has both a radial and an axial
1747 component. This geometry is not supported with constraint
1750 .. mdp-value:: angle
1752 Pull along an angle defined by four groups. The angle is
1753 defined as the angle between two vectors: the vector connecting
1754 the COM of the first group to the COM of the second group and
1755 the vector connecting the COM of the third group to the COM of
1758 .. mdp-value:: angle-axis
1760 As :mdp-value:`pull-coord1-geometry=angle` but the second vector is given by :mdp:`pull-coord1-vec`.
1761 Thus, only the two groups that define the first vector need to be given.
1763 .. mdp-value:: dihedral
1765 Pull along a dihedral angle defined by six groups. These pairwise
1766 define three vectors: the vector connecting the COM of group 1
1767 to the COM of group 2, the COM of group 3 to the COM of group 4,
1768 and the COM of group 5 to the COM group 6. The dihedral angle is
1769 then defined as the angle between two planes: the plane spanned by the
1770 the two first vectors and the plane spanned the two last vectors.
1773 .. mdp:: pull-coord1-groups
1775 The group indices on which this pull coordinate will operate.
1776 The number of group indices required is geometry dependent.
1777 The first index can be 0, in which case an
1778 absolute reference of :mdp:`pull-coord1-origin` is used. With an
1779 absolute reference the system is no longer translation invariant
1780 and one should think about what to do with the center of mass
1783 .. mdp:: pull-coord1-dim
1786 Selects the dimensions that this pull coordinate acts on and that
1787 are printed to the output files when
1788 :mdp:`pull-print-components` = :mdp-value:`pull-coord1-start=yes`. With
1789 :mdp:`pull-coord1-geometry` = :mdp-value:`pull-coord1-geometry=distance`, only Cartesian
1790 components set to Y contribute to the distance. Thus setting this
1791 to Y Y N results in a distance in the x/y plane. With other
1792 geometries all dimensions with non-zero entries in
1793 :mdp:`pull-coord1-vec` should be set to Y, the values for other
1794 dimensions only affect the output.
1796 .. mdp:: pull-coord1-origin
1799 The pull reference position for use with an absolute reference.
1801 .. mdp:: pull-coord1-vec
1804 The pull direction. :ref:`gmx grompp` normalizes the vector.
1806 .. mdp:: pull-coord1-start
1810 do not modify :mdp:`pull-coord1-init`
1814 add the COM distance of the starting conformation to
1815 :mdp:`pull-coord1-init`
1817 .. mdp:: pull-coord1-init
1819 (0.0) \[nm\] / \[deg\]
1820 The reference distance at t=0.
1822 .. mdp:: pull-coord1-rate
1824 (0) \[nm/ps\] / \[deg/ps\]
1825 The rate of change of the reference position.
1827 .. mdp:: pull-coord1-k
1829 (0) \[kJ mol-1 nm-2\] / \[kJ mol-1 nm-1\] / \[kJ mol-1 rad-2\] / \[kJ mol-1 rad-1\]
1830 The force constant. For umbrella pulling this is the harmonic force
1831 constant in kJ mol-1 nm-2 (or kJ mol-1 rad-2 for angles). For constant force pulling this is the
1832 force constant of the linear potential, and thus the negative (!)
1833 of the constant force in kJ mol-1 nm-1 (or kJ mol-1 rad-1 for angles).
1834 Note that for angles the force constant is expressed in terms of radians
1835 (while :mdp:`pull-coord1-init` and :mdp:`pull-coord1-rate` are expressed in degrees).
1837 .. mdp:: pull-coord1-kB
1839 (pull-k1) \[kJ mol-1 nm-2\] / \[kJ mol-1 nm-1\] / \[kJ mol-1 rad-2\] / \[kJ mol-1 rad-1\]
1840 As :mdp:`pull-coord1-k`, but for state B. This is only used when
1841 :mdp:`free-energy` is turned on. The force constant is then (1 -
1842 lambda) * :mdp:`pull-coord1-k` + lambda * :mdp:`pull-coord1-kB`.
1844 AWH adaptive biasing
1845 ^^^^^^^^^^^^^^^^^^^^
1855 Adaptively bias a reaction coordinate using the AWH method and estimate
1856 the corresponding PMF. The PMF and other AWH data are written to energy
1857 file at an interval set by :mdp:`awh-nstout` and can be extracted with
1858 the ``gmx awh`` tool. The AWH coordinate can be
1859 multidimensional and is defined by mapping each dimension to a pull coordinate index.
1860 This is only allowed if :mdp-value:`pull-coord1-type=external-potential` and
1861 :mdp:`pull-coord1-potential-provider` = ``awh`` for the concerned pull coordinate
1864 .. mdp:: awh-potential
1866 .. mdp-value:: convolved
1868 The applied biasing potential is the convolution of the bias function and a
1869 set of harmonic umbrella potentials (see :mdp-value:`awh-potential=umbrella` below). This results
1870 in a smooth potential function and force. The resolution of the potential is set
1871 by the force constant of each umbrella, see :mdp:`awh1-dim1-force-constant`.
1873 .. mdp-value:: umbrella
1875 The potential bias is applied by controlling the position of an harmonic potential
1876 using Monte-Carlo sampling. The force constant is set with
1877 :mdp:`awh1-dim1-force-constant`. The umbrella location
1878 is sampled using Monte-Carlo every :mdp:`awh-nstsample` steps.
1879 There are no advantages to using an umbrella.
1880 This option is mainly for comparison and testing purposes.
1882 .. mdp:: awh-share-multisim
1886 AWH will not share biases across simulations started with
1887 :ref:`gmx mdrun` option ``-multidir``. The biases will be independent.
1891 With :ref:`gmx mdrun` and option ``-multidir`` the bias and PMF estimates
1892 for biases with :mdp:`awh1-share-group` >0 will be shared across simulations
1893 with the biases with the same :mdp:`awh1-share-group` value.
1894 The simulations should have the same AWH settings for sharing to make sense.
1895 :ref:`gmx mdrun` will check whether the simulations are technically
1896 compatible for sharing, but the user should check that bias sharing
1897 physically makes sense.
1901 (-1) Random seed for Monte-Carlo sampling the umbrella position,
1902 where -1 indicates to generate a seed. Only used with
1903 :mdp-value:`awh-potential=umbrella`.
1908 Number of steps between printing AWH data to the energy file, should be
1909 a multiple of :mdp:`nstenergy`.
1911 .. mdp:: awh-nstsample
1914 Number of steps between sampling of the coordinate value. This sampling
1915 is the basis for updating the bias and estimating the PMF and other AWH observables.
1917 .. mdp:: awh-nsamples-update
1920 The number of coordinate samples used for each AWH update.
1921 The update interval in steps is :mdp:`awh-nstsample` times this value.
1926 The number of biases, each acting on its own coordinate.
1927 The following options should be specified
1928 for each bias although below only the options for bias number 1 is shown. Options for
1929 other bias indices are obtained by replacing '1' by the bias index.
1931 .. mdp:: awh1-error-init
1934 Estimated initial average error of the PMF for this bias. This value together with the
1935 given diffusion constant(s) :mdp:`awh1-dim1-diffusion` determine the initial biasing rate.
1936 The error is obviously not known *a priori*. Only a rough estimate of :mdp:`awh1-error-init`
1938 As a general guideline, leave :mdp:`awh1-error-init` to its default value when starting a new
1939 simulation. On the other hand, when there is *a priori* knowledge of the PMF (e.g. when
1940 an initial PMF estimate is provided, see the :mdp:`awh1-user-data` option)
1941 then :mdp:`awh1-error-init` should reflect that knowledge.
1943 .. mdp:: awh1-growth
1945 .. mdp-value:: exp-linear
1947 Each bias keeps a reference weight histogram for the coordinate samples.
1948 Its size sets the magnitude of the bias function and free energy estimate updates
1949 (few samples corresponds to large updates and vice versa).
1950 Thus, its growth rate sets the maximum convergence rate.
1951 By default, there is an initial stage in which the histogram grows close to exponentially (but slower than the sampling rate).
1952 In the final stage that follows, the growth rate is linear and equal to the sampling rate (set by :mdp:`awh-nstsample`).
1953 The initial stage is typically necessary for efficient convergence when starting a new simulation where
1954 high free energy barriers have not yet been flattened by the bias.
1956 .. mdp-value:: linear
1958 As :mdp-value:`awh1-growth=exp-linear` but skip the initial stage. This may be useful if there is *a priori*
1959 knowledge (see :mdp:`awh1-error-init`) which eliminates the need for an initial stage. This is also
1960 the setting compatible with :mdp-value:`awh1-target=local-boltzmann`.
1962 .. mdp:: awh1-equilibrate-histogram
1966 Do not equilibrate histogram.
1970 Before entering the initial stage (see :mdp-value:`awh1-growth=exp-linear`), make sure the
1971 histogram of sampled weights is following the target distribution closely enough (specifically,
1972 at least 80% of the target region needs to have a local relative error of less than 20%). This
1973 option would typically only be used when :mdp:`awh1-share-group` > 0
1974 and the initial configurations poorly represent the target
1977 .. mdp:: awh1-target
1979 .. mdp-value:: constant
1981 The bias is tuned towards a constant (uniform) coordinate distribution
1982 in the defined sampling interval (defined by \[:mdp:`awh1-dim1-start`, :mdp:`awh1-dim1-end`\]).
1984 .. mdp-value:: cutoff
1986 Similar to :mdp-value:`awh1-target=constant`, but the target
1987 distribution is proportional to 1/(1 + exp(F - :mdp-value:`awh1-target=cutoff`)),
1988 where F is the free energy relative to the estimated global minimum.
1989 This provides a smooth switch of a flat target distribution in
1990 regions with free energy lower than the cut-off to a Boltzmann
1991 distribution in regions with free energy higher than the cut-off.
1993 .. mdp-value:: boltzmann
1995 The target distribution is a Boltzmann distribtution with a scaled beta (inverse temperature)
1996 factor given by :mdp:`awh1-target-beta-scaling`. *E.g.*, a value of 0.1
1997 would give the same coordinate distribution as sampling with a simulation temperature
2000 .. mdp-value:: local-boltzmann
2002 Same target distribution and use of :mdp:`awh1-target-beta-scaling`
2003 but the convergence towards the target distribution is inherently local *i.e.*, the rate of
2004 change of the bias only depends on the local sampling. This local convergence property is
2005 only compatible with :mdp-value:`awh1-growth=linear`, since for
2006 :mdp-value:`awh1-growth=exp-linear` histograms are globally rescaled in the initial stage.
2008 .. mdp:: awh1-target-beta-scaling
2011 For :mdp-value:`awh1-target=boltzmann` and :mdp-value:`awh1-target=local-boltzmann`
2012 it is the unitless beta scaling factor taking values in (0,1).
2014 .. mdp:: awh1-target-cutoff
2017 For :mdp-value:`awh1-target=cutoff` this is the cutoff, should be > 0.
2019 .. mdp:: awh1-user-data
2023 Initialize the PMF and target distribution with default values.
2027 Initialize the PMF and target distribution with user provided data. For :mdp:`awh-nbias` = 1,
2028 :ref:`gmx mdrun` will expect a file ``awhinit.xvg`` to be present in the run directory.
2029 For multiple biases, :ref:`gmx mdrun` expects files ``awhinit1.xvg``, ``awhinit2.xvg``, etc.
2030 The file name can be changed with the ``-awh`` option.
2031 The first :mdp:`awh1-ndim` columns of
2032 each input file should contain the coordinate values, such that each row defines a point in
2033 coordinate space. Column :mdp:`awh1-ndim` + 1 should contain the PMF value for each point.
2034 The target distribution column can either follow the PMF (column :mdp:`awh1-ndim` + 2) or
2035 be in the same column as written by :ref:`gmx awh`.
2037 .. mdp:: awh1-share-group
2041 Do not share the bias.
2043 .. mdp-value:: positive
2045 Share the bias and PMF estimates within and/or between simulations.
2046 Within a simulation, the bias will be shared between biases that have the
2047 same :mdp:`awh1-share-group` index (note that the current code does not support this).
2048 With :mdp-value:`awh-share-multisim=yes` and
2049 :ref:`gmx mdrun` option ``-multidir`` the bias will also be shared across simulations.
2050 Sharing may increase convergence initially, although the starting configurations
2051 can be critical, especially when sharing between many biases.
2052 Currently, positive group values should start at 1 and increase
2053 by 1 for each subsequent bias that is shared.
2058 Number of dimensions of the coordinate, each dimension maps to 1 pull coordinate.
2059 The following options should be specified for each such dimension. Below only
2060 the options for dimension number 1 is shown. Options for other dimension indices are
2061 obtained by replacing '1' by the dimension index.
2063 .. mdp:: awh1-dim1-coord-provider
2067 The module providing the reaction coordinate for this dimension.
2068 Currently AWH can only act on pull coordinates.
2070 .. mdp:: awh1-dim1-coord-index
2073 Index of the pull coordinate defining this coordinate dimension.
2075 .. mdp:: awh1-dim1-force-constant
2077 (0) \[kJ/mol/nm^2\] or \[kJ/mol/rad^2\]
2078 Force constant for the (convolved) umbrella potential(s) along this
2079 coordinate dimension.
2081 .. mdp:: awh1-dim1-start
2083 (0.0) \[nm\]/\[rad\]
2084 Start value of the sampling interval along this dimension. The range of allowed
2085 values depends on the relevant pull geometry (see :mdp:`pull-coord1-geometry`).
2086 For periodic geometries :mdp:`awh1-dim1-start` greater than :mdp:`awh1-dim1-end`
2087 is allowed. The interval will then wrap around from +period/2 to -period/2.
2089 .. mdp:: awh1-dim1-end
2091 (0.0) \[nm\]/\[rad\]
2092 End value defining the sampling interval together with :mdp:`awh1-dim1-start`.
2094 .. mdp:: awh1-dim1-period
2096 (0.0) \[nm\]/\[rad\]
2097 The period of this reaction coordinate, use 0 when the coordinate is not periodic.
2099 .. mdp:: awh1-dim1-diffusion
2101 (1e-5) \[nm^2/ps\]/\[rad^2/ps\]
2102 Estimated diffusion constant for this coordinate dimension determining the initial
2103 biasing rate. This needs only be a rough estimate and should not critically
2104 affect the results unless it is set to something very low, leading to slow convergence,
2105 or very high, forcing the system far from equilibrium. Not setting this value
2106 explicitly generates a warning.
2108 .. mdp:: awh1-dim1-cover-diameter
2110 (0.0)) \[nm\]/\[rad\]
2111 Diameter that needs to be sampled by a single simulation around a coordinate value
2112 before the point is considered covered in the initial stage (see :mdp-value:`awh1-growth=exp-linear`).
2113 A value > 0 ensures that for each covering there is a continuous transition of this diameter
2114 across each coordinate value.
2115 This is trivially true for independent simulations but not for for multiple bias-sharing simulations
2116 (:mdp:`awh1-share-group`>0).
2117 For a diameter = 0, covering occurs as soon as the simulations have sampled the whole interval, which
2118 for many sharing simulations does not guarantee transitions across free energy barriers.
2119 On the other hand, when the diameter >= the sampling interval length, covering occurs when a single simulation
2120 has independently sampled the whole interval.
2125 These :ref:`mdp` parameters can be used enforce the rotation of a group of atoms,
2126 e.g. a protein subunit. The `reference manual`_ describes in detail 13 different potentials
2127 that can be used to achieve such a rotation.
2133 No enforced rotation will be applied. All enforced rotation options will
2134 be ignored (and if present in the :ref:`mdp` file, they unfortunately
2139 Apply the rotation potential specified by :mdp:`rot-type0` to the group of atoms given
2140 under the :mdp:`rot-group0` option.
2142 .. mdp:: rot-ngroups
2145 Number of rotation groups.
2149 Name of rotation group 0 in the index file.
2154 Type of rotation potential that is applied to rotation group 0. Can be of of the following:
2155 ``iso``, ``iso-pf``, ``pm``, ``pm-pf``, ``rm``, ``rm-pf``, ``rm2``, ``rm2-pf``,
2156 ``flex``, ``flex-t``, ``flex2``, or ``flex2-t``.
2161 Use mass weighted rotation group positions.
2166 Rotation vector, will get normalized.
2171 Pivot point (nm) for the potentials ``iso``, ``pm``, ``rm``, and ``rm2``.
2176 Reference rotation rate (degree/ps) of group 0.
2181 Force constant (kJ/(mol*nm^2)) for group 0.
2183 .. mdp:: rot-slab-dist0
2186 Slab distance (nm), if a flexible axis rotation type was chosen.
2188 .. mdp:: rot-min-gauss0
2191 Minimum value (cutoff) of Gaussian function for the force to be evaluated
2192 (for the flexible axis potentials).
2197 Value of additive constant epsilon' (nm^2) for ``rm2*`` and ``flex2*`` potentials.
2199 .. mdp:: rot-fit-method0
2202 Fitting method when determining the actual angle of a rotation group
2203 (can be one of ``rmsd``, ``norm``, or ``potential``).
2205 .. mdp:: rot-potfit-nsteps0
2208 For fit type ``potential``, the number of angular positions around the reference angle for which the
2209 rotation potential is evaluated.
2211 .. mdp:: rot-potfit-step0
2214 For fit type ``potential``, the distance in degrees between two angular positions.
2216 .. mdp:: rot-nstrout
2219 Output frequency (in steps) for the angle of the rotation group, as well as for the torque
2220 and the rotation potential energy.
2222 .. mdp:: rot-nstsout
2225 Output frequency for per-slab data of the flexible axis potentials, i.e. angles, torques and slab centers.
2235 ignore distance restraint information in topology file
2237 .. mdp-value:: simple
2239 simple (per-molecule) distance restraints.
2241 .. mdp-value:: ensemble
2243 distance restraints over an ensemble of molecules in one
2244 simulation box. Normally, one would perform ensemble averaging
2245 over multiple simulations, using ``mdrun
2246 -multidir``. The environment
2247 variable ``GMX_DISRE_ENSEMBLE_SIZE`` sets the number of systems
2248 within each ensemble (usually equal to the number of directories
2249 supplied to ``mdrun -multidir``).
2251 .. mdp:: disre-weighting
2253 .. mdp-value:: equal
2255 divide the restraint force equally over all atom pairs in the
2258 .. mdp-value:: conservative
2260 the forces are the derivative of the restraint potential, this
2261 results in an weighting of the atom pairs to the reciprocal
2262 seventh power of the displacement. The forces are conservative
2263 when :mdp:`disre-tau` is zero.
2265 .. mdp:: disre-mixed
2269 the violation used in the calculation of the restraint force is
2270 the time-averaged violation
2274 the violation used in the calculation of the restraint force is
2275 the square root of the product of the time-averaged violation
2276 and the instantaneous violation
2280 (1000) \[kJ mol-1 nm-2\]
2281 force constant for distance restraints, which is multiplied by a
2282 (possibly) different factor for each restraint given in the `fac`
2283 column of the interaction in the topology file.
2288 time constant for distance restraints running average. A value of
2289 zero turns off time averaging.
2291 .. mdp:: nstdisreout
2294 period between steps when the running time-averaged and
2295 instantaneous distances of all atom pairs involved in restraints
2296 are written to the energy file (can make the energy file very
2303 ignore orientation restraint information in topology file
2307 use orientation restraints, ensemble averaging can be performed
2308 with ``mdrun -multidir``
2313 force constant for orientation restraints, which is multiplied by a
2314 (possibly) different weight factor for each restraint, can be set
2315 to zero to obtain the orientations from a free simulation
2320 time constant for orientation restraints running average. A value
2321 of zero turns off time averaging.
2323 .. mdp:: orire-fitgrp
2325 fit group for orientation restraining. This group of atoms is used
2326 to determine the rotation **R** of the system with respect to the
2327 reference orientation. The reference orientation is the starting
2328 conformation of the first subsystem. For a protein, backbone is a
2331 .. mdp:: nstorireout
2334 period between steps when the running time-averaged and
2335 instantaneous orientations for all restraints, and the molecular
2336 order tensor are written to the energy file (can make the energy
2340 Free energy calculations
2341 ^^^^^^^^^^^^^^^^^^^^^^^^
2343 .. mdp:: free-energy
2347 Only use topology A.
2351 Interpolate between topology A (lambda=0) to topology B
2352 (lambda=1) and write the derivative of the Hamiltonian with
2353 respect to lambda (as specified with :mdp:`dhdl-derivatives`),
2354 or the Hamiltonian differences with respect to other lambda
2355 values (as specified with foreign lambda) to the energy file
2356 and/or to ``dhdl.xvg``, where they can be processed by, for
2357 example :ref:`gmx bar`. The potentials, bond-lengths and angles
2358 are interpolated linearly as described in the manual. When
2359 :mdp:`sc-alpha` is larger than zero, soft-core potentials are
2360 used for the LJ and Coulomb interactions.
2364 Turns on expanded ensemble simulation, where the alchemical state
2365 becomes a dynamic variable, allowing jumping between different
2366 Hamiltonians. See the expanded ensemble options for controlling how
2367 expanded ensemble simulations are performed. The different
2368 Hamiltonians used in expanded ensemble simulations are defined by
2369 the other free energy options.
2371 .. mdp:: init-lambda
2374 starting value for lambda (float). Generally, this should only be
2375 used with slow growth (*i.e.* nonzero :mdp:`delta-lambda`). In
2376 other cases, :mdp:`init-lambda-state` should be specified
2377 instead. Must be greater than or equal to 0.
2379 .. mdp:: delta-lambda
2382 increment per time step for lambda
2384 .. mdp:: init-lambda-state
2387 starting value for the lambda state (integer). Specifies which
2388 columm of the lambda vector (:mdp:`coul-lambdas`,
2389 :mdp:`vdw-lambdas`, :mdp:`bonded-lambdas`,
2390 :mdp:`restraint-lambdas`, :mdp:`mass-lambdas`,
2391 :mdp:`temperature-lambdas`, :mdp:`fep-lambdas`) should be
2392 used. This is a zero-based index: :mdp:`init-lambda-state` 0 means
2393 the first column, and so on.
2395 .. mdp:: fep-lambdas
2398 Zero, one or more lambda values for which Delta H values will be
2399 determined and written to dhdl.xvg every :mdp:`nstdhdl`
2400 steps. Values must be between 0 and 1. Free energy differences
2401 between different lambda values can then be determined with
2402 :ref:`gmx bar`. :mdp:`fep-lambdas` is different from the
2403 other -lambdas keywords because all components of the lambda vector
2404 that are not specified will use :mdp:`fep-lambdas` (including
2405 :mdp:`restraint-lambdas` and therefore the pull code restraints).
2407 .. mdp:: coul-lambdas
2410 Zero, one or more lambda values for which Delta H values will be
2411 determined and written to dhdl.xvg every :mdp:`nstdhdl`
2412 steps. Values must be between 0 and 1. Only the electrostatic
2413 interactions are controlled with this component of the lambda
2414 vector (and only if the lambda=0 and lambda=1 states have differing
2415 electrostatic interactions).
2417 .. mdp:: vdw-lambdas
2420 Zero, one or more lambda values for which Delta H values will be
2421 determined and written to dhdl.xvg every :mdp:`nstdhdl`
2422 steps. Values must be between 0 and 1. Only the van der Waals
2423 interactions are controlled with this component of the lambda
2426 .. mdp:: bonded-lambdas
2429 Zero, one or more lambda values for which Delta H values will be
2430 determined and written to dhdl.xvg every :mdp:`nstdhdl`
2431 steps. Values must be between 0 and 1. Only the bonded interactions
2432 are controlled with this component of the lambda vector.
2434 .. mdp:: restraint-lambdas
2437 Zero, one or more lambda values for which Delta H values will be
2438 determined and written to dhdl.xvg every :mdp:`nstdhdl`
2439 steps. Values must be between 0 and 1. Only the restraint
2440 interactions: dihedral restraints, and the pull code restraints are
2441 controlled with this component of the lambda vector.
2443 .. mdp:: mass-lambdas
2446 Zero, one or more lambda values for which Delta H values will be
2447 determined and written to dhdl.xvg every :mdp:`nstdhdl`
2448 steps. Values must be between 0 and 1. Only the particle masses are
2449 controlled with this component of the lambda vector.
2451 .. mdp:: temperature-lambdas
2454 Zero, one or more lambda values for which Delta H values will be
2455 determined and written to dhdl.xvg every :mdp:`nstdhdl`
2456 steps. Values must be between 0 and 1. Only the temperatures
2457 controlled with this component of the lambda vector. Note that
2458 these lambdas should not be used for replica exchange, only for
2459 simulated tempering.
2461 .. mdp:: calc-lambda-neighbors
2464 Controls the number of lambda values for which Delta H values will
2465 be calculated and written out, if :mdp:`init-lambda-state` has
2466 been set. A positive value will limit the number of lambda points
2467 calculated to only the nth neighbors of :mdp:`init-lambda-state`:
2468 for example, if :mdp:`init-lambda-state` is 5 and this parameter
2469 has a value of 2, energies for lambda points 3-7 will be calculated
2470 and writen out. A value of -1 means all lambda points will be
2471 written out. For normal BAR such as with :ref:`gmx bar`, a value of
2472 1 is sufficient, while for MBAR -1 should be used.
2477 the soft-core alpha parameter, a value of 0 results in linear
2478 interpolation of the LJ and Coulomb interactions
2483 the power of the radial term in the soft-core equation. Possible
2484 values are 6 and 48. 6 is more standard, and is the default. When
2485 48 is used, then sc-alpha should generally be much lower (between
2491 Whether to apply the soft-core free energy interaction
2492 transformation to the Columbic interaction of a molecule. Default
2493 is no, as it is generally more efficient to turn off the Coulomic
2494 interactions linearly before turning off the van der Waals
2495 interactions. Note that it is only taken into account when lambda
2496 states are used, not with :mdp:`couple-lambda0` /
2497 :mdp:`couple-lambda1`, and you can still turn off soft-core
2498 interactions by setting :mdp:`sc-alpha` to 0.
2503 the power for lambda in the soft-core function, only the values 1
2509 the soft-core sigma for particles which have a C6 or C12 parameter
2510 equal to zero or a sigma smaller than :mdp:`sc-sigma`
2512 .. mdp:: couple-moltype
2514 Here one can supply a molecule type (as defined in the topology)
2515 for calculating solvation or coupling free energies. There is a
2516 special option ``system`` that couples all molecule types in the
2517 system. This can be useful for equilibrating a system starting from
2518 (nearly) random coordinates. :mdp:`free-energy` has to be turned
2519 on. The Van der Waals interactions and/or charges in this molecule
2520 type can be turned on or off between lambda=0 and lambda=1,
2521 depending on the settings of :mdp:`couple-lambda0` and
2522 :mdp:`couple-lambda1`. If you want to decouple one of several
2523 copies of a molecule, you need to copy and rename the molecule
2524 definition in the topology.
2526 .. mdp:: couple-lambda0
2528 .. mdp-value:: vdw-q
2530 all interactions are on at lambda=0
2534 the charges are zero (no Coulomb interactions) at lambda=0
2538 the Van der Waals interactions are turned at lambda=0; soft-core
2539 interactions will be required to avoid singularities
2543 the Van der Waals interactions are turned off and the charges
2544 are zero at lambda=0; soft-core interactions will be required to
2545 avoid singularities.
2547 .. mdp:: couple-lambda1
2549 analogous to :mdp:`couple-lambda1`, but for lambda=1
2551 .. mdp:: couple-intramol
2555 All intra-molecular non-bonded interactions for moleculetype
2556 :mdp:`couple-moltype` are replaced by exclusions and explicit
2557 pair interactions. In this manner the decoupled state of the
2558 molecule corresponds to the proper vacuum state without
2559 periodicity effects.
2563 The intra-molecular Van der Waals and Coulomb interactions are
2564 also turned on/off. This can be useful for partitioning
2565 free-energies of relatively large molecules, where the
2566 intra-molecular non-bonded interactions might lead to
2567 kinetically trapped vacuum conformations. The 1-4 pair
2568 interactions are not turned off.
2573 the frequency for writing dH/dlambda and possibly Delta H to
2574 dhdl.xvg, 0 means no ouput, should be a multiple of
2575 :mdp:`nstcalcenergy`.
2577 .. mdp:: dhdl-derivatives
2581 If yes (the default), the derivatives of the Hamiltonian with
2582 respect to lambda at each :mdp:`nstdhdl` step are written
2583 out. These values are needed for interpolation of linear energy
2584 differences with :ref:`gmx bar` (although the same can also be
2585 achieved with the right foreign lambda setting, that may not be as
2586 flexible), or with thermodynamic integration
2588 .. mdp:: dhdl-print-energy
2592 Include either the total or the potential energy in the dhdl
2593 file. Options are 'no', 'potential', or 'total'. This information
2594 is needed for later free energy analysis if the states of interest
2595 are at different temperatures. If all states are at the same
2596 temperature, this information is not needed. 'potential' is useful
2597 in case one is using ``mdrun -rerun`` to generate the ``dhdl.xvg``
2598 file. When rerunning from an existing trajectory, the kinetic
2599 energy will often not be correct, and thus one must compute the
2600 residual free energy from the potential alone, with the kinetic
2601 energy component computed analytically.
2603 .. mdp:: separate-dhdl-file
2607 The free energy values that are calculated (as specified with
2608 the foreign lambda and :mdp:`dhdl-derivatives` settings) are
2609 written out to a separate file, with the default name
2610 ``dhdl.xvg``. This file can be used directly with :ref:`gmx
2615 The free energy values are written out to the energy output file
2616 (``ener.edr``, in accumulated blocks at every :mdp:`nstenergy`
2617 steps), where they can be extracted with :ref:`gmx energy` or
2618 used directly with :ref:`gmx bar`.
2620 .. mdp:: dh-hist-size
2623 If nonzero, specifies the size of the histogram into which the
2624 Delta H values (specified with foreign lambda) and the derivative
2625 dH/dl values are binned, and written to ener.edr. This can be used
2626 to save disk space while calculating free energy differences. One
2627 histogram gets written for each foreign lambda and two for the
2628 dH/dl, at every :mdp:`nstenergy` step. Be aware that incorrect
2629 histogram settings (too small size or too wide bins) can introduce
2630 errors. Do not use histograms unless you're certain you need it.
2632 .. mdp:: dh-hist-spacing
2635 Specifies the bin width of the histograms, in energy units. Used in
2636 conjunction with :mdp:`dh-hist-size`. This size limits the
2637 accuracy with which free energies can be calculated. Do not use
2638 histograms unless you're certain you need it.
2641 Expanded Ensemble calculations
2642 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2644 .. mdp:: nstexpanded
2646 The number of integration steps beween attempted moves changing the
2647 system Hamiltonian in expanded ensemble simulations. Must be a
2648 multiple of :mdp:`nstcalcenergy`, but can be greater or less than
2655 No Monte Carlo in state space is performed.
2657 .. mdp-value:: metropolis-transition
2659 Uses the Metropolis weights to update the expanded ensemble
2660 weight of each state. Min{1,exp(-(beta_new u_new - beta_old
2663 .. mdp-value:: barker-transition
2665 Uses the Barker transition critera to update the expanded
2666 ensemble weight of each state i, defined by exp(-beta_new
2667 u_new)/(exp(-beta_new u_new)+exp(-beta_old u_old))
2669 .. mdp-value:: wang-landau
2671 Uses the Wang-Landau algorithm (in state space, not energy
2672 space) to update the expanded ensemble weights.
2674 .. mdp-value:: min-variance
2676 Uses the minimum variance updating method of Escobedo et al. to
2677 update the expanded ensemble weights. Weights will not be the
2678 free energies, but will rather emphasize states that need more
2679 sampling to give even uncertainty.
2681 .. mdp:: lmc-mc-move
2685 No Monte Carlo in state space is performed.
2687 .. mdp-value:: metropolis-transition
2689 Randomly chooses a new state up or down, then uses the
2690 Metropolis critera to decide whether to accept or reject:
2691 Min{1,exp(-(beta_new u_new - beta_old u_old)}
2693 .. mdp-value:: barker-transition
2695 Randomly chooses a new state up or down, then uses the Barker
2696 transition critera to decide whether to accept or reject:
2697 exp(-beta_new u_new)/(exp(-beta_new u_new)+exp(-beta_old u_old))
2699 .. mdp-value:: gibbs
2701 Uses the conditional weights of the state given the coordinate
2702 (exp(-beta_i u_i) / sum_k exp(beta_i u_i) to decide which state
2705 .. mdp-value:: metropolized-gibbs
2707 Uses the conditional weights of the state given the coordinate
2708 (exp(-beta_i u_i) / sum_k exp(beta_i u_i) to decide which state
2709 to move to, EXCLUDING the current state, then uses a rejection
2710 step to ensure detailed balance. Always more efficient that
2711 Gibbs, though only marginally so in many situations, such as
2712 when only the nearest neighbors have decent phase space
2718 random seed to use for Monte Carlo moves in state space. When
2719 :mdp:`lmc-seed` is set to -1, a pseudo random seed is us
2721 .. mdp:: mc-temperature
2723 Temperature used for acceptance/rejection for Monte Carlo moves. If
2724 not specified, the temperature of the simulation specified in the
2725 first group of :mdp:`ref-t` is used.
2730 The cutoff for the histogram of state occupancies to be reset, and
2731 the free energy incrementor to be changed from delta to delta *
2732 :mdp:`wl-scale`. If we define the Nratio = (number of samples at
2733 each histogram) / (average number of samples at each
2734 histogram). :mdp:`wl-ratio` of 0.8 means that means that the
2735 histogram is only considered flat if all Nratio > 0.8 AND
2736 simultaneously all 1/Nratio > 0.8.
2741 Each time the histogram is considered flat, then the current value
2742 of the Wang-Landau incrementor for the free energies is multiplied
2743 by :mdp:`wl-scale`. Value must be between 0 and 1.
2745 .. mdp:: init-wl-delta
2748 The initial value of the Wang-Landau incrementor in kT. Some value
2749 near 1 kT is usually most efficient, though sometimes a value of
2750 2-3 in units of kT works better if the free energy differences are
2753 .. mdp:: wl-oneovert
2756 Set Wang-Landau incrementor to scale with 1/(simulation time) in
2757 the large sample limit. There is significant evidence that the
2758 standard Wang-Landau algorithms in state space presented here
2759 result in free energies getting 'burned in' to incorrect values
2760 that depend on the initial state. when :mdp:`wl-oneovert` is true,
2761 then when the incrementor becomes less than 1/N, where N is the
2762 mumber of samples collected (and thus proportional to the data
2763 collection time, hence '1 over t'), then the Wang-Lambda
2764 incrementor is set to 1/N, decreasing every step. Once this occurs,
2765 :mdp:`wl-ratio` is ignored, but the weights will still stop
2766 updating when the equilibration criteria set in
2767 :mdp:`lmc-weights-equil` is achieved.
2769 .. mdp:: lmc-repeats
2772 Controls the number of times that each Monte Carlo swap type is
2773 performed each iteration. In the limit of large numbers of Monte
2774 Carlo repeats, then all methods converge to Gibbs sampling. The
2775 value will generally not need to be different from 1.
2777 .. mdp:: lmc-gibbsdelta
2780 Limit Gibbs sampling to selected numbers of neighboring states. For
2781 Gibbs sampling, it is sometimes inefficient to perform Gibbs
2782 sampling over all of the states that are defined. A positive value
2783 of :mdp:`lmc-gibbsdelta` means that only states plus or minus
2784 :mdp:`lmc-gibbsdelta` are considered in exchanges up and down. A
2785 value of -1 means that all states are considered. For less than 100
2786 states, it is probably not that expensive to include all states.
2788 .. mdp:: lmc-forced-nstart
2791 Force initial state space sampling to generate weights. In order to
2792 come up with reasonable initial weights, this setting allows the
2793 simulation to drive from the initial to the final lambda state,
2794 with :mdp:`lmc-forced-nstart` steps at each state before moving on
2795 to the next lambda state. If :mdp:`lmc-forced-nstart` is
2796 sufficiently long (thousands of steps, perhaps), then the weights
2797 will be close to correct. However, in most cases, it is probably
2798 better to simply run the standard weight equilibration algorithms.
2800 .. mdp:: nst-transition-matrix
2803 Frequency of outputting the expanded ensemble transition matrix. A
2804 negative number means it will only be printed at the end of the
2807 .. mdp:: symmetrized-transition-matrix
2810 Whether to symmetrize the empirical transition matrix. In the
2811 infinite limit the matrix will be symmetric, but will diverge with
2812 statistical noise for short timescales. Forced symmetrization, by
2813 using the matrix T_sym = 1/2 (T + transpose(T)), removes problems
2814 like the existence of (small magnitude) negative eigenvalues.
2816 .. mdp:: mininum-var-min
2819 The min-variance strategy (option of :mdp:`lmc-stats` is only
2820 valid for larger number of samples, and can get stuck if too few
2821 samples are used at each state. :mdp:`mininum-var-min` is the
2822 minimum number of samples that each state that are allowed before
2823 the min-variance strategy is activated if selected.
2825 .. mdp:: init-lambda-weights
2827 The initial weights (free energies) used for the expanded ensemble
2828 states. Default is a vector of zero weights. format is similar to
2829 the lambda vector settings in :mdp:`fep-lambdas`, except the
2830 weights can be any floating point number. Units are kT. Its length
2831 must match the lambda vector lengths.
2833 .. mdp:: lmc-weights-equil
2837 Expanded ensemble weights continue to be updated throughout the
2842 The input expanded ensemble weights are treated as equilibrated,
2843 and are not updated throughout the simulation.
2845 .. mdp-value:: wl-delta
2847 Expanded ensemble weight updating is stopped when the
2848 Wang-Landau incrementor falls below this value.
2850 .. mdp-value:: number-all-lambda
2852 Expanded ensemble weight updating is stopped when the number of
2853 samples at all of the lambda states is greater than this value.
2855 .. mdp-value:: number-steps
2857 Expanded ensemble weight updating is stopped when the number of
2858 steps is greater than the level specified by this value.
2860 .. mdp-value:: number-samples
2862 Expanded ensemble weight updating is stopped when the number of
2863 total samples across all lambda states is greater than the level
2864 specified by this value.
2866 .. mdp-value:: count-ratio
2868 Expanded ensemble weight updating is stopped when the ratio of
2869 samples at the least sampled lambda state and most sampled
2870 lambda state greater than this value.
2872 .. mdp:: simulated-tempering
2875 Turn simulated tempering on or off. Simulated tempering is
2876 implemented as expanded ensemble sampling with different
2877 temperatures instead of different Hamiltonians.
2879 .. mdp:: sim-temp-low
2882 Low temperature for simulated tempering.
2884 .. mdp:: sim-temp-high
2887 High temperature for simulated tempering.
2889 .. mdp:: simulated-tempering-scaling
2891 Controls the way that the temperatures at intermediate lambdas are
2892 calculated from the :mdp:`temperature-lambdas` part of the lambda
2895 .. mdp-value:: linear
2897 Linearly interpolates the temperatures using the values of
2898 :mdp:`temperature-lambdas`, *i.e.* if :mdp:`sim-temp-low`
2899 =300, :mdp:`sim-temp-high` =400, then lambda=0.5 correspond to
2900 a temperature of 350. A nonlinear set of temperatures can always
2901 be implemented with uneven spacing in lambda.
2903 .. mdp-value:: geometric
2905 Interpolates temperatures geometrically between
2906 :mdp:`sim-temp-low` and :mdp:`sim-temp-high`. The i:th state
2907 has temperature :mdp:`sim-temp-low` * (:mdp:`sim-temp-high` /
2908 :mdp:`sim-temp-low`) raised to the power of
2909 (i/(ntemps-1)). This should give roughly equal exchange for
2910 constant heat capacity, though of course things simulations that
2911 involve protein folding have very high heat capacity peaks.
2913 .. mdp-value:: exponential
2915 Interpolates temperatures exponentially between
2916 :mdp:`sim-temp-low` and :mdp:`sim-temp-high`. The i:th state
2917 has temperature :mdp:`sim-temp-low` + (:mdp:`sim-temp-high` -
2918 :mdp:`sim-temp-low`)*((exp(:mdp:`temperature-lambdas`
2919 (i))-1)/(exp(1.0)-i)).
2927 groups for constant acceleration (*e.g.* ``Protein Sol``) all atoms
2928 in groups Protein and Sol will experience constant acceleration as
2929 specified in the :mdp:`accelerate` line
2934 acceleration for :mdp:`acc-grps`; x, y and z for each group
2935 (*e.g.* ``0.1 0.0 0.0 -0.1 0.0 0.0`` means that first group has
2936 constant acceleration of 0.1 nm ps-2 in X direction, second group
2941 Groups that are to be frozen (*i.e.* their X, Y, and/or Z position
2942 will not be updated; *e.g.* ``Lipid SOL``). :mdp:`freezedim`
2943 specifies for which dimension the freezing applies. To avoid
2944 spurious contributions to the virial and pressure due to large
2945 forces between completely frozen atoms you need to use energy group
2946 exclusions, this also saves computing time. Note that coordinates
2947 of frozen atoms are not scaled by pressure-coupling algorithms.
2951 dimensions for which groups in :mdp:`freezegrps` should be frozen,
2952 specify `Y` or `N` for X, Y and Z and for each group (*e.g.* ``Y Y
2953 N N N N`` means that particles in the first group can move only in
2954 Z direction. The particles in the second group can move in any
2957 .. mdp:: cos-acceleration
2960 the amplitude of the acceleration profile for calculating the
2961 viscosity. The acceleration is in the X-direction and the magnitude
2962 is :mdp:`cos-acceleration` cos(2 pi z/boxheight). Two terms are
2963 added to the energy file: the amplitude of the velocity profile and
2968 (0 0 0 0 0 0) \[nm ps-1\]
2969 The velocities of deformation for the box elements: a(x) b(y) c(z)
2970 b(x) c(x) c(y). Each step the box elements for which :mdp:`deform`
2971 is non-zero are calculated as: box(ts)+(t-ts)*deform, off-diagonal
2972 elements are corrected for periodicity. The coordinates are
2973 transformed accordingly. Frozen degrees of freedom are (purposely)
2974 also transformed. The time ts is set to t at the first step and at
2975 steps at which x and v are written to trajectory to ensure exact
2976 restarts. Deformation can be used together with semiisotropic or
2977 anisotropic pressure coupling when the appropriate
2978 compressibilities are set to zero. The diagonal elements can be
2979 used to strain a solid. The off-diagonal elements can be used to
2980 shear a solid or a liquid.
2986 .. mdp:: electric-field-x ; electric-field-y ; electric-field-z
2988 Here you can specify an electric field that optionally can be
2989 alternating and pulsed. The general expression for the field
2990 has the form of a gaussian laser pulse:
2992 E(t) = E0 exp ( -(t-t0)^2/(2 sigma^2) ) cos(omega (t-t0))
2994 For example, the four parameters for direction x are set in the
2995 three fields of :mdp:`electric-field-x` (and similar for y and z)
2998 electric-field-x = E0 omega t0 sigma
3000 In the special case that sigma = 0, the exponential term is omitted
3001 and only the cosine term is used. If also omega = 0 a static
3002 electric field is applied.
3004 More details in Carl Caleman and David van der Spoel: Picosecond
3005 Melting of Ice by an Infrared Laser Pulse - A Simulation Study
3006 Angew. Chem. Intl. Ed. 47 pp. 14 17-1420 (2008)
3010 Mixed quantum/classical molecular dynamics
3011 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3021 Do a QM/MM simulation. Several groups can be described at
3022 different QM levels separately. These are specified in the
3023 :mdp:`QMMM-grps` field separated by spaces. The level of *ab
3024 initio* theory at which the groups are described is specified by
3025 :mdp:`QMmethod` and :mdp:`QMbasis` Fields. Describing the
3026 groups at different levels of theory is only possible with the
3027 ONIOM QM/MM scheme, specified by :mdp:`QMMMscheme`.
3031 groups to be descibed at the QM level
3035 .. mdp-value:: normal
3037 normal QM/MM. There can only be one :mdp:`QMMM-grps` that is
3038 modelled at the :mdp:`QMmethod` and :mdp:`QMbasis` level of
3039 *ab initio* theory. The rest of the system is described at the
3040 MM level. The QM and MM subsystems interact as follows: MM point
3041 charges are included in the QM one-electron hamiltonian and all
3042 Lennard-Jones interactions are described at the MM level.
3044 .. mdp-value:: ONIOM
3046 The interaction between the subsystem is described using the
3047 ONIOM method by Morokuma and co-workers. There can be more than
3048 one :mdp:`QMMM-grps` each modeled at a different level of QM
3049 theory (:mdp:`QMmethod` and :mdp:`QMbasis`).
3054 Method used to compute the energy and gradients on the QM
3055 atoms. Available methods are AM1, PM3, RHF, UHF, DFT, B3LYP, MP2,
3056 CASSCF, and MMVB. For CASSCF, the number of electrons and orbitals
3057 included in the active space is specified by :mdp:`CASelectrons`
3058 and :mdp:`CASorbitals`.
3063 Basis set used to expand the electronic wavefuntion. Only Gaussian
3064 basis sets are currently available, *i.e.* ``STO-3G, 3-21G, 3-21G*,
3065 3-21+G*, 6-21G, 6-31G, 6-31G*, 6-31+G*,`` and ``6-311G``.
3070 The total charge in `e` of the :mdp:`QMMM-grps`. In case there are
3071 more than one :mdp:`QMMM-grps`, the total charge of each ONIOM
3072 layer needs to be specified separately.
3077 The multiplicity of the :mdp:`QMMM-grps`. In case there are more
3078 than one :mdp:`QMMM-grps`, the multiplicity of each ONIOM layer
3079 needs to be specified separately.
3081 .. mdp:: CASorbitals
3084 The number of orbitals to be included in the active space when
3085 doing a CASSCF computation.
3087 .. mdp:: CASelectrons
3090 The number of electrons to be included in the active space when
3091 doing a CASSCF computation.
3097 No surface hopping. The system is always in the electronic
3102 Do a QM/MM MD simulation on the excited state-potential energy
3103 surface and enforce a *diabatic* hop to the ground-state when
3104 the system hits the conical intersection hyperline in the course
3105 the simulation. This option only works in combination with the
3109 Computational Electrophysiology
3110 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3111 Use these options to switch on and control ion/water position exchanges in "Computational
3112 Electrophysiology" simulation setups. (See the `reference manual`_ for details).
3118 Do not enable ion/water position exchanges.
3120 .. mdp-value:: X ; Y ; Z
3122 Allow for ion/water position exchanges along the chosen direction.
3123 In a typical setup with the membranes parallel to the x-y plane,
3124 ion/water pairs need to be exchanged in Z direction to sustain the
3125 requested ion concentrations in the compartments.
3127 .. mdp:: swap-frequency
3129 (1) The swap attempt frequency, i.e. every how many time steps the ion counts
3130 per compartment are determined and exchanges made if necessary.
3131 Normally it is not necessary to check at every time step.
3132 For typical Computational Electrophysiology setups, a value of about 100 is
3133 sufficient and yields a negligible performance impact.
3135 .. mdp:: split-group0
3137 Name of the index group of the membrane-embedded part of channel #0.
3138 The center of mass of these atoms defines one of the compartment boundaries
3139 and should be chosen such that it is near the center of the membrane.
3141 .. mdp:: split-group1
3143 Channel #1 defines the position of the other compartment boundary.
3145 .. mdp:: massw-split0
3147 (no) Defines whether or not mass-weighting is used to calculate the split group center.
3151 Use the geometrical center.
3155 Use the center of mass.
3157 .. mdp:: massw-split1
3159 (no) As above, but for split-group #1.
3161 .. mdp:: solvent-group
3163 Name of the index group of solvent molecules.
3165 .. mdp:: coupl-steps
3167 (\10) Average the number of ions per compartment over these many swap attempt steps.
3168 This can be used to prevent that ions near a compartment boundary
3169 (diffusing through a channel, e.g.) lead to unwanted back and forth swaps.
3173 (1) The number of different ion types to be controlled. These are during the
3174 simulation exchanged with solvent molecules to reach the desired reference numbers.
3176 .. mdp:: iontype0-name
3178 Name of the first ion type.
3180 .. mdp:: iontype0-in-A
3182 (-1) Requested (=reference) number of ions of type 0 in compartment A.
3183 The default value of -1 means: use the number of ions as found in time step 0
3186 .. mdp:: iontype0-in-B
3188 (-1) Reference number of ions of type 0 for compartment B.
3190 .. mdp:: bulk-offsetA
3192 (0.0) Offset of the first swap layer from the compartment A midplane.
3193 By default (i.e. bulk offset = 0.0), ion/water exchanges happen between layers
3194 at maximum distance (= bulk concentration) to the split group layers. However,
3195 an offset b (-1.0 < b < +1.0) can be specified to offset the bulk layer from the middle at 0.0
3196 towards one of the compartment-partitioning layers (at +/- 1.0).
3198 .. mdp:: bulk-offsetB
3200 (0.0) Offset of the other swap layer from the compartment B midplane.
3205 (\1) Only swap ions if threshold difference to requested count is reached.
3209 (2.0) \[nm\] Radius of the split cylinder #0.
3210 Two split cylinders (mimicking the channel pores) can optionally be defined
3211 relative to the center of the split group. With the help of these cylinders
3212 it can be counted which ions have passed which channel. The split cylinder
3213 definition has no impact on whether or not ion/water swaps are done.
3217 (1.0) \[nm\] Upper extension of the split cylinder #0.
3221 (1.0) \[nm\] Lower extension of the split cylinder #0.
3225 (2.0) \[nm\] Radius of the split cylinder #1.
3229 (1.0) \[nm\] Upper extension of the split cylinder #1.
3233 (1.0) \[nm\] Lower extension of the split cylinder #1.
3236 User defined thingies
3237 ^^^^^^^^^^^^^^^^^^^^^
3241 .. mdp:: userint1 (0)
3242 .. mdp:: userint2 (0)
3243 .. mdp:: userint3 (0)
3244 .. mdp:: userint4 (0)
3245 .. mdp:: userreal1 (0)
3246 .. mdp:: userreal2 (0)
3247 .. mdp:: userreal3 (0)
3248 .. mdp:: userreal4 (0)
3250 These you can use if you modify code. You can pass integers and
3251 reals and groups to your subroutine. Check the inputrec definition
3252 in ``src/gromacs/mdtypes/inputrec.h``
3257 These features have been removed from |Gromacs|, but so that old
3258 :ref:`mdp` and :ref:`tpr` files cannot be mistakenly misused, we still
3259 parse this option. :ref:`gmx grompp` and :ref:`gmx mdrun` will issue a
3260 fatal error if this is set.
3266 .. mdp:: implicit-solvent
3270 .. _reference manual: gmx-manual-parent-dir_