git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / fix_tmd.txt
blob71d8d2c7670a2956a091ed68d293064de4ffcb59
1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
3 :link(lws,http://lammps.sandia.gov)
4 :link(ld,Manual.html)
5 :link(lc,Section_commands.html#comm)
7 :line
9 fix tmd command :h3
11 [Syntax:]
13 fix ID group-ID tmd rho_final file1 N file2 :pre
15 ID, group-ID are documented in "fix"_fix.html command
16 tmd = style name of this fix command
17 rho_final = desired value of rho at the end of the run (distance units)
18 file1 = filename to read target structure from
19 N = dump TMD statistics every this many timesteps, 0 = no dump
20 file2 = filename to write TMD statistics to (only needed if N > 0) :ul
22 [Examples:]
24 fix 1 all nve
25 fix 2 tmdatoms tmd 1.0 target_file 100 tmd_dump_file :pre
27 [Description:]
29 Perform targeted molecular dynamics (TMD) on a group of atoms.  A
30 holonomic constraint is used to force the atoms to move towards (or
31 away from) the target configuration.  The parameter "rho" is
32 monotonically decreased (or increased) from its initial value to
33 rho_final at the end of the run.
35 Rho has distance units and is a measure of the root-mean-squared
36 distance (RMSD) between the current configuration of the atoms in the
37 group and the target coordinates listed in file1.  Thus a value of
38 rho_final = 0.0 means move the atoms all the way to the final
39 structure during the course of the run.
41 The target file1 can be ASCII text or a gzipped text file (detected by
42 a .gz suffix).  The format of the target file1 is as follows:
44 0.0 25.0 xlo xhi
45 0.0 25.0 ylo yhi
46 0.0 25.0 zlo zhi
47 125     24.97311   1.69005     23.46956 0 0 -1
48 126     1.94691    2.79640     1.92799  1 0 0
49 127     0.15906    3.46099     0.79121  1 0 0
50 ... :pre
52 The first 3 lines may or may not be needed, depending on the format of
53 the atoms to follow.  If image flags are included with the atoms, the
54 1st 3 lo/hi lines must appear in the file.  If image flags are not
55 included, the 1st 3 lines should not appear.  The 3 lines contain the
56 simulation box dimensions for the atom coordinates, in the same format
57 as in a LAMMPS data file (see the "read_data"_read_data.html command).
59 The remaining lines each contain an atom ID and its target x,y,z
60 coordinates.  The atom lines (all or none of them) can optionally be
61 followed by 3 integer values: nx,ny,nz.  For periodic dimensions, they
62 specify which image of the box the atom is considered to be in, i.e. a
63 value of N (positive or negative) means add N times the box length to
64 the coordinate to get the true value.
66 The atom lines can be listed in any order, but every atom in the group
67 must be listed in the file.  Atoms not in the fix group may also be
68 listed; they will be ignored.
70 TMD statistics are written to file2 every N timesteps, unless N is
71 specified as 0, which means no statistics.
73 The atoms in the fix tmd group should be integrated (via a fix nve,
74 nvt, npt) along with other atoms in the system.
76 Restarts can be used with a fix tmd command.  For example, imagine a
77 10000 timestep run with a rho_initial = 11 and a rho_final = 1.  If a
78 restart file was written after 2000 time steps, then the configuration
79 in the file would have a rho value of 9.  A new 8000 time step run
80 could be performed with the same rho_final = 1 to complete the
81 conformational change at the same transition rate.  Note that for
82 restarted runs, the name of the TMD statistics file should be changed
83 to prevent it being overwritten.
85 For more information about TMD, see "(Schlitter1)"_#Schlitter1 and
86 "(Schlitter2)"_#Schlitter2.
88 [Restart, fix_modify, output, run start/stop, minimize info:]
90 No information about this fix is written to "binary restart
91 files"_restart.html.  None of the "fix_modify"_fix_modify.html options
92 are relevant to this fix.  No global or per-atom quantities are stored
93 by this fix for access by various "output
94 commands"_Section_howto.html#howto_15.
96 This fix can ramp its rho parameter over multiple runs, using the
97 {start} and {stop} keywords of the "run"_run.html command.  See the
98 "run"_run.html command for details of how to do this.
100 This fix is not invoked during "energy minimization"_minimize.html.
102 [Restrictions:]
104 All TMD fixes must be listed in the input script after all integrator
105 fixes (nve, nvt, npt) are applied.  This ensures that atoms are moved
106 before their positions are corrected to comply with the constraint.
108 Atoms that have a TMD fix applied should not be part of a group to
109 which a SHAKE fix is applied.  This is because LAMMPS assumes there
110 are not multiple competing holonomic constraints applied to the same
111 atoms.
113 To read gzipped target files, you must compile LAMMPS with the
114 -DLAMMPS_GZIP option - see the "Making
115 LAMMPS"_Section_start.html#start_2 section of the documentation.
117 [Related commands:] none
119 [Default:] none
121 :line
123 :link(Schlitter1)
124 [(Schlitter1)] Schlitter, Swegat, Mulders, "Distance-type reaction
125 coordinates for modelling activated processes", J Molecular Modeling,
126 7, 171-177 (2001).
128 :link(Schlitter2)
129 [(Schlitter2)] Schlitter and Klahn, "The free energy of a reaction
130 coordinate at multiple constraints: a concise formulation", Molecular
131 Physics, 101, 3439-3443 (2003).