From 1fd2673563244bd9adf9807ea0ca44a12ba5635f Mon Sep 17 00:00:00 2001
From: sjplimp
These are compute styles contributed by users, which can be used if diff --git a/doc/Section_commands.txt b/doc/Section_commands.txt index 97dc3b5ea3..0004339cc0 100644 --- a/doc/Section_commands.txt +++ b/doc/Section_commands.txt @@ -486,6 +486,7 @@ See the "compute"_compute.html command for one-line descriptions of each style or click on the style itself for a full description: "angle/local"_compute_angle_local.html, +"atom/molecule"_compute_atom_molecule.html, "bond/local"_compute_bond_local.html, "centro/atom"_compute_centro_atom.html, "cna/atom"_compute_cna_atom.html, diff --git a/doc/compute.html b/doc/compute.html index 581e85479b..2e2d5c5b56 100644 --- a/doc/compute.html +++ b/doc/compute.html @@ -168,6 +168,7 @@ and what it does. Here is an alphabetic list of compute styles available in LAMMPS:
Syntax: +
+compute ID group-ID pair pstyle ++
Examples: +
+compute 1 all pair gauss +compute 1 all pair reax ++
Description: +
+Define a computation that extracts additional values calculated by a +pair style, sums them across processors, and makes them accessible for +output or further processing by other commands. The group specified +for this command is ignored. +
+The specified pstyle must be a pair style that produces additional +values. If a hybrid pair style is used, then +pstyle should be the name of a sub-style. +
+All pair styles tally a potential energy, which is accessed by the +compute pe and compute +pe/atom commands. Some pair styles tally one or +more additional values, such as a breakdown of the total pair +potential energy into sub-categories. See the doc page for +individual pair styles for info on these values. +
+The compute pair command lets you access this data as a global vector +of values and then use other output options +that work with compute commands to see or use the +values. +
+Output info: +
+This compute calculates a global vector of length >= 1, as determined +by the pair style. These values can be used by any command that uses +global vector values from a compute as input. See this +section for an overview of LAMMPS output +options. +
+The vector values calculated by this compute are "extensive". They +are in whatever units the pair style produces. +
+Restrictions: none +
+Related commands: +
+ +Default: none +
+ diff --git a/doc/compute_pair.txt b/doc/compute_pair.txt new file mode 100644 index 0000000000..26b2e4dd8c --- /dev/null +++ b/doc/compute_pair.txt @@ -0,0 +1,64 @@ +"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c + +:link(lws,http://lammps.sandia.gov) +:link(ld,Manual.html) +:link(lc,Section_commands.html#comm) + +:line + +compute pair command :h3 + +[Syntax:] + +compute ID group-ID pair pstyle :pre + +ID, group-ID are documented in "compute"_compute.html command +pair = style name of this compute command +pstyle = style name of a pair style that calculates additional values :ul + +[Examples:] + +compute 1 all pair gauss +compute 1 all pair reax :pre + +[Description:] + +Define a computation that extracts additional values calculated by a +pair style, sums them across processors, and makes them accessible for +output or further processing by other commands. The group specified +for this command is ignored. + +The specified {pstyle} must be a pair style that produces additional +values. If a "hybrid pair style"_pair_hybrid.html is used, then +{pstyle} should be the name of a sub-style. + +All pair styles tally a potential energy, which is accessed by the +"compute pe"_compute_pe.html and "compute +pe/atom"_compute_pe_atom.html commands. Some pair styles tally one or +more additional values, such as a breakdown of the total pair +potential energy into sub-categories. See the doc page for +"individual pair styles"_pair_style.html for info on these values. + +The compute pair command lets you access this data as a global vector +of values and then use other "output options"_Section_howto.html#4_15 +that work with "compute commands"_compute.html to see or use the +values. + +[Output info:] + +This compute calculates a global vector of length >= 1, as determined +by the pair style. These values can be used by any command that uses +global vector values from a compute as input. See "this +section"_Section_howto.html#4_15 for an overview of LAMMPS output +options. + +The vector values calculated by this compute are "extensive". They +are in whatever units the pair style produces. + +[Restrictions:] none + +[Related commands:] + +"compute pe"_compute_pe.html + +[Default:] none diff --git a/doc/compute_property_molecule.html b/doc/compute_property_molecule.html index 3be0866750..ccce50221f 100644 --- a/doc/compute_property_molecule.html +++ b/doc/compute_property_molecule.html @@ -21,9 +21,9 @@possible attributes = mol --
mol = molecule ID +possible attributes = mol count + mol = molecule ID + count = # of atoms in molecule
The count attribute is the number of atoms in the molecule. +
Output info:
This compute calculates a global vector or global array depending on diff --git a/doc/compute_property_molecule.txt b/doc/compute_property_molecule.txt index 28f129221b..eb1972bd85 100644 --- a/doc/compute_property_molecule.txt +++ b/doc/compute_property_molecule.txt @@ -15,8 +15,9 @@ compute ID group-ID property/molecule input1 input2 ... :pre ID, group-ID are documented in "compute"_compute.html command :ulb,l property/molecule = style name of this compute command :l input = one or more attributes :l - possible attributes = mol :pre - mol = molecule ID :pre + possible attributes = mol count + mol = molecule ID + count = # of atoms in molecule :pre :ule [Examples:] @@ -40,6 +41,8 @@ per-molecule datums. Thus this attribute can be used to produce molecule IDs as labels for those datums when they are output to a file, e.g. by the "fix ave/time"_fix_ave_time.html command. +The {count} attribute is the number of atoms in the molecule. + [Output info:] This compute calculates a global vector or global array depending on