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