git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / compute_temp_ramp.txt
blobbc9283469cf2bda9e55f2ee29f95e25d92f68c69
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 compute temp/ramp command :h3
11 [Syntax:]
13 compute ID group-ID temp/ramp vdim vlo vhi dim clo chi keyword value ... :pre
15 ID, group-ID are documented in "compute"_compute.html command
16 temp/ramp = style name of this compute command
17 vdim = {vx} or {vy} or {vz}
18 vlo,vhi = subtract velocities between vlo and vhi (velocity units)
19 dim = {x} or {y} or {z}
20 clo,chi = lower and upper bound of domain to subtract from (distance units)
21 zero or more keyword/value pairs may be appended
22 keyword = {units} :ul
23   {units} value = {lattice} or {box} :pre
25 [Examples:]
27 compute 2nd middle temp/ramp vx 0 8 y 2 12 units lattice :pre
29 [Description:]
31 Define a computation that calculates the temperature of a group of
32 atoms, after subtracting out an ramped velocity profile before
33 computing the kinetic energy.  A compute of this style can be used by
34 any command that computes a temperature,
35 e.g. "thermo_modify"_thermo_modify.html, "fix
36 temp/rescale"_fix_temp_rescale.html, "fix npt"_fix_nh.html, etc.
38 The meaning of the arguments for this command which define the
39 velocity ramp are the same as for the "velocity ramp"_velocity.html
40 command which was presumably used to impose the velocity.
42 After the ramp velocity has been subtracted from the specified
43 dimension for each atom, the temperature is calculated by the formula
44 KE = dim/2 N k T, where KE = total kinetic energy of the group of
45 atoms (sum of 1/2 m v^2), dim = 2 or 3 = dimensionality of the
46 simulation, N = number of atoms in the group, k = Boltzmann constant,
47 and T = temperature.
49 The {units} keyword determines the meaning of the distance units used
50 for coordinates (c1,c2) and velocities (vlo,vhi).  A {box} value
51 selects standard distance units as defined by the "units"_units.html
52 command, e.g. Angstroms for units = real or metal.  A {lattice} value
53 means the distance units are in lattice spacings; e.g. velocity =
54 lattice spacings / tau.  The "lattice"_lattice.html command must have
55 been previously used to define the lattice spacing.
57 A kinetic energy tensor, stored as a 6-element vector, is also
58 calculated by this compute for use in the computation of a pressure
59 tensor.  The formula for the components of the tensor is the same as
60 the above formula, except that v^2 is replaced by vx*vy for the xy
61 component, etc.  The 6 components of the vector are ordered xx, yy,
62 zz, xy, xz, yz.
64 The number of atoms contributing to the temperature is assumed to be
65 constant for the duration of the run; use the {dynamic} option of the
66 "compute_modify"_compute_modify.html command if this is not the case.
68 The removal of the ramped velocity component by this fix is
69 essentially computing the temperature after a "bias" has been removed
70 from the velocity of the atoms.  If this compute is used with a fix
71 command that performs thermostatting then this bias will be subtracted
72 from each atom, thermostatting of the remaining thermal velocity will
73 be performed, and the bias will be added back in.  Thermostatting
74 fixes that work in this way include "fix nvt"_fix_nh.html, "fix
75 temp/rescale"_fix_temp_rescale.html, "fix
76 temp/berendsen"_fix_temp_berendsen.html, and "fix
77 langevin"_fix_langevin.html.
79 This compute subtracts out degrees-of-freedom due to fixes that
80 constrain molecular motion, such as "fix shake"_fix_shake.html and
81 "fix rigid"_fix_rigid.html.  This means the temperature of groups of
82 atoms that include these constraints will be computed correctly.  If
83 needed, the subtracted degrees-of-freedom can be altered using the
84 {extra} option of the "compute_modify"_compute_modify.html command.
86 See "this howto section"_Section_howto.html#howto_16 of the manual for
87 a discussion of different ways to compute temperature and perform
88 thermostatting.
90 [Output info:]
92 This compute calculates a global scalar (the temperature) and a global
93 vector of length 6 (KE tensor), which can be accessed by indices 1-6.
94 These values can be used by any command that uses global scalar or
95 vector values from a compute as input.  See "this
96 section"_Section_howto.html#howto_15 for an overview of LAMMPS output
97 options.
99 The scalar value calculated by this compute is "intensive".  The
100 vector values are "extensive".
102 The scalar value will be in temperature "units"_units.html.  The
103 vector values will be in energy "units"_units.html.
105 [Restrictions:] none
107 [Related commands:]
109 "compute temp"_compute_temp.html, "compute
110 temp/profie"_compute_temp_profile.html, "compute
111 temp/deform"_compute_temp_deform.html, "compute
112 pressure"_compute_pressure.html
114 [Default:]
116 The option default is units = lattice.