Debian Codegraph @

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

raw
1 +++
2 title = "Bipyramid4"
3 +++
4
5 ### Bipyramid4
6
7 A compound of two truncated pyramids with a common square base and opposite
8 orientations.
9
10 <img src="/img/draw/ff/3d/Bipyramid4.png" width="30%" >
11 <img src="/img/draw/ff/2d/Bipyramid4_xy.svg" width="30%">
12 <img src="/img/draw/ff/2d/Bipyramid4_xz.svg" width="30%">
13
14 #### Constructor
15
16 ```python
17 Bipyramid4(L, H, r_H, alpha)
18 ```
19
20 Parameters:
21 - L, edge length of the shared quadratic base
22 - H, height of the bottom pyramid
23 - r_H, height ratio $r_{H}$ between the top and bottom pyramid
24 - alpha, dihedral angle $\alpha$ between the base and a side face.
25
26 Constraint:
27
28 $H \le \dfrac{\tan\alpha}{2} L \quad $ and $ \quad r_{H} H \le \dfrac{\tan\alpha}{2} L$
29
30 #### Usage
31
32 As for any other [Form factor](/ref/sample/particle/ff).
33
34 #### Implementation
35
36 Class [Bipyramid4]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
37 {{% ref-class "Sample/Particle" "Formfactor" %}}.
38
39 Form factor computation is based on the generic form factor of a polyhedron
40 provided by {{% link-libformfactor %}}.
41
42 Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
43 against
44 $$V=\dfrac{L^3\tan\alpha}{6}\Big[2-\Big(1-\dfrac{2H}{L\tan\alpha}\Big)^3-\Big(1-\dfrac{2r_{H}H}{L\tan\alpha}\Big)^3\Big].$$
45
46 #### Related shapes
47
48 More special:
49 - [Pyramid4](/ref/sample/particle/ff/hard/pyramid4), if $r_H \to \infty$.
50 - [Box](/ref/sample/particle/ff/hard/box), if $\alpha=90^{\circ}$.
51 - [PlatonicOctahedron](/ref/sample/particle/ff/hard/platonicoctahedron), if regular and not truncated.
52
53 #### Example
54
55 Scattering by uncorrelated, oriented bipyramids for horizontal incidence. Rotation around $z$ axis:
56
57 <img src="/img/auto/ff/Bipyramid4.png">
58
59 Generated by {{% ref-ex "sas/sas-ff.py" %}} (`particle_geometry=Bipyramid4`).
60
61 #### History
62
63 Was incorrectly named "Cuboctahedron" up to BornAgain 1.19.
64
65 Agrees with "Cubooctaedron" form factor of IsGISAXS [Lazzari, IsGISAXS manual v2.6 (2006)](http://www.insp.upmc.fr/oxydes/IsGISAXS/figures/doc/manual.html), Eq. 2.33;
66 [Renaud et al, Surf Sci Rep 64, 255 (2009)](https://doi.org/10.1016/j.surfrep.2009.07.002), Eq. 218,
67 except for different parametrization $L = 2R_{IsGISXAXS}$. Since BornAgain-1.6 implemented using the generic polyhedron form factor [Wuttke, J Appl Cryst 54, 580 (2021)](https://doi.org/10.1107/S1600576721001710).