git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_eim.txt
blob47078f9a8fe924103e31e8d5372f8da1098f7514
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 eim command :h3
10 pair_style eim/omp command :h3
12 [Syntax:]
14 pair_style style :pre
16 style = {eim} :ul
18 [Examples:]
20 pair_style eim
21 pair_coeff * * Na Cl ../potentials/ffield.eim Na Cl
22 pair_coeff * * Na Cl ffield.eim  Na Na Na Cl
23 pair_coeff * * Na Cl ../potentials/ffield.eim Cl NULL Na :pre
25 [Description:]
27 Style {eim} computes pairwise interactions for ionic compounds
28 using embedded-ion method (EIM) potentials "(Zhou)"_#Zhou.  The
29 energy of the system E is given by
31 :c,image(Eqs/pair_eim1.jpg)
33 The first term is a double pairwise sum over the J neighbors of all I
34 atoms, where phi_ij is a pair potential.  The second term sums over
35 the embedding energy E_i of atom I, which is a function of its charge
36 q_i and the electrical potential sigma_i at its location.  E_i, q_i,
37 and sigma_i are calculated as
39 :c,image(Eqs/pair_eim2.jpg)
41 where eta_ji is a pairwise function describing electron flow from atom
42 I to atom J, and psi_ij is another pairwise function.  The multi-body
43 nature of the EIM potential is a result of the embedding energy term.
44 A complete list of all the pair functions used in EIM is summarized
45 below
47 :c,image(Eqs/pair_eim3.jpg)
49 Here E_b, r_e, r_(c,phi), alpha, beta, A_(psi), zeta, r_(s,psi),
50 r_(c,psi), A_(eta), r_(s,eta), r_(c,eta), chi, and pair function type
51 p are parameters, with subscripts ij indicating the two species of
52 atoms in the atomic pair.
54 NOTE: Even though the EIM potential is treating atoms as charged ions,
55 you should not use a LAMMPS "atom_style"_atom_style.html that stores a
56 charge on each atom and thus requires you to assign a charge to each
57 atom, e.g. the {charge} or {full} atom styles.  This is because the
58 EIM potential infers the charge on an atom from the equation above for
59 q_i; you do not assign charges explicitly.
61 :line
63 All the EIM parameters are listed in a potential file which is
64 specified by the "pair_coeff"_pair_coeff.html command.  This is an
65 ASCII text file in a format described below.  The "ffield.eim" file
66 included in the "potentials" directory of the LAMMPS distribution
67 currently includes nine elements Li, Na, K, Rb, Cs, F, Cl, Br, and I.
68 A system with any combination of these elements can be modeled.  This
69 file is parameterized in terms of LAMMPS "metal units"_units.html.
71 Note that unlike other potentials, cutoffs for EIM potentials are not
72 set in the pair_style or pair_coeff command; they are specified in the
73 EIM potential file itself.  Likewise, the EIM potential file lists
74 atomic masses; thus you do not need to use the "mass"_mass.html
75 command to specify them.
77 Only a single pair_coeff command is used with the {eim} style which
78 specifies an EIM potential file and the element(s) to extract
79 information for.  The EIM elements are mapped to LAMMPS atom types by
80 specifying N additional arguments after the filename in the pair_coeff
81 command, where N is the number of LAMMPS atom types:
83 Elem1, Elem2, ...
84 EIM potential file
85 N element names = mapping of EIM elements to atom types :ul
87 See the "pair_coeff"_pair_coeff.html doc page for alternate ways
88 to specify the path for the potential file.
90 As an example like one of those above, suppose you want to model a
91 system with Na and Cl atoms.  If your LAMMPS simulation has 4 atoms
92 types and you want the 1st 3 to be Na, and the 4th to be Cl, you would
93 use the following pair_coeff command:
95 pair_coeff * * Na Cl ffield.eim Na Na Na Cl :pre
97 The 1st 2 arguments must be * * so as to span all LAMMPS atom types.
98 The filename is the EIM potential file.  The Na and Cl arguments
99 (before the file name) are the two elements for which info will be
100 extracted from the potentail file.  The first three trailing Na
101 arguments map LAMMPS atom types 1,2,3 to the EIM Na element.  The
102 final Cl argument maps LAMMPS atom type 4 to the EIM Cl element.
104 If a mapping value is specified as NULL, the mapping is not performed.
105 This can be used when an {eim} potential is used as part of the
106 {hybrid} pair style.  The NULL values are placeholders for atom types
107 that will be used with other potentials.
109 The ffield.eim file in the {potentials} directory of the LAMMPS
110 distribution is formated as follows:
112 Lines starting with # are comments and are ignored by LAMMPS.  Lines
113 starting with "global:" include three global values. The first value
114 divides the cations from anions, i.e., any elements with
115 electronegativity above this value are viewed as anions, and any
116 elements with electronegativity below this value are viewed as
117 cations. The second and third values are related to the cutoff
118 function - i.e. the 0.510204, 1.64498, and 0.010204 shown in the above
119 equation can be derived from these values.
121 Lines starting with "element:" are formatted as follows: name of
122 element, atomic number, atomic mass, electronic negativity, atomic
123 radius (LAMMPS ignores it), ionic radius (LAMMPS ignores it), cohesive
124 energy (LAMMPS ignores it), and q0 (must be 0).
126 Lines starting with "pair:" are entered as: element 1, element 2,
127 r_(c,phi), r_(c,phi) (redundant for historical reasons), E_b, r_e,
128 alpha, beta, r_(c,eta), A_(eta), r_(s,eta), r_(c,psi), A_(psi), zeta,
129 r_(s,psi), and p.
131 The lines in the file can be in any order; LAMMPS extracts the info it
132 needs.
134 :line
136 Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
137 functionally the same as the corresponding style without the suffix.
138 They have been optimized to run faster, depending on your available
139 hardware, as discussed in "Section 5"_Section_accelerate.html
140 of the manual.  The accelerated styles take the same arguments and
141 should produce the same results, except for round-off and precision
142 issues.
144 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
145 USER-OMP and OPT packages, respectively.  They are only enabled if
146 LAMMPS was built with those packages.  See the "Making
147 LAMMPS"_Section_start.html#start_3 section for more info.
149 You can specify the accelerated styles explicitly in your input script
150 by including their suffix, or you can use the "-suffix command-line
151 switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
152 use the "suffix"_suffix.html command in your input script.
154 See "Section 5"_Section_accelerate.html of the manual for
155 more instructions on how to use the accelerated styles effectively.
157 :line
159 [Restrictions:]
161 This style is part of the MANYBODY package.  It is only enabled if
162 LAMMPS was built with that package.
164 [Related commands:]
166 "pair_coeff"_pair_coeff.html
168 [Default:] none
170 :line
172 :link(Zhou)
173 [(Zhou)] Zhou, submitted for publication (2010).  Please contact
174 Xiaowang Zhou (Sandia) for details via email at xzhou at sandia.gov.