doc/src/compute_erotate_rigid.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 compute erotate/rigid command :h3
  10
  11 [Syntax:]
  12
  13 compute ID group-ID erotate/rigid fix-ID :pre
  14
  15 ID, group-ID are documented in "compute"_compute.html command
  16 erotate/rigid = style name of this compute command
  17 fix-ID = ID of rigid body fix :ul
  18
  19 [Examples:]
  20
  21 compute 1 all erotate/rigid myRigid :pre
  22
  23 [Description:]
  24
  25 Define a computation that calculates the rotational kinetic energy of
  26 a collection of rigid bodies, as defined by one of the "fix
  27 rigid"_fix_rigid.html command variants.
  28
  29 The rotational energy of each rigid body is computed as 1/2 I Wbody^2,
  30 where I is the inertia tensor for the rigid body, and Wbody is its
  31 angular velocity vector.  Both I and Wbody are in the frame of
  32 reference of the rigid body, i.e. I is diagonalized.
  33
  34 The {fix-ID} should be the ID of one of the "fix rigid"_fix_rigid.html
  35 commands which defines the rigid bodies.  The group specified in the
  36 compute command is ignored.  The rotational energy of all the rigid
  37 bodies defined by the fix rigid command in included in the
  38 calculation.
  39
  40 [Output info:]
  41
  42 This compute calculates a global scalar (the summed rotational energy
  43 of all the rigid bodies).  This value can be used by any command that
  44 uses a global scalar value from a compute as input.  See
  45 "Section 6.15"_Section_howto.html#howto_15 for an overview of
  46 LAMMPS output options.
  47
  48 The scalar value calculated by this compute is "extensive".  The
  49 scalar value will be in energy "units"_units.html.
  50
  51 [Restrictions:]
  52
  53 This compute is part of the RIGID package.  It is only enabled if
  54 LAMMPS was built with that package.  See the "Making
  55 LAMMPS"_Section_start.html#start_3 section for more info.
  56
  57 [Related commands:]
  58
  59 "compute ke/rigid"_compute_ke_rigid.html
  60
  61 [Default:] none