git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_gayberne.txt
blobb6171ef93ec33a912ff67f3387b53b9b3650f77b
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 gayberne command :h3
10 pair_style gayberne/gpu command :h3
11 pair_style gayberne/intel command :h3
12 pair_style gayberne/omp command :h3
14 [Syntax:]
16 pair_style gayberne gamma upsilon mu cutoff :pre
18 gamma = shift for potential minimum (typically 1)
19 upsilon = exponent for eta orientation-dependent energy function
20 mu = exponent for chi orientation-dependent energy function
21 cutoff = global cutoff for interactions (distance units) :ul
23 [Examples:]
25 pair_style gayberne 1.0 1.0 1.0 10.0
26 pair_coeff * * 1.0 1.7 1.7 3.4 3.4 1.0 1.0 1.0 :pre
28 [Description:]
30 The {gayberne} styles compute a Gay-Berne anisotropic LJ interaction
31 "(Berardi)"_#Berardi between pairs of ellipsoidal particles or an
32 ellipsoidal and spherical particle via the formulas
34 :c,image(Eqs/pair_gayberne.jpg)
36 where A1 and A2 are the transformation matrices from the simulation
37 box frame to the body frame and r12 is the center to center vector
38 between the particles.  Ur controls the shifted distance dependent
39 interaction based on the distance of closest approach of the two
40 particles (h12) and the user-specified shift parameter gamma.  When
41 both particles are spherical, the formula reduces to the usual
42 Lennard-Jones interaction (see details below for when Gay-Berne treats
43 a particle as "spherical").
45 For large uniform molecules it has been shown that the energy
46 parameters are approximately representable in terms of local contact
47 curvatures "(Everaers)"_#Everaers:
49 :c,image(Eqs/pair_gayberne2.jpg)
51 The variable names utilized as potential parameters are for the most
52 part taken from "(Everaers)"_#Everaers in order to be consistent with
53 the "RE-squared pair potential"_pair_resquared.html.  Details on the
54 upsilon and mu parameters are given
55 "here"_PDF/pair_resquared_extra.pdf.
57 More details of the Gay-Berne formulation are given in the references
58 listed below and in "this supplementary
59 document"_PDF/pair_gayberne_extra.pdf.
61 Use of this pair style requires the NVE, NVT, or NPT fixes with the
62 {asphere} extension (e.g. "fix nve/asphere"_fix_nve_asphere.html) in
63 order to integrate particle rotation.  Additionally, "atom_style
64 ellipsoid"_atom_style.html should be used since it defines the
65 rotational state and the size and shape of each ellipsoidal particle.
67 The following coefficients must be defined for each pair of atoms
68 types via the "pair_coeff"_pair_coeff.html command as in the examples
69 above, or in the data file or restart files read by the
70 "read_data"_read_data.html or "read_restart"_read_restart.html
71 commands, or by mixing as described below:
73 epsilon = well depth (energy units)
74 sigma = minimum effective particle radii (distance units)
75 epsilon_i_a = relative well depth of type I for side-to-side interactions
76 epsilon_i_b = relative well depth of type I for face-to-face interactions
77 epsilon_i_c = relative well depth of type I for end-to-end interactions
78 epsilon_j_a = relative well depth of type J for side-to-side interactions
79 epsilon_j_b = relative well depth of type J for face-to-face interactions
80 epsilon_j_c = relative well depth of type J for end-to-end interactions
81 cutoff (distance units) :ul
83 The last coefficient is optional.  If not specified, the global
84 cutoff specified in the pair_style command is used.
86 It is typical with the Gay-Berne potential to define {sigma} as the
87 minimum of the 3 shape diameters of the particles involved in an I,I
88 interaction, though this is not required.  Note that this is a
89 different meaning for {sigma} than the "pair_style
90 resquared"_pair_resquared.html potential uses.
92 The epsilon_i and epsilon_j coefficients are actually defined for atom
93 types, not for pairs of atom types.  Thus, in a series of pair_coeff
94 commands, they only need to be specified once for each atom type.
96 Specifically, if any of epsilon_i_a, epsilon_i_b, epsilon_i_c are
97 non-zero, the three values are assigned to atom type I.  If all the
98 epsilon_i values are zero, they are ignored.  If any of epsilon_j_a,
99 epsilon_j_b, epsilon_j_c are non-zero, the three values are assigned
100 to atom type J.  If all three epsilon_j values are zero, they are
101 ignored.  Thus the typical way to define the epsilon_i and epsilon_j
102 coefficients is to list their values in "pair_coeff I J" commands when
103 I = J, but set them to 0.0 when I != J.  If you do list them when I !=
104 J, you should insure they are consistent with their values in other
105 pair_coeff commands, since only the last setting will be in effect.
107 Note that if this potential is being used as a sub-style of
108 "pair_style hybrid"_pair_hybrid.html, and there is no "pair_coeff I I"
109 setting made for Gay-Berne for a particular type I (because I-I
110 interactions are computed by another hybrid pair potential), then you
111 still need to insure the epsilon a,b,c coefficients are assigned to
112 that type. e.g. in a "pair_coeff I J" command.
114 NOTE: If the epsilon a = b = c for an atom type, and if the shape of
115 the particle itself is spherical, meaning its 3 shape parameters are
116 all the same, then the particle is treated as an LJ sphere by the
117 Gay-Berne potential.  This is significant because if two LJ spheres
118 interact, then the simple Lennard-Jones formula is used to compute
119 their interaction energy/force using the specified epsilon and sigma
120 as the standard LJ parameters.  This is much cheaper to compute than
121 the full Gay-Berne formula.  To treat the particle as a LJ sphere with
122 sigma = D, you should normally set epsilon a = b = c = 1.0, set the
123 pair_coeff sigma = D, and also set the 3 shape parameters for the
124 particle to D.  The one exception is that if the 3 shape parameters
125 are set to 0.0, which is a valid way in LAMMPS to specify a point
126 particle, then the Gay-Berne potential will treat that as shape
127 parameters of 1.0 (i.e. a LJ particle with sigma = 1), since it
128 requires finite-size particles.  In this case you should still set the
129 pair_coeff sigma to 1.0 as well.
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 :line
156 [Mixing, shift, table, tail correction, restart, rRESPA info]:
158 For atom type pairs I,J and I != J, the epsilon and sigma coefficients
159 and cutoff distance for this pair style can be mixed.  The default mix
160 value is {geometric}.  See the "pair_modify" command for details.
162 This pair styles supports the "pair_modify"_pair_modify.html shift
163 option for the energy of the Lennard-Jones portion of the pair
164 interaction, but only for sphere-sphere interactions.  There is no
165 shifting performed for ellipsoidal interactions due to the anisotropic
166 dependence of the interaction.
168 The "pair_modify"_pair_modify.html table option is not relevant
169 for this pair style.
171 This pair style does not support the "pair_modify"_pair_modify.html
172 tail option for adding long-range tail corrections to energy and
173 pressure.
175 This pair style writes its information to "binary restart
176 files"_restart.html, so pair_style and pair_coeff commands do not need
177 to be specified in an input script that reads a restart file.
179 This pair style can only be used via the {pair} keyword of the
180 "run_style respa"_run_style.html command.  It does not support the
181 {inner}, {middle}, {outer} keywords.
183 :line
185 [Restrictions:]
187 The {gayberne} style is part of the ASPHERE package.  It is only
188 enabled if LAMMPS was built with that package.  See the "Making
189 LAMMPS"_Section_start.html#start_3 section for more info.
191 These pair style require that atoms store torque and a quaternion to
192 represent their orientation, as defined by the
193 "atom_style"_atom_style.html.  It also require they store a per-type
194 "shape"_set.html.  The particles cannot store a per-particle
195 diameter.
197 This pair style requires that atoms be ellipsoids as defined by the
198 "atom_style ellipsoid"_atom_style.html command.
200 Particles acted on by the potential can be finite-size aspherical or
201 spherical particles, or point particles.  Spherical particles have all
202 3 of their shape parameters equal to each other.  Point particles have
203 all 3 of their shape parameters equal to 0.0.
205 The Gay-Berne potential does not become isotropic as r increases
206 "(Everaers)"_#Everaers.  The distance-of-closest-approach
207 approximation used by LAMMPS becomes less accurate when high-aspect
208 ratio ellipsoids are used.
210 [Related commands:]
212 "pair_coeff"_pair_coeff.html, "fix nve/asphere"_fix_nve_asphere.html,
213 "compute temp/asphere"_compute_temp_asphere.html, "pair_style
214 resquared"_pair_resquared.html
216 [Default:] none
218 :line
220 :link(Everaers)
221 [(Everaers)] Everaers and Ejtehadi, Phys Rev E, 67, 041710 (2003).
223 :link(Berardi)
224 [(Berardi)] Berardi, Fava, Zannoni, Chem Phys Lett, 297, 8-14 (1998).
225 Berardi, Muccioli, Zannoni, J Chem Phys, 128, 024905 (2008).
227 :link(Perram)
228 [(Perram)] Perram and Rasmussen, Phys Rev E, 54, 6565-6572 (1996).
230 :link(Allen)
231 [(Allen)] Allen and Germano, Mol Phys 104, 3225-3235 (2006).