git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_born.txt
blobd38d9e3191d196fb41c17d495b0a655407a41f55
1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
4 :link(lws,http://lammps.sandia.gov)
5 :link(ld,Manual.html)
6 :link(lc,Section_commands.html#comm)
8 :line
10 pair_style born command :h3
11 pair_style born/omp command :h3
12 pair_style born/gpu command :h3
13 pair_style born/coul/long command :h3
14 pair_style born/coul/long/cs command :h3
15 pair_style born/coul/long/gpu command :h3
16 pair_style born/coul/long/omp command :h3
17 pair_style born/coul/msm command :h3
18 pair_style born/coul/msm/omp command :h3
19 pair_style born/coul/wolf command :h3
20 pair_style born/coul/wolf/gpu command :h3
21 pair_style born/coul/wolf/omp command :h3
22 pair_style born/coul/dsf command :h3
23 pair_style born/coul/dsf/cs command :h3
25 [Syntax:]
27 pair_style style args :pre
29 style = {born} or {born/coul/long} or {born/coul/long/cs} or {born/coul/msm} or {born/coul/wolf}
30 args = list of arguments for a particular style :ul
31   {born} args = cutoff
32     cutoff = global cutoff for non-Coulombic interactions (distance units)
33   {born/coul/long} or {born/coul/long/cs} args = cutoff (cutoff2)
34     cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
35     cutoff2 = global cutoff for Coulombic (optional) (distance units)
36   {born/coul/msm} args = cutoff (cutoff2)
37     cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
38     cutoff2 = global cutoff for Coulombic (optional) (distance units)
39   {born/coul/wolf} args = alpha cutoff (cutoff2)
40     alpha = damping parameter (inverse distance units)
41     cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
42     cutoff2 = global cutoff for Coulombic (optional) (distance units)
43   {born/coul/dsf} or {born/coul/dsf/cs} args = alpha cutoff (cutoff2)
44     alpha = damping parameter (inverse distance units)
45     cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
46     cutoff2 = global cutoff for Coulombic (distance units) :pre
48 [Examples:]
50 pair_style born 10.0
51 pair_coeff * * 6.08 0.317 2.340 24.18 11.51
52 pair_coeff 1 1 6.08 0.317 2.340 24.18 11.51 :pre
54 pair_style born/coul/long 10.0
55 pair_style born/coul/long/cs 10.0
56 pair_style born/coul/long 10.0 8.0
57 pair_style born/coul/long/cs 10.0 8.0
58 pair_coeff * * 6.08 0.317 2.340 24.18 11.51
59 pair_coeff 1 1 6.08 0.317 2.340 24.18 11.51 :pre
61 pair_style born/coul/msm 10.0
62 pair_style born/coul/msm 10.0 8.0
63 pair_coeff * * 6.08 0.317 2.340 24.18 11.51
64 pair_coeff 1 1 6.08 0.317 2.340 24.18 11.51 :pre
66 pair_style born/coul/wolf 0.25 10.0
67 pair_style born/coul/wolf 0.25 10.0 9.0
68 pair_coeff * * 6.08 0.317 2.340 24.18 11.51
69 pair_coeff 1 1 6.08 0.317 2.340 24.18 11.51 :pre
71 pair_style born/coul/dsf 0.1 10.0 12.0
72 pair_coeff * *   0.0 1.00 0.00 0.00 0.00
73 pair_coeff 1 1 480.0 0.25 0.00 1.05 0.50 :pre
75 [Description:]
77 The {born} style computes the Born-Mayer-Huggins or Tosi/Fumi
78 potential described in "(Fumi and Tosi)"_#FumiTosi, given by
80 :c,image(Eqs/pair_born.jpg)
82 where sigma is an interaction-dependent length parameter, rho is an
83 ionic-pair dependent length parameter, and Rc is the cutoff.
85 The styles with {coul/long} or {coul/msm} add a Coulombic term as
86 described for the "lj/cut"_pair_lj.html pair styles.  An additional
87 damping factor is applied to the Coulombic term so it can be used in
88 conjunction with the "kspace_style"_kspace_style.html command and its
89 {ewald} or {pppm} of {msm} option.  The Coulombic cutoff specified for
90 this style means that pairwise interactions within this distance are
91 computed directly; interactions outside that distance are computed in
92 reciprocal space.
94 If one cutoff is specified for the {born/coul/long} and
95 {born/coul/msm} style, it is used for both the A,C,D and Coulombic
96 terms.  If two cutoffs are specified, the first is used as the cutoff
97 for the A,C,D terms, and the second is the cutoff for the Coulombic
98 term.
100 The {born/coul/wolf} style adds a Coulombic term as described for the
101 Wolf potential in the "coul/wolf"_pair_coul.html pair style.
103 The {born/coul/dsf} style computes the Coulomb contribution with the
104 damped shifted force model as in the "coul/dsf"_pair_coul.html style.
106 Style {born/coul/long/cs} is identical to {born/coul/long} except that
107 a term is added for the "core/shell model"_Section_howto.html#howto_25
108 to allow charges on core and shell particles to be separated by r =
109 0.0. The same correction is introduced for {born/coul/dsf/cs} style
110 which is identical to {born/coul/dsf}.
112 Note that these potentials are related to the "Buckingham
113 potential"_pair_buck.html.
115 The following coefficients must be defined for each pair of atoms
116 types via the "pair_coeff"_pair_coeff.html command as in the examples
117 above, or in the data file or restart files read by the
118 "read_data"_read_data.html or "read_restart"_read_restart.html
119 commands, or by mixing as described below:
121 A (energy units)
122 rho (distance units)
123 sigma (distance units)
124 C (energy units * distance units^6)
125 D (energy units * distance units^8)
126 cutoff (distance units) :ul
128 The second coefficient, rho, must be greater than zero.
130 The last coefficient is optional.  If not specified, the global A,C,D
131 cutoff specified in the pair_style command is used.
133 For {born/coul/long}, {born/coul/wolf} and {born/coul/dsf} no
134 Coulombic cutoff can be specified for an individual I,J type pair.
135 All type pairs use the same global Coulombic cutoff specified in the
136 pair_style command.
138 :line
140 Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
141 functionally the same as the corresponding style without the suffix.
142 They have been optimized to run faster, depending on your available
143 hardware, as discussed in "Section 5"_Section_accelerate.html
144 of the manual.  The accelerated styles take the same arguments and
145 should produce the same results, except for round-off and precision
146 issues.
148 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
149 USER-OMP and OPT packages, respectively.  They are only enabled if
150 LAMMPS was built with those packages.  See the "Making
151 LAMMPS"_Section_start.html#start_3 section for more info.
153 You can specify the accelerated styles explicitly in your input script
154 by including their suffix, or you can use the "-suffix command-line
155 switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
156 use the "suffix"_suffix.html command in your input script.
158 See "Section 5"_Section_accelerate.html of the manual for
159 more instructions on how to use the accelerated styles effectively.
161 :line
163 [Mixing, shift, table, tail correction, restart, rRESPA info]:
165 These pair styles do not support mixing.  Thus, coefficients for all
166 I,J pairs must be specified explicitly.
168 These styles support the "pair_modify"_pair_modify.html shift option
169 for the energy of the exp(), 1/r^6, and 1/r^8 portion of the pair
170 interaction.
172 The {born/coul/long} pair style supports the
173 "pair_modify"_pair_modify.html table option ti tabulate the
174 short-range portion of the long-range Coulombic interaction.
176 These styles support the pair_modify tail option for adding long-range
177 tail corrections to energy and pressure.
179 Thess styles writes thei information to binary "restart"_restart.html
180 files, so pair_style and pair_coeff commands do not need to be
181 specified in an input script that reads a restart file.
183 These styles can only be used via the {pair} keyword of the "run_style
184 respa"_run_style.html command.  They do not support the {inner},
185 {middle}, {outer} keywords.
187 :line
189 [Restrictions:]
191 The {born/coul/long} style is part of the KSPACE package.  It is only
192 enabled if LAMMPS was built with that package.  See the
193 "Making LAMMPS"_Section_start.html#start_3 section for more info.
195 [Related commands:]
197 "pair_coeff"_pair_coeff.html, "pair_style buck"_pair_buck.html
199 [Default:] none
201 :line
203 :link(FumiTosi)
204 Fumi and Tosi, J Phys Chem Solids, 25, 31 (1964),
205 Fumi and Tosi, J Phys Chem Solids, 25, 45 (1964).