Debian Codegraph @

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

raw
1 +++
2 title = "PlatonicTetrahedron"
3 +++
4
5 ### PlatonicTetrahedron
6
7 A regular tetrahedron.
8
9 <img src="/img/draw/ff/3d/PlatonicTetrahedron.png" width="30%">
10 <img src="/img/draw/ff/2d/PlatonicTetrahedron_xy.svg" width="30%">
11 <img src="/img/draw/ff/2d/PlatonicTetrahedron_xz.svg" width="30%">
12
13 #### Constructor
14
15 ```python
16 PlatonicTetrahedron(L)
17 ```
18
19 Parameters:
20 - L, length of the edge
21
22 #### Usage
23
24 As for any other [Form factor](/ref/sample/particle/ff).
25
26 #### Implementation
27
28 Class [PlatonicTetrahedron]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
29 {{% ref-class "Sample/Particle" "Formfactor" %}}.
30
31 Form factor computation is based on the generic form factor of a polyhedron provided by {{% link-libformfactor %}}.
32
33 Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
34 against
35 $$ V= \dfrac{\sqrt{2}}{12}L^3. $$
36
37 #### Related shapes
38
39 More general:
40 - [Pyramid3](/ref/sample/particle/ff/hard/pyramid3), if not regular and/or truncated.
41
42 #### Example
43
44 Scattering by uncorrelated, oriented tetrahedra for horizontal incidence:
45
46 <img src="/img/auto/ff/PlatonicTetrahedron.png">
47
48 Generated by {{% ref-ex "sas/sas-ff.py" %}} (`particle_geometry=PlatonicTetrahedron`).
49
50 #### History
51
52 Introduced in BornAgain 1.20.
53
54 Name chosen to disambiguate from "Tetrahedron", which up to BornAgain 1.19 stood for a trigonal pyramid (Pyramid3).
55
56