doc/src/fix_colvars.txt

   1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
   2
   3 :link(lws,http://lammps.sandia.gov)
   4 :link(ld,Manual.html)
   5 :link(lc,Section_commands.html#comm)
   6
   7 :line
   8
   9 fix colvars command :h3
  10
  11 [Syntax:]
  12
  13 fix ID group-ID colvars configfile keyword values ... :pre
  14
  15 ID, group-ID are documented in "fix"_fix.html command :ulb,l
  16 colvars = style name of this fix command :l
  17 configfile = the configuration file for the colvars module :l
  18 keyword = {input} or {output} or {seed} or {tstat} :l
  19   {input} arg = colvars.state file name or prefix or NULL (default: NULL)
  20   {output} arg = output filename prefix (default: out)
  21   {seed} arg = seed for random number generator (default: 1966)
  22   {unwrap} arg = {yes} or {no}
  23     use unwrapped coordinates in collective variables (default: yes)
  24   {tstat} arg = fix id of a thermostat or NULL (default: NULL) :pre
  25 :ule
  26
  27 [Examples:]
  28
  29 fix mtd all colvars peptide.colvars.inp seed 2122 input peptide.colvars.state output peptide
  30 fix abf all colvars colvars.inp tstat 1 :pre
  31
  32 [Description:]
  33
  34 This fix interfaces LAMMPS to the collective variables "Colvars"
  35 library, which allows to calculate potentials of mean force
  36 (PMFs) for any set of colvars, using different sampling methods:
  37 currently implemented are the Adaptive Biasing Force (ABF) method,
  38 metadynamics, Steered Molecular Dynamics (SMD) and Umbrella Sampling
  39 (US) via a flexible harmonic restraint bias.
  40
  41 This documentation describes only the fix colvars command itself and
  42 LAMMPS specific parts of the code.  The full documentation of the
  43 colvars library is available as "this supplementary PDF document"_PDF/colvars-refman-lammps.pdf
  44
  45 The Colvars library is developed at "https://github.com/colvars/colvars"_https://github.com/colvars/colvars
  46 A detailed discussion of its implementation is in "(Fiorin)"_#Fiorin.
  47
  48 There are some example scripts for using this package with LAMMPS in the
  49 examples/USER/colvars directory.
  50
  51 :line
  52
  53 The only mandatory argument to the fix is the filename to the colvars
  54 input file that contains the input that is independent from the MD
  55 program in which the colvars library has been integrated.
  56
  57 The {group-ID} entry is ignored. The collective variable module will
  58 always apply to the entire system and there can only be one instance
  59 of the colvars fix at a time. The colvars fix will only communicate
  60 the minimum information necessary and the colvars library supports
  61 multiple, completely independent collective variables, so there is
  62 no restriction to functionaliry by limiting the number of colvars fixes.
  63
  64 The {input} keyword allows to specify a state file that would contain
  65 the restart information required in order to continue a calculation from
  66 a prerecorded state. Fix colvars records it state in "binary restart"_restart.html
  67 files, so when using the "read_restart"_read_restart.html command,
  68 this is usually not needed.
  69
  70 The {output} keyword allows to specify the output prefix. All output
  71 files generated will use this prefix followed by the ".colvars." and
  72 a word like "state" or "traj".
  73
  74 The {seed} keyword contains the seed for the random number generator
  75 that will be used in the colvars module.
  76
  77 The {unwrap} keyword controls whether wrapped or unwrapped coordinates
  78 are passed to the colvars library for calculation of the collective
  79 variables and the resulting forces. The default is {yes}, i.e. to use
  80 the image flags to reconstruct the absolute atom positions.
  81 Setting this to {no} will use the current local coordinates that are
  82 wrapped back into the simulation cell at each re-neighboring instead.
  83
  84 The {tstat} keyword can be either NULL or the label of a thermostating
  85 fix that thermostats all atoms in the fix colvars group. This will be
  86 used to provide the colvars module with the current thermostat target
  87 temperature.
  88
  89 [Restart, fix_modify, output, run start/stop, minimize info:]
  90
  91 This fix writes the current status of the colvars module into
  92 "binary restart files"_restart.html. This is in addition to the text
  93 mode status file that is written by the colvars module itself and the
  94 kind of information in both files is identical.
  95
  96 The "fix_modify"_fix_modify.html {energy} option is supported by this
  97 fix to add the energy change from the biasing force added by the fix
  98 to the system's potential energy as part of "thermodynamic
  99 output"_thermo_style.html.
 100
 101 This fix computes a global scalar which can be accessed by various
 102 "output commands"_Section_howto.html#howto_15.  The scalar is the
 103 cummulative energy change due to this fix.  The scalar value
 104 calculated by this fix is "extensive".
 105
 106 [Restrictions:]
 107
 108 This fix is part of the USER-COLVARS package.  It is only enabled if
 109 LAMMPS was built with that package.  See the "Making
 110 LAMMPS"_Section_start.html#start_3 section for more info.
 111
 112 There can only be one colvars fix active at a time. Since the interface
 113 communicates only the minimum amount of information and colvars module
 114 itself can handle an arbitrary number of collective variables, this is
 115 not a limitation of functionality.
 116
 117 [Related commands:]
 118
 119 "fix smd"_fix_smd.html
 120
 121 [Default:]
 122
 123 The default options are input = NULL, output = out, seed = 1966, unwrap yes,
 124 and tstat = NULL.
 125
 126 :line
 127
 128 :link(Fiorin)
 129 [(Fiorin)] Fiorin , Klein, Henin, Mol. Phys., DOI:10.1080/00268976.2013.813594