Add docs for compute momentum

This commit is contained in:
Rupert Nash 2019-06-19 13:55:10 +01:00
parent 959da9de01
commit 26347ec80c
5 changed files with 49 additions and 0 deletions

View File

@ -80,6 +80,7 @@ KOKKOS, o = USER-OMP, t = OPT.
"meso/e/atom"_compute_meso_e_atom.html,
"meso/rho/atom"_compute_meso_rho_atom.html,
"meso/t/atom"_compute_meso_t_atom.html,
"momentum"_compute_momentum.html,
"msd"_compute_msd.html,
"msd/chunk"_compute_msd_chunk.html,
"msd/nongauss"_compute_msd_nongauss.html,

View File

@ -229,6 +229,7 @@ compute"_Commands_compute.html doc page are followed by one or more of
"meso/e/atom"_compute_meso_e_atom.html -
"meso/rho/atom"_compute_meso_rho_atom.html -
"meso/t/atom"_compute_meso_t_atom.html -
"momentum"_compute_momentum.html - translational momentum
"msd"_compute_msd.html - mean-squared displacement of group of atoms
"msd/chunk"_compute_msd_chunk.html - mean-squared displacement for each chunk
"msd/nongauss"_compute_msd_nongauss.html - MSD and non-Gaussian parameter of group of atoms

View File

@ -0,0 +1,45 @@
"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
:link(lws,http://lammps.sandia.gov)
:link(ld,Manual.html)
:link(lc,Commands_all.html)
:line
compute momentum command :h3
[Syntax:]
compute ID group-ID momentum :pre
ID, group-ID are documented in "compute"_compute.html command
momentum = style name of this compute command :ul
[Examples:]
compute 1 all momentum :pre
[Description:]
Define a computation that calculates the translational momentum
of a group of particles.
The momentum of each particles is computed as m v, where m and v are
the mass and velocity of the particle.
[Output info:]
This compute calculates a global vector (the summed momentum) on
length 3. This value can be used by any command that uses a global
vector value from a compute as input. See the "Howto
output"_Howto_output.html doc page for an overview of LAMMPS output
options.
The vector value calculated by this compute is "extensive". The vector
value will be in momentum "units"_units.html.
[Restrictions:] none
[Related commands:]
[Default:] none

View File

@ -57,6 +57,7 @@ Computes :h1
compute_meso_e_atom
compute_meso_rho_atom
compute_meso_t_atom
compute_momentum
compute_msd
compute_msd_chunk
compute_msd_nongauss

View File

@ -468,6 +468,7 @@ compute_ke_rigid.html
compute_meso_e_atom.html
compute_meso_rho_atom.html
compute_meso_t_atom.html
compute_momentum.html
compute_msd.html
compute_msd_chunk.html
compute_msd_nongauss.html