git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / compute_saed.txt
blob658f41cdca212878ef8743e569dbf44f899efa08
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 saed command :h3
11 [Syntax:]
13 compute ID group-ID saed lambda type1 type2 ... typeN keyword value ... :pre
15 ID, group-ID are documented in "compute"_compute.html command :ulb,l
16 saed = style name of this compute command :l
17 lambda = wavelength of incident radiation (length units) :l
18 type1 type2 ... typeN = chemical symbol of each atom type (see valid options below) :l
20 zero or more keyword/value pairs may be appended :l
21 keyword = {Kmax} or {Zone} or {dR_Ewald} or {c} or {manual} or {echo} :l
22   {Kmax} value = Maximum distance explored from reciprocal space origin
23                  (inverse length units)
24   {Zone} values = z1 z2 z3
25     z1,z2,z3 = Zone axis of incident radiation. If z1=z2=z3=0 all
26                reciprocal space will be meshed up to {Kmax}
27   {dR_Ewald} value = Thickness of Ewald sphere slice intercepting
28                      reciprocal space (inverse length units)
29   {c} values = c1 c2 c3
30     c1,c2,c3 = parameters to adjust the spacing of the reciprocal
31                lattice nodes in the h, k, and l directions respectively
32   {manual} = flag to use manual spacing of reciprocal lattice points
33              based on the values of the {c} parameters
34   {echo} = flag to provide extra output for debugging purposes :pre
35 :ule
37 [Examples:]
39 compute 1 all saed 0.0251 Al O Kmax 1.70 Zone 0 0 1 dR_Ewald 0.01 c 0.5 0.5 0.5
40 compute 2 all saed 0.0251 Ni Kmax 1.70 Zone 0 0 0 c 0.05 0.05 0.05 manual echo :pre
42 fix saed/vtk 1 1 1 c_1 file Al2O3_001.saed
43 fix saed/vtk 1 1 1 c_2 file Ni_000.saed :pre
45 [Description:]
47 Define a computation that calculates electron diffraction intensity as
48 described in "(Coleman)"_#saed-Coleman on a mesh of reciprocal lattice nodes
49 defined by the entire simulation domain (or manually) using simulated
50 radiation of wavelength lambda.
52 The electron diffraction intensity I at each reciprocal lattice point
53 is computed from the structure factor F using the equations:
55 :c,image(Eqs/compute_saed1.jpg)
56 :c,image(Eqs/compute_saed2.jpg)
58 Here, K is the location of the reciprocal lattice node, rj is the
59 position of each atom, fj are atomic scattering factors.
61 Diffraction intensities are calculated on a three-dimensional mesh of
62 reciprocal lattice nodes. The mesh spacing is defined either (a)  by
63 the entire simulation domain or (b) manually using selected values as
64 shown in the 2D diagram below.
66 :c,image(JPG/saed_mesh_small.jpg,JPG/saed_mesh.jpg)
68 For a mesh defined by the simulation domain, a rectilinear grid is
69 constructed with spacing {c}*inv(A) along each reciprocal lattice
70 axis. Where A are the vectors corresponding to the edges of the
71 simulation cell. If one or two directions has non-periodic boundary
72 conditions, then the spacing in these directions is defined from the
73 average of the (inversed) box lengths with periodic boundary conditions.
74 Meshes defined by the simulation domain must contain at least one periodic
75 boundary.
77 If the {manual} flag is included, the mesh of reciprocal lattice nodes
78 will defined using the {c} values for the spacing along each reciprocal
79 lattice axis. Note that manual mapping of the reciprocal space mesh is
80 good for comparing diffraction results from  multiple simulations; however
81 it can reduce the likelihood that Bragg reflections will be satisfied
82 unless small spacing parameters <0.05 Angstrom^(-1) are implemented.
83 Meshes with manual spacing do not require a periodic boundary.
85 The limits of the reciprocal lattice mesh are determined by the use of
86 the {Kmax}, {Zone}, and {dR_Ewald} parameters.  The rectilinear mesh
87 created about the origin of reciprocal space is terminated at the
88 boundary of a sphere of radius {Kmax} centered at the origin.  If
89 {Zone} parameters z1=z2=z3=0 are used, diffraction intensities are
90 computed throughout the entire spherical volume - note this can
91 greatly increase the cost of computation.  Otherwise, {Zone}
92 parameters will denote the z1=h, z2=k, and z3=l (in a global since)
93 zone axis of an intersecting Ewald sphere.  Diffraction intensities
94 will only be computed at the intersection of the reciprocal lattice
95 mesh and a {dR_Ewald} thick surface of the Ewald sphere.  See the
96 example 3D intestiety data and the intersection of a \[010\] zone axis
97 in the below image.
99 :c,image(JPG/saed_ewald_intersect_small.jpg,JPG/saed_ewald_intersect.jpg)
101 The atomic scattering factors, fj, accounts for the reduction in
102 diffraction intensity due to Compton scattering.  Compute saed uses
103 analytical approximations of the atomic scattering factors that vary
104 for each atom type (type1 type2 ... typeN) and angle of diffraction.
105 The analytic approximation is computed using the formula
106 "(Brown)"_#Brown:
108 :c,image(Eqs/compute_saed3.jpg)
110 Coefficients parameterized by "(Fox)"_#Fox are assigned for each
111 atom type designating the chemical symbol and charge of each atom
112 type. Valid chemical symbols for compute saed are:
114          H:      He:      Li:      Be:       B:
115          C:       N:       O:       F:      Ne:
116         Na:      Mg:      Al:      Si:       P:
117          S:      Cl:      Ar:       K:      Ca:
118         Sc:      Ti:       V:      Cr:      Mn:
119         Fe:      Co:      Ni:      Cu:      Zn:
120         Ga:      Ge:      As:      Se:      Br:
121         Kr:      Rb:      Sr:       Y:      Zr:
122         Nb:      Mo:      Tc:      Ru:      Rh:
123         Pd:      Ag:      Cd:      In:      Sn:
124         Sb:      Te:       I:      Xe:      Cs:
125         Ba:      La:      Ce:      Pr:      Nd:
126         Pm:      Sm:      Eu:      Gd:      Tb:
127         Dy:      Ho:      Er:      Tm:      Yb:
128         Lu:      Hf:      Ta:       W:      Re:
129         Os:      Ir:      Pt:      Au:      Hg:
130         Tl:      Pb:      Bi:      Po:      At:
131         Rn:      Fr:      Ra:      Ac:      Th:
132         Pa:       U:      Np:      Pu:      Am:
133         Cm:      Bk:      Cf:tb(c=5,s=:)
136 If the {echo} keyword is specified, compute saed will provide extra
137 reporting information to the screen.
139 [Output info:]
141 This compute calculates a global vector.  The length of the vector is
142 the number of reciprocal lattice nodes that are explored by the mesh.
143 The entries of the global vector are the computed diffraction
144 intensities as described above.
146 The vector can be accessed by any command that uses global values
147 from a compute as input.  See "this
148 section"_Section_howto.html#howto_15 for an overview of LAMMPS output
149 options.
151 All array values calculated by this compute are "intensive".
153 [Restrictions:]
155 This compute is part of the USER-DIFFRACTION package.  It is only
156 enabled if LAMMPS was built with that package.  See the "Making
157 LAMMPS"_Section_start.html#start_3 section for more info.
159 The compute_saed command does not work for triclinic cells.
161 [Related commands:]
163 "fix saed_vtk"_fix_saed_vtk.html, "compute xrd"_compute_xrd.html
165 [Default:]
167 The option defaults are Kmax = 1.70, Zone 1 0 0, c 1 1 1, dR_Ewald =
168 0.01.
170 :line
172 :link(saed-Coleman)
173 [(Coleman)] Coleman, Spearot, Capolungo, MSMSE, 21, 055020
174 (2013).
176 :link(Brown)
177 [(Brown)] Brown et al. International Tables for Crystallography
178 Volume C: Mathematical and Chemical Tables, 554-95 (2004).
180 :link(Fox)
181 [(Fox)] Fox, O'Keefe, Tabbernor, Acta Crystallogr. A, 45, 786-93
182 (1989).