Debian Codegraph @

hugo/content/ref/sample/particle/ff/hard/spheroid.md

raw
1 +++
2 title = "Spheroid"
3 +++
4
5 ### Spheroid
6
7 A full spheroid, generated by rotating an ellipse around the vertical axis.
8
9 <img src="/img/draw/ff/3d/Spheroid.png" width="30%" >
10 <img src="/img/draw/ff/2d/Spheroid_xy.svg" width="30%">
11 <img src="/img/draw/ff/2d/Spheroid_xz.svg" width="30%">
12
13 #### Constructor
14
15 ```python
16 Spheroid(R_xy, R_z)
17 ```
18
19 Parameters:
20 - $R_{xy}$, horizontal radius
21 - $R_z$, vertical radius
22
23 **Attention** This has changed in BornAgain 22.
24 Previously, the second argument was $H=2R_z$.
25
26 #### Usage
27
28 As for any other [Form factor](/ref/sample/particle/ff).
29
30 #### Implementation
31
32 Class {{% ref-class "Sample/HardParticle" "Spheroid" %}} inherits from the interface class
33 {{% ref-class "Sample/Particle" "Formfactor" %}}.
34
35 Form factor is computed as
36
37 $$ F(\mathbf{q})=4\pi R_{xy}^2R_z \exp(iq_zR_z) \dfrac{\sin(s) - s \cos(s)\}{s^3} , $$
38 with the notation
39 $$ s := \sqrt{(R_{xy}q_x)^2 + (R_{xy}q_y)^2+ (R_zq_z)^2}. $$
40
41 Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
42 against
43 $$ V=\dfrac{4\pi}{3} R_{xy}^2R_z. $$
44
45 #### Related shapes
46
47 More special:
48 - [Sphere](/ref/sample/particle/ff/hard/sphere), if $R_z=R_{xy}.$
49
50 More general:
51 - [SpheroidalSegment](/ref/sample/particle/ff/hard/spheroidalsegment), if truncated from the top and/or the bottom.
52 - [Ellipsoid](/ref/sample/particle/ff/hard/ellipsoid)
53 - [EllipsoidalSegment](/ref/sample/particle/ff/hard/ellipsoidalsegment)
54
55 #### Example
56
57 Scattering by uncorrelated, oriented spheroids for horizontal incidence. Rotation around $y$ axis:
58
59 <img src="/img/auto/ff/Spheroid.png">
60
61 Generated by {{% ref-ex "sas/sas-ff.py" %}} (`particle_geometry=Spheroid`).
62
63 #### History
64
65 Replicates the "Full spheroid" in IsGISAXS [Lazzari, IsGISAXS manual v2.6 (2006)](http://www.insp.upmc.fr/oxydes/IsGISAXS/figures/doc/manual.html), Eq. 2.36; [Renaud et al, Surf Sci Rep 64, 255 (2009)](https://doi.org/10.1016/j.surfrep.2009.07.002), Eq. 227, except for wrong
66 factors of 2 in their volume formula and form factor implementation, and "Spheroid" in FitGISAXS [Babonneau, FitGISAXS v130531 (2013)](https://pprime.fr/wp-content/uploads/2020/01/FitGISAXS_130531.zip). Up to BornAgain
67 1.16, our form factor computation followed IsGISAXS in using numeric integration in
68 the $z$ coordinate.
69
70 In BornAgain, named "FullSpheroid" up to version 1.19.
71
72 Up to BornAgain 21, the second argument was $H=2R_z$.