git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / angle_dipole.txt
blob9d105c269d2162333c38ad0682cc90df2e42dbc1
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 angle_style dipole command :h3
10 angle_style dipole/omp command :h3
12 [Syntax:]
14 angle_style dipole :pre
16 [Examples:]
18 angle_style dipole
19 angle_coeff 6 2.1 180.0 :pre
21 [Description:]
23 The {dipole} angle style is used to control the orientation of a dipolar
24 atom within a molecule "(Orsi)"_#Orsi. Specifically, the {dipole} angle
25 style restrains the orientation of a point dipole mu_j (embedded in atom
26 'j') with respect to a reference (bond) vector r_ij = r_i - r_j, where 'i'
27 is another atom of the same molecule (typically, 'i' and 'j' are also
28 covalently bonded).
30 It is convenient to define an angle gamma between the 'free' vector mu_j
31 and the reference (bond) vector r_ij:
33 :c,image(Eqs/angle_dipole_gamma.jpg)
35 The {dipole} angle style uses the potential:
37 :c,image(Eqs/angle_dipole_potential.jpg)
39 where K is a rigidity constant and gamma0 is an equilibrium (reference)
40 angle.
42 The torque on the dipole can be obtained by differentiating the
43 potential using the 'chain rule' as in appendix C.3 of
44 "(Allen)"_#Allen:
46 :c,image(Eqs/angle_dipole_torque.jpg)
48 Example: if gamma0 is set to 0 degrees, the torque generated by
49 the potential will tend to align the dipole along the reference
50 direction defined by the (bond) vector r_ij (in other words, mu_j is
51 restrained to point towards atom 'i').
53 The dipolar torque T_j must be counterbalanced in order to conserve
54 the local angular momentum. This is achieved via an additional force
55 couple generating a torque equivalent to the opposite of T_j:
57 :c,image(Eqs/angle_dipole_couple.jpg)
59 where F_i and F_j are applied on atoms i and j, respectively.
61 The following coefficients must be defined for each angle type via the
62 "angle_coeff"_angle_coeff.html command as in the example above, or in
63 the data file or restart files read by the "read_data"_read_data.html
64 or "read_restart"_read_restart.html commands:
66 K (energy)
67 gamma0 (degrees) :ul
69 :line
71 Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
72 functionally the same as the corresponding style without the suffix.
73 They have been optimized to run faster, depending on your available
74 hardware, as discussed in "Section 5"_Section_accelerate.html
75 of the manual.  The accelerated styles take the same arguments and
76 should produce the same results, except for round-off and precision
77 issues.
79 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
80 USER-OMP and OPT packages, respectively.  They are only enabled if
81 LAMMPS was built with those packages.  See the "Making
82 LAMMPS"_Section_start.html#start_3 section for more info.
84 You can specify the accelerated styles explicitly in your input script
85 by including their suffix, or you can use the "-suffix command-line
86 switch"_Section_start.html#start_6 when you invoke LAMMPS, or you can
87 use the "suffix"_suffix.html command in your input script.
89 See "Section 5"_Section_accelerate.html of the manual for
90 more instructions on how to use the accelerated styles effectively.
92 [Restrictions:]
94 This angle style can only be used if LAMMPS was built with the
95 USER-MISC package.  See the "Making LAMMPS"_Section_start.html#start_2_3
96 section for more info on packages.
98 NOTE: In the "Angles" section of the data file, the atom ID 'j'
99 corresponding to the dipole to restrain must come before the atom ID
100 of the reference atom 'i'. A third atom ID 'k' must also be provided,
101 although 'k' is just a 'dummy' atom which can be any atom; it may be
102 useful to choose a convention (e.g., 'k'='i') and adhere to it.  For
103 example, if ID=1 for the dipolar atom to restrain, and ID=2 for the
104 reference atom, the corresponding line in the "Angles" section of the
105 data file would read: X X 1 2 2
107 The "newton" command for intramolecular interactions must be "on"
108 (which is the default).
110 This angle style should not be used with SHAKE.
112 [Related commands:]
114 "angle_coeff"_angle_coeff.html, "angle_hybrid"_angle_hybrid.html
116 [Default:] none
118 :line
120 :link(Orsi)
121 [(Orsi)] Orsi & Essex, The ELBA force field for coarse-grain modeling of
122 lipid membranes, PloS ONE 6(12): e28637, 2011.
124 :link(Allen)
125 [(Allen)] Allen & Tildesley, Computer Simulation of Liquids,
126 Clarendon Press, Oxford, 1987.