git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_list.txt
blob653e8b0c2d1635c4d10a43889af4b5bd5e99767d
1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
3 :link(lws,http://lammps.sandia.gov)
4 :link(ld,Manual.html)
5 :link(lc,Section_commands.html#comm)
7 :line
9 pair_style list command :h3
11 [Syntax:]
13 pair_style list listfile cutoff keyword :pre
15 listfile = name of file with list of pairwise interactions
16 cutoff = global cutoff (distance units)
17 keyword = optional flag {nocheck} or {check} (default is {check}) :ul
19 [Examples:]
21 pair_style list restraints.txt 200.0
22 pair_coeff * * :pre
24 pair_style hybrid/overlay lj/cut 1.1225 list pair_list.txt 300.0
25 pair_coeff * * lj/cut 1.0 1.0
26 pair_coeff 3* 3* list :pre
28 [Description:]
30 Style {list} computes interactions between explicitly listed pairs of
31 atoms with the option to select functional form and parameters for
32 each individual pair.  Because the parameters are set in the list
33 file, the pair_coeff command has no parameters (but still needs to be
34 provided).  The {check} and {nocheck} keywords enable/disable a test
35 that checks whether all listed bonds were present and computed.
37 This pair style can be thought of as a hybrid between bonded,
38 non-bonded, and restraint interactions.  It will typically be used as
39 an additional interaction within the {hybrid/overlay} pair style.  It
40 currently supports three interaction styles: a 12-6 Lennard-Jones, a
41 Morse and a harmonic potential.
43 The format of the list file is as follows:
45 one line per pair of atoms :ulb,l
46 empty lines will be ignored :l
47 comment text starts with a '#' character :l
48 line syntax: {ID1 ID2 style coeffs cutoff} :l
49   ID1 = atom ID of first atom
50   ID2 = atom ID of second atom
51   style = style of interaction
52   coeffs = list of coeffs
53   cutoff = cutoff for interaction (optional) :pre
54 :ule
56 The cutoff parameter is optional. If not specified, the global cutoff
57 is used.
59 Here is an example file:
61 # this is a comment :pre
63 15 259 lj126     1.0 1.0      50.0
64 15 603 morse    10.0 1.2 2.0  10.0 # and another comment
65 18 470 harmonic 50.0 1.2       5.0  :pre
67 The style {lj126} computes pairwise interactions with the formula
69 :c,image(Eqs/pair_lj.jpg)
71 and the coefficients:
73 epsilon (energy units)
74 sigma (distance units) :ul
76 The style {morse} computes pairwise interactions with the formula
78 :c,image(Eqs/pair_morse.jpg)
80 and the coefficients:
82 D0 (energy units)
83 alpha (1/distance units)
84 r0 (distance units) :ul
86 The style {harmonic} computes pairwise interactions with the formula
88 :c,image(Eqs/bond_harmonic.jpg)
90 and the coefficients:
92 K (energy units)
93 r0 (distance units) :ul
95 Note that the usual 1/2 factor is included in K.
97 :line
99 [Mixing, shift, table, tail correction, restart, rRESPA info]:
101 This pair style does not support mixing since all parameters are
102 explicit for each pair.
104 The "pair_modify"_pair_modify.html shift option is supported by this
105 pair style.
107 The "pair_modify"_pair_modify.html table and tail options are not
108 relevant for this pair style.
110 This pair style does not write its information to "binary restart
111 files"_restart.html, so pair_style and pair_coeff commands need
112 to be specified in an input script that reads a restart file.
114 This pair style can only be used via the {pair} keyword of the
115 "run_style respa"_run_style.html command.  It does not support the
116 {inner}, {middle}, {outer} keywords.
118 :line
120 [Restrictions:]
122 This pair style does not use a neighbor list and instead identifies
123 atoms by their IDs. This has two consequences: 1) The cutoff has to be
124 chosen sufficiently large, so that the second atom of a pair has to be
125 a ghost atom on the same node on which the first atom is local;
126 otherwise the interaction will be skipped. You can use the {check}
127 option to detect, if interactions are missing. 2) Unlike other pair
128 styles in LAMMPS, an atom I will not interact with multiple images of
129 atom J (assuming the images are within the cutoff distance), but only
130 with the nearest image.
132 This style is part of the USER-MISC package. It is only enabled if
133 LAMMPS is build with that package. See the "Making of
134 LAMMPS"_Section_start.html#start_3 section for more info.
136 [Related commands:]
138 "pair_coeff"_pair_coeff.html,
139 "pair_style hybrid/overlay"_pair_hybrid.html,
140 "pair_style lj/cut"_pair_lj.html,
141 "pair_style morse"_pair_morse.html,
142 "bond_style harmonic"_bond_harmonic.html
144 [Default:] none