git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / compute_ke_eff.txt
blobac8d7e6c01d48b723484e9ff7ab7959e7b97b9e0
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 ke/eff command :h3
11 [Syntax:]
13 compute ID group-ID ke/eff :pre
15 ID, group-ID are documented in "compute"_compute.html command
16 ke/eff = style name of this compute command :ul
18 [Examples:]
20 compute 1 all ke/eff :pre
22 [Description:]
24 Define a computation that calculates the kinetic energy of motion of a
25 group of eFF particles (nuclei and electrons), as modeled with the
26 "electronic force field"_pair_eff.html.
28 The kinetic energy for each nucleus is computed as 1/2 m v^2 and the
29 kinetic energy for each electron is computed as 1/2(me v^2 + 3/4 me
30 s^2), where m corresponds to the nuclear mass, me to the electron
31 mass, v to the translational velocity of each particle, and s to the
32 radial velocity of the electron, respectively.
34 There is a subtle difference between the quantity calculated by this
35 compute and the kinetic energy calculated by the {ke} or {etotal}
36 keyword used in thermodynamic output, as specified by the
37 "thermo_style"_thermo_style.html command.  For this compute, kinetic
38 energy is "translational" and "radial" (only for electrons) kinetic
39 energy, calculated by the simple formula above.  For thermodynamic
40 output, the {ke} keyword infers kinetic energy from the temperature of
41 the system with 1/2 Kb T of energy for each degree of freedom.  For
42 the eFF temperature computation via the "compute
43 temp_eff"_compute_temp_eff.html command, these are the same.  But
44 different computes that calculate temperature can subtract out
45 different non-thermal components of velocity and/or include other
46 degrees of freedom.
48 IMPRORTANT NOTE: The temperature in eFF models should be monitored via
49 the "compute temp/eff"_compute_temp_eff.html command, which can be
50 printed with thermodynamic output by using the
51 "thermo_modify"_thermo_modify.html command, as shown in the following
52 example:
54 compute         effTemp all temp/eff
55 thermo_style    custom step etotal pe ke temp press
56 thermo_modify   temp effTemp :pre
58 See "compute temp/eff"_compute_temp_eff.html.
60 [Output info:]
62 This compute calculates a global scalar (the KE).  This value can be
63 used by any command that uses a global scalar value from a compute as
64 input.  See "Section 6.15"_Section_howto.html#howto_15 for an
65 overview of LAMMPS output options.
67 The scalar value calculated by this compute is "extensive".  The
68 scalar value will be in energy "units"_units.html.
70 [Restrictions:]
72 This compute is part of the USER-EFF package.  It is only enabled if
73 LAMMPS was built with that package.  See the "Making
74 LAMMPS"_Section_start.html#start_3 section for more info.
76 [Related commands:] none
78 [Default:] none