<spanid="index-0"></span><h1>compute pair/local command<aclass="headerlink"href="#compute-pair-local-command"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="syntax">
<h2>Syntax<aclass="headerlink"href="#syntax"title="Permalink to this headline">¶</a></h2>
<divclass="highlight-python"><divclass="highlight"><pre>compute ID group-ID pair/local input1 input2 ...
</pre></div>
</div>
<ulclass="simple">
<li>ID, group-ID are documented in <aclass="reference internal"href="compute.html"><em>compute</em></a> command</li>
<li>pair/local = style name of this compute command</li>
<li>zero or more keywords may be appended</li>
<li>keyword = <em>dist</em> or <em>eng</em> or <em>force</em> or <em>fx</em> or <em>fy</em> or <em>fz</em> or <em>pN</em></li>
</ul>
<preclass="literal-block">
<em>dist</em> = pairwise distance
<em>eng</em> = pairwise energy
<em>force</em> = pairwise force
<em>fx</em>,*fy*,*fz* = components of pairwise force
<em>pN</em> = pair style specific quantities for allowed N values
</pre>
</div>
<divclass="section"id="examples">
<h2>Examples<aclass="headerlink"href="#examples"title="Permalink to this headline">¶</a></h2>
<divclass="highlight-python"><divclass="highlight"><pre>compute 1 all pair/local eng
compute 1 all pair/local dist eng force
compute 1 all pair/local dist eng fx fy fz
compute 1 all pair/local dist fx fy fz p1 p2 p3
</pre></div>
</div>
</div>
<divclass="section"id="description">
<h2>Description<aclass="headerlink"href="#description"title="Permalink to this headline">¶</a></h2>
<p>Define a computation that calculates properties of individual pairwise
interactions. The number of datums generated, aggregated across all
processors, equals the number of pairwise interactions in the system.</p>
<p>The local data stored by this command is generated by looping over the
pairwise neighbor list. Info about an individual pairwise interaction
will only be included if both atoms in the pair are in the specified
compute group, and if the current pairwise distance is less than the
force cutoff distance for that interaction, as defined by the
<aclass="reference internal"href="pair_style.html"><em>pair_style</em></a> and <aclass="reference internal"href="pair_coeff.html"><em>pair_coeff</em></a>
commands.</p>
<p>The output <em>dist</em> is the distance bewteen the pair of atoms.</p>
<p>The output <em>eng</em> is the interaction energy for the pair of atoms.</p>
<p>The output <em>force</em> is the force acting between the pair of atoms,
which is positive for a repulsive force and negative for an attractive
force. The outputs <em>fx</em>, <em>fy</em>, and <em>fz</em> are the xyz components of
<em>force</em> on atom I.</p>
<p>A pair style may define additional pairwise quantities which can be
accessed as <em>p1</em> to <em>pN</em>, where N is defined by the pair style. Most
pair styles do not define any additional quantities, so N = 0. An
example of ones that do are the <aclass="reference internal"href="pair_gran.html"><em>granular pair styles</em></a>
which calculate the tangential force between two particles and return
its components and magnitude acting on atom I for N = 1,2,3,4. See
individual pair styles for detils.</p>
<p>The output <em>dist</em> will be in distance <aclass="reference internal"href="units.html"><em>units</em></a>. The output
<em>eng</em> will be in energy <aclass="reference internal"href="units.html"><em>units</em></a>. The outputs <em>force</em>,
<em>fx</em>, <em>fy</em>, and <em>fz</em> will be in force <aclass="reference internal"href="units.html"><em>units</em></a>. The output
<em>pN</em> will be in whatever units the pair style defines.</p>
<p>Note that as atoms migrate from processor to processor, there will be
no consistent ordering of the entries within the local vector or array
from one timestep to the next. The only consistency that is
guaranteed is that the ordering on a particular timestep will be the
same for local vectors or arrays generated by other compute commands.
For example, pair output from the <aclass="reference internal"href="compute_property_local.html"><em>compute property/local</em></a> command can be combined
with data from this command and output by the <aclass="reference internal"href="dump.html"><em>dump local</em></a>
command in a consistent way.</p>
<divclass="admonition warning">
<pclass="first admonition-title">Warning</p>
<pclass="last">For pairs, if two atoms I,J are involved in 1-2, 1-3,
1-4 interactions within the molecular topology, their pairwise
interaction may be turned off, and thus they may not appear in the
neighbor list, and will not be part of the local data created by this
command. More specifically, this will be true of I,J pairs with a
weighting factor of 0.0; pairs with a non-zero weighting factor are
included. The weighting factors for 1-2, 1-3, and 1-4 pairwise
interactions are set by the <aclass="reference internal"href="special_bonds.html"><em>special_bonds</em></a>
command. An exception is if long-range Coulombics are being computed
via the <aclass="reference internal"href="kspace_style.html"><em>kspace_style</em></a> command, then atom pairs with
weighting factors of zero are still included in the neighbor list, so
that a portion of the long-range interaction contribution can be
computed in the pair style. Hence in that case, those atom pairs will
be part of the local data created by this command.</p>
</div>
<p><strong>Output info:</strong></p>
<p>This compute calculates a local vector or local array depending on the
number of keywords. The length of the vector or number of rows in the
array is the number of pairs. If a single keyword is specified, a
local vector is produced. If two or more keywords are specified, a
local array is produced where the number of columns = the number of
keywords. The vector or array can be accessed by any command that
uses local values from a compute as input. See <aclass="reference internal"href="Section_howto.html#howto-15"><span>this section</span></a> for an overview of LAMMPS output
options.</p>
<p>The output for <em>dist</em> will be in distance <aclass="reference internal"href="units.html"><em>units</em></a>. The
output for <em>eng</em> will be in energy <aclass="reference internal"href="units.html"><em>units</em></a>. The output for
<em>force</em> will be in force <aclass="reference internal"href="units.html"><em>units</em></a>.</p>
</div>
<divclass="section"id="restrictions">
<h2>Restrictions<aclass="headerlink"href="#restrictions"title="Permalink to this headline">¶</a></h2>
<blockquote>
<div>none</div></blockquote>
</div>
<divclass="section"id="related-commands">
<h2>Related commands<aclass="headerlink"href="#related-commands"title="Permalink to this headline">¶</a></h2>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.