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

update docs

Browse Source
This commit is contained in:
Axel Kohlmeyer
2022-10-04 05:18:42 -04:00
parent 74d5893dd9
commit 4a06559da5
1 changed files with 27 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/src/pair_list.rst
View File

@ -30,15 +30,17 @@ Description
""""""""""" """""""""""
Style *list* computes interactions between explicitly listed pairs of Style *list* computes interactions between explicitly listed pairs of
atoms with the option to select functional form and parameters for atoms with the option to select functional form and parameters for each
each individual pair. Because the parameters are set in the list individual pair. Because the parameters are set in the list file, the
file, the pair_coeff command has no parameters (but still needs to be pair_coeff command has no parameters (but still needs to be provided).
provided). The *check* and *nocheck* keywords enable/disable a test The *check* and *nocheck* keywords enable/disable tests that checks
that checks whether all listed bonds were present and computed. whether all listed pairs of atom IDs were present and the interactions
computed. If *nocheck* is set and either atom ID is not present, the
interaction is skipped.
This pair style can be thought of as a hybrid between bonded, This pair style can be thought of as a hybrid between bonded,
non-bonded, and restraint interactions. It will typically be used as non-bonded, and restraint interactions. It will typically be used as an
an additional interaction within the *hybrid/overlay* pair style. It additional interaction within the *hybrid/overlay* pair style. It
currently supports three interaction styles: a 12-6 Lennard-Jones, a currently supports three interaction styles: a 12-6 Lennard-Jones, a
Morse and a harmonic potential. Morse and a harmonic potential.
@ -55,10 +57,10 @@ The format of the list file is as follows:
ID2 = atom ID of second atom ID2 = atom ID of second atom
style = style of interaction style = style of interaction
coeffs = list of coeffs coeffs = list of coeffs
cutoff = cutoff for interaction (optional) cutoff = cutoff for interaction (optional, except for style *quartic*)
The cutoff parameter is optional. If not specified, the global cutoff The cutoff parameter is optional for all but the *quartic* interactions.
is used. If it is not specified, the global cutoff is used.
Here is an example file: Here is an example file:
@ -120,7 +122,7 @@ and the coefficients:
* :math:`b_2` (distance units) * :math:`b_2` (distance units)
* :math:`r_c` (distance units) * :math:`r_c` (distance units)
Note that the global cutoff specified by *pair_style list* command is ignored, unless :math:`r_c` is not specified. In this case, :math:`r_c` equals the sqare root of the globle cutoff. Note that the per list entry cutoff :math:`r_c` is **required** for *quartic* interactions.
---------- ----------
@ -136,8 +138,9 @@ pair style.
The :doc:`pair_modify <pair_modify>` table and tail options are not The :doc:`pair_modify <pair_modify>` table and tail options are not
relevant for this pair style. relevant for this pair style.
This pair style does not write its information to :doc:`binary restart files <restart>`, so pair_style and pair_coeff commands need This pair style does not write its information to :doc:`binary restart
to be specified in an input script that reads a restart file. files <restart>`, so pair_style and pair_coeff commands need to be
specified in an input script that reads a restart file.
This pair style can only be used via the *pair* keyword of the This pair style can only be used via the *pair* keyword of the
:doc:`run_style respa <run_style>` command. It does not support the :doc:`run_style respa <run_style>` command. It does not support the
@ -150,16 +153,17 @@ Restrictions
This pair style does not use a neighbor list and instead identifies This pair style does not use a neighbor list and instead identifies
atoms by their IDs. This has two consequences: 1) The cutoff has to be atoms by their IDs. This has two consequences: 1) The cutoff has to be
chosen sufficiently large, so that the second atom of a pair has to be chosen sufficiently large, so that the second atom of a pair has to be a
a ghost atom on the same node on which the first atom is local; ghost atom on the same node on which the first atom is local; otherwise
otherwise the interaction will be skipped. You can use the *check* the interaction will be skipped. You can use the *check* option to
option to detect, if interactions are missing. 2) Unlike other pair detect, if interactions are missing. 2) Unlike other pair styles in
styles in LAMMPS, an atom I will not interact with multiple images of LAMMPS, an atom I will not interact with multiple images of atom J
atom J (assuming the images are within the cutoff distance), but only (assuming the images are within the cutoff distance), but only with the
with the nearest image. closest image.
This style is part of the MISC package. It is only enabled if This style is part of the MISC package. It is only enabled if LAMMPS is
LAMMPS is build with that package. See the :doc:`Build package <Build_package>` page on for more info. build with that package. See the :doc:`Build package <Build_package>`
page on for more info.
Related commands Related commands
"""""""""""""""" """"""""""""""""