git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_nm.txt
blob9096bdc5234f9768bc565ae445185d021646baa4
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 nm/cut command :h3
10 pair_style nm/cut/coul/cut command :h3
11 pair_style nm/cut/coul/long command :h3
12 pair_style nm/cut/omp command :h3
13 pair_style nm/cut/coul/cut/omp command :h3
14 pair_style nm/cut/coul/long/omp command :h3
16 [Syntax:]
18 pair_style style args :pre
20 style = {nm/cut} or {nm/cut/coul/cut} or {nm/cut/coul/long} :ulb,l
21 args = list of arguments for a particular style :l
22   {nm/cut} args = cutoff
23     cutoff = global cutoff for Pair interactions (distance units)
24   {nm/cut/coul/cut} args = cutoff (cutoff2)
25     cutoff = global cutoff for Pair (and Coulombic if only 1 arg) (distance units)
26     cutoff2 = global cutoff for Coulombic (optional) (distance units)
27   {nm/cut/coul/long} args = cutoff (cutoff2)
28     cutoff = global cutoff for Pair (and Coulombic if only 1 arg) (distance units)
29     cutoff2 = global cutoff for Coulombic (optional) (distance units) :pre
30 :ule
32 [Examples:]
34 pair_style nm/cut 12.0
35 pair_coeff * * 0.01 5.4 8.0 7.0
36 pair_coeff 1 1 0.01 4.4 7.0 6.0 :pre
38 pair_style nm/cut/coul/cut 12.0 15.0
39 pair_coeff * * 0.01 5.4 8.0 7.0
40 pair_coeff 1 1 0.01 4.4 7.0 6.0 :pre
42 pair_style nm/cut/coul/long 12.0 15.0
43 pair_coeff * * 0.01 5.4 8.0 7.0
44 pair_coeff 1 1 0.01 4.4 7.0 6.0 :pre
46 [Description:]
48 Style {nm} computes site-site interactions based on the N-M potential
49 by "Clarke"_#Clarke, mainly used for ionic liquids.  A site can
50 represent a single atom or a united-atom site.  The energy of an
51 interaction has the following form:
53 :c,image(Eqs/pair_nm.jpg)
55 Rc is the cutoff.
57 Style {nm/cut/coul/cut} adds a Coulombic pairwise interaction given by
59 :c,image(Eqs/pair_coulomb.jpg)
61 where C is an energy-conversion constant, Qi and Qj are the charges on
62 the 2 atoms, and epsilon is the dielectric constant which can be set
63 by the "dielectric"_dielectric.html command.  If one cutoff is
64 specified in the pair_style command, it is used for both the NM and
65 Coulombic terms.  If two cutoffs are specified, they are used as
66 cutoffs for the NM and Coulombic terms respectively.
68 Styles {nm/cut/coul/long} compute the same
69 Coulombic interactions as style {nm/cut/coul/cut} except that an
70 additional damping factor is applied to the Coulombic term so it can
71 be used in conjunction with the "kspace_style"_kspace_style.html
72 command and its {ewald} or {pppm} option.  The Coulombic cutoff
73 specified for this style means that pairwise interactions within this
74 distance are computed directly; interactions outside that distance are
75 computed in reciprocal space.
77 For all of the {nm} pair styles, the following coefficients must
78 be defined for each pair of atoms types
79 via the "pair_coeff"_pair_coeff.html command as in the
80 examples above, or in the data file or restart files read by the
81 "read_data"_read_data.html or "read_restart"_read_restart.html
82 commands.
84 E0 (energy units)
85 r0 (distance units)
86 n (unitless)
87 m (unitless)
88 cutoff1 (distance units)
89 cutoff2 (distance units) :ul
91 The latter 2 coefficients are optional.  If not specified, the global
92 NM and Coulombic cutoffs specified in the pair_style command are used.
93 If only one cutoff is specified, it is used as the cutoff for both NM
94 and Coulombic interactions for this type pair.  If both coefficients
95 are specified, they are used as the NM and Coulombic cutoffs for this
96 type pair.  You cannot specify 2 cutoffs for style {nm}, since it
97 has no Coulombic terms.
99 For {nm/cut/coul/long} only the NM cutoff can be specified since a
100 Coulombic cutoff cannot be specified for an individual I,J type pair.
101 All type pairs use the same global Coulombic cutoff specified in the
102 pair_style command.
104 :line
106 [Mixing, shift, table, tail correction, restart, rRESPA info]:
108 These pair styles do not support mixing. Thus, coefficients for all
109 I,J pairs must be specified explicitly.
111 All of the {nm} pair styles supports the
112 "pair_modify"_pair_modify.html shift option for the energy of the pair
113 interaction.
115 The {nm/cut/coul/long} pair styles support the
116 "pair_modify"_pair_modify.html table option since they can tabulate
117 the short-range portion of the long-range Coulombic interaction.
119 All of the {nm} pair styles support the "pair_modify"_pair_modify.html
120 tail option for adding a long-range tail correction to the energy and
121 pressure for the NM portion of the pair interaction.
123 All of the {nm} pair styles write their information to "binary restart
124 files"_restart.html, so pair_style and pair_coeff commands do not need
125 to be specified in an input script that reads a restart file.
127 All of the {nm} pair styles can only be used via the {pair} keyword of
128 the "run_style respa"_run_style.html command.  They do not support the
129 {inner}, {middle}, {outer} keywords.
131 :line
133 Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
134 functionally the same as the corresponding style without the suffix.
135 They have been optimized to run faster, depending on your available
136 hardware, as discussed in "Section 5"_Section_accelerate.html
137 of the manual.  The accelerated styles take the same arguments and
138 should produce the same results, except for round-off and precision
139 issues.
141 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
142 USER-OMP and OPT packages, respectively.  They are only enabled if
143 LAMMPS was built with those packages.  See the "Making
144 LAMMPS"_Section_start.html#start_3 section for more info.
146 You can specify the accelerated styles explicitly in your input script
147 by including their suffix, or you can use the "-suffix command-line
148 switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
149 use the "suffix"_suffix.html command in your input script.
151 See "Section 5"_Section_accelerate.html of the manual for
152 more instructions on how to use the accelerated styles effectively.
154 [Restrictions:]
156 These pair styles are part of the MISC package.  It is only enabled if
157 LAMMPS was built with that package.  See the "Making
158 LAMMPS"_Section_start.html#start_3 section for more info.
160 [Related commands:]
162 "pair_coeff"_pair_coeff.html
164 [Default:] none
166 :line
168 :link(Clarke)
169 [(Clarke)] Clarke and Smith, J Chem Phys, 84, 2290 (1986).