ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@5131 f3b2605a-c512-4ea7-a41b-209d697bcdaa

Browse Source
This commit is contained in:
sjplimp
2010-10-25 20:30:15 +00:00
parent 2b36a041bc
commit c936d176fc
8 changed files with 280 additions and 263 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
doc/compute_pair.html
View File

@ -13,15 +13,17 @@
</H3>
<P><B>Syntax:</B>
</P>
<PRE>compute ID group-ID pair pstyle
<PRE>compute ID group-ID pair pstyle evalue
</PRE>
<UL><LI>ID, group-ID are documented in <A HREF = "compute.html">compute</A> command
<LI>pair = style name of this compute command
<LI>pstyle = style name of a pair style that calculates additional values
<LI>pstyle = style name of a pair style that calculates additional values
<LI>evalue = <I>epair</I> or <I>evdwl</I> or <I>evoul</I> or blank (optional setting)
</UL>
<P><B>Examples:</B>
</P>
<PRE>compute 1 all pair gauss
compute 1 all pair lj/cut/coul/cut ecoul
compute 1 all pair reax
</PRE>
<P><B>Description:</B>
@ -31,32 +33,44 @@ 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.
</P>
<P>The specified <I>pstyle</I> must be a pair style that produces additional
values. If a <A HREF = "pair_hybrid.html">hybrid pair style</A> is used, then
<I>pstyle</I> should be the name of a sub-style.
<P>The specified <I>pstyle</I> must be a pair style used in your simulation
either by itself or as a sub-style in a <A HREF = "pair_hybrid.html">pair_style hybrid or
hybrid/overlay</A> command.
</P>
<P>All pair styles tally a potential energy, which is accessed by the
<A HREF = "compute_pe.html">compute pe</A> and <A HREF = "compute_pe_atom.html">compute
pe/atom</A> 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
<P>The <I>evalue</I> setting is optional; it may be left off the command. All
pair styles tally a potential energy <I>epair</I> which may be broken into
two parts: <I>evdwl</I> and <I>ecoul</I> such that <I>epair</I> = <I>evdwl</I> + <I>evoul</I>.
If the pair style calculates Coulombic interactions, their energy will
be tallied in <I>ecoul</I>. Everything else (whether it is a Lennard-Jones
style van der Waals interaction or not) is tallied in <I>evdwl</I>. If
<I>evalue</I> is specified as <I>epair</I> or left out, then <I>epair</I> is stored
as a global scalar by this compute. This is useful when using
<A HREF = "pair_hybrid.html">pair_style hybrid</A> if you want to know the portion
of the total energy contributed by one sub-style. If <I>evalue</I> is
specfied as <I>evdwl</I> or <I>ecoul</I>, then just that portion of the energy
is stored as a global scalar.
</P>
<P>Some pair styles tally additional quantities, e.g. a breakdown of
potential energy into a dozen or so components is tallied by the
<A HREF = "pair_reax.html">pair_style reax</A> commmand. These values (1 or more)
are stored as a global vector by this compute. See the doc page for
<A HREF = "pair_style.html">individual pair styles</A> for info on these values.
</P>
<P>The compute pair command lets you access this data as a global vector
of values and then use other <A HREF = "Section_howto.html#4_15">output options</A>
that work with <A HREF = "compute.html">compute commands</A> to see or use the
values.
</P>
<P><B>Output info:</B>
</P>
<P>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 <A HREF = "Section_howto.html#4_15">this
section</A> for an overview of LAMMPS output
options.
<P>This compute calculates a global scalar which is <I>epair</I> or <I>evdwl</I> or
<I>evoul</I>. If the pair style supports it, it also calculates a global
vector of length >= 1, as determined by the pair style. These values
can be used by any command that uses global scalar or vector values
from a compute as input. See <A HREF = "Section_howto.html#4_15">this section</A>
for an overview of LAMMPS output options.
</P>
<P>The vector values calculated by this compute are "extensive". They
are in whatever units the pair style produces.
<P>The scalar and vector values calculated by this compute are
"extensive".
</P>
<P>The scalar value will be in energy <A HREF = "units.html">units</A>. The vector
values will typically also be in energy <A HREF = "units.html">units</A>, but
see the doc page for the pair style for details.
</P>
<P><B>Restrictions:</B> none
</P>
@ -64,6 +78,8 @@ are in whatever units the pair style produces.
</P>
<P><A HREF = "compute_pe.html">compute pe</A>
</P>
<P><B>Default:</B> none
<P><B>Default:</B>
</P>
<P>The default for <I>evalue</I> is <I>epair</I>.
</P>
</HTML>