git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / compute_orientorder_atom.txt
blob2aa76ab5ac44bc439987c32398a70fbf62081db5
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 compute orientorder/atom command :h3
11 [Syntax:]
13 compute ID group-ID orientorder/atom keyword values ... :pre
15 ID, group-ID are documented in "compute"_compute.html command :ulb,l
16 orientorder/atom = style name of this compute command :l
17 one or more keyword/value pairs may be appended :l
18 keyword = {cutoff} or {nnn} or {degrees} or {components}
19   {cutoff} value = distance cutoff
20   {nnn} value = number of nearest neighbors
21   {degrees} values = nlvalues, l1, l2,...
22   {components} value = ldegree  :pre
24 :ule
26 [Examples:]
28 compute 1 all orientorder/atom
29 compute 1 all orientorder/atom degrees 5 4 6 8 10 12 nnn NULL cutoff 1.5
30 compute 1 all orientorder/atom degrees 4 6 components 6 nnn NULL cutoff 3.0 :pre
32 [Description:]
34 Define a computation that calculates a set of bond-orientational
35 order parameters {Ql} for each atom in a group. These order parameters
36 were introduced by "Steinhardt et al."_#Steinhardt as a way to
37 characterize the local orientational order in atomic structures.
38 For each atom, {Ql} is a real number defined as follows:
40 :c,image(Eqs/orientorder.jpg)
42 The first equation defines the spherical harmonic order parameters.
43 These are complex number components of the 3D analog of the 2D order
44 parameter {qn}, which is implemented as LAMMPS compute
45 "hexorder/atom"_compute_hexorder_atom.html.
46 The summation is over the {nnn} nearest
47 neighbors of the central atom.
48 The angles theta and phi are the standard spherical polar angles
49 defining the direction of the bond vector {rij}.
50 The second equation defines {Ql}, which is a
51 rotationally invariant scalar quantity obtained by summing
52 over all the components of degree {l}.
54 The optional keyword {cutoff} defines the distance cutoff
55 used when searching for neighbors. The default value, also
56 the maximum allowable value, is the cutoff specified
57 by the pair style.
59 The optional keyword {nnn} defines the number of nearest
60 neighbors used to calculate {Ql}. The default value is 12.
61 If the value is NULL, then all neighbors up to the
62 specified distance cutoff are used.
64 The optional keyword {degrees} defines the list of order parameters to
65 be computed.  The first argument {nlvalues} is the number of order
66 parameters. This is followed by that number of integers giving the
67 degree of each order parameter. Because {Q}2 and all odd-degree order
68 parameters are zero for atoms in cubic crystals (see
69 "Steinhardt"_#Steinhardt), the default order parameters are {Q}4,
70 {Q}6, {Q}8, {Q}10, and {Q}12. For the FCC crystal with {nnn}=12, {Q}4
71 = sqrt(7/3)/8 = 0.19094....  The numerical values of all order
72 parameters up to {Q}12 for a range of commonly encountered
73 high-symmetry structures are given in Table I of "Mickel et
74 al."_#Mickel.
76 The optional keyword {components} will output the components of the
77 normalized complex vector {Ybar_lm} of degree {ldegree}, which must be
78 explicitly included in the keyword {degrees}. This option can be used
79 in conjunction with "compute coord_atom"_compute_coord_atom.html to
80 calculate the ten Wolde's criterion to identify crystal-like
81 particles, as discussed in "ten Wolde"_#tenWolde.
83 The value of {Ql} is set to zero for atoms not in the
84 specified compute group, as well as for atoms that have less than
85 {nnn} neighbors within the distance cutoff.
87 The neighbor list needed to compute this quantity is constructed each
88 time the calculation is performed (i.e. each time a snapshot of atoms
89 is dumped).  Thus it can be inefficient to compute/dump this quantity
90 too frequently.
92 NOTE: If you have a bonded system, then the settings of
93 "special_bonds"_special_bonds.html command can remove pairwise
94 interactions between atoms in the same bond, angle, or dihedral.  This
95 is the default setting for the "special_bonds"_special_bonds.html
96 command, and means those pairwise interactions do not appear in the
97 neighbor list.  Because this fix uses the neighbor list, it also means
98 those pairs will not be included in the order parameter.  This
99 difficulty can be circumvented by writing a dump file, and using the
100 "rerun"_rerun.html command to compute the order parameter for
101 snapshots in the dump file.  The rerun script can use a
102 "special_bonds"_special_bonds.html command that includes all pairs in
103 the neighbor list.
105 [Output info:]
107 This compute calculates a per-atom array with {nlvalues} columns,
108 giving the {Ql} values for each atom, which are real numbers on the
109 range 0 <= {Ql} <= 1.
111 If the keyword {components} is set, then the real and imaginary parts
112 of each component of (normalized) {Ybar_lm} will be added to the
113 output array in the following order: Re({Ybar_-m}) Im({Ybar_-m})
114 Re({Ybar_-m+1}) Im({Ybar_-m+1}) ... Re({Ybar_m}) Im({Ybar_m}).  This
115 way, the per-atom array will have a total of {nlvalues}+2*(2{l}+1)
116 columns.
118 These values can be accessed by any command that uses
119 per-atom values from a compute as input.  See "Section
120 6.15"_Section_howto.html#howto_15 for an overview of LAMMPS output
121 options.
123 [Restrictions:] none
125 [Related commands:]
127 "compute coord/atom"_compute_coord_atom.html, "compute
128 centro/atom"_compute_centro_atom.html, "compute
129 hexorder/atom"_compute_hexorder_atom.html
131 [Default:]
133 The option defaults are {cutoff} = pair style cutoff, {nnn} = 12,
134 {degrees} = 5 4 6 8 10 12 i.e. {Q}4, {Q}6, {Q}8, {Q}10, and {Q}12.
136 :line
138 :link(Steinhardt)
139 [(Steinhardt)] P. Steinhardt, D. Nelson, and M. Ronchetti,
140 Phys. Rev. B 28, 784 (1983).
142 :link(Mickel)
143 [(Mickel)] W. Mickel, S. C. Kapfer, G. E. Schroeder-Turkand, K. Mecke,
144 J. Chem. Phys. 138, 044501 (2013).
146 :link(tenWolde)
147 [(tenWolde)] P. R. ten Wolde, M. J. Ruiz-Montero, D. Frenkel,
148 J. Chem. Phys. 104, 9932 (1996).