From b40c034cb9e2d7c0cd7b52096d07dc448db87d98 Mon Sep 17 00:00:00 2001
From: Joachim Wuttke <j.wuttke@fz-juelich.de>
Date: Sun, 21 Jul 2024 20:10:38 +0200
Subject: [PATCH] update docs
---
Doc/dev-notes/modify-formfactor.md | 12 ++++++------
hugo/content/ex/sim/scatter2d/mc.md | 6 +++---
hugo/content/ref/sample/particle/ff/_index.md | 2 +-
hugo/content/ref/sample/particle/ff/custom/index.md | 6 +++---
.../ref/sample/particle/ff/hard/bipyramid4.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/box.md | 4 ++--
.../ref/sample/particle/ff/hard/cantellatedcube.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/cone.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/cylinder.md | 4 ++--
.../ref/sample/particle/ff/hard/dodecahedron.md | 4 ++--
.../sample/particle/ff/hard/ellipsoidalcylinder.md | 4 ++--
.../ref/sample/particle/ff/hard/hemiellipsoid.md | 4 ++--
.../sample/particle/ff/hard/horizontalcylinder.md | 4 ++--
.../ref/sample/particle/ff/hard/icosahedron.md | 4 ++--
.../sample/particle/ff/hard/platonicoctahedron.md | 4 ++--
.../sample/particle/ff/hard/platonictetrahedron.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/prism3.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/prism6.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/pyramid2.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/pyramid3.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/pyramid4.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/pyramid6.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/sphere.md | 4 ++--
hugo/content/ref/sample/particle/ff/hard/spheroid.md | 4 ++--
.../ref/sample/particle/ff/hard/truncatedcube.md | 4 ++--
.../ref/sample/particle/ff/hard/truncatedsphere.md | 4 ++--
.../ref/sample/particle/ff/hard/truncatedspheroid.md | 4 ++--
hugo/content/ref/sample/particle/ff/ripples/bar.md | 4 ++--
.../content/ref/sample/particle/ff/ripples/cosine.md | 4 ++--
.../ref/sample/particle/ff/ripples/sawtooth.md | 4 ++--
.../ref/sample/particle/ff/soft/fuzzysphere.md | 2 +-
hugo/content/ref/sample/particle/ff/soft/gauss.md | 2 +-
32 files changed, 67 insertions(+), 67 deletions(-)
diff --git a/Doc/dev-notes/modify-formfactor.md b/Doc/dev-notes/modify-formfactor.md
index 576c71530a2..809255b04fc 100644
--- a/Doc/dev-notes/modify-formfactor.md
+++ b/Doc/dev-notes/modify-formfactor.md
@@ -12,22 +12,22 @@ After adding or removing a form factor, the following files need to be updated:
* Wrap/swig/libBornAgainCore.i (in two places: #include and %include)
Possibly, the form factor appears in
-* Tests/UnitTests/Core/Sample/FormFactorBasicTest.cpp
+* Tests/UnitTests/Core/Sample/FormfactorBasicTest.cpp
* Core/StandardSamples/SampleComponents.cpp
* Core/StandardSamples/...
Examples and tests, e.g.:
-* Examples/python/simulation/ex01_BasicParticles/AllFormFactorsAvailable.py
+* Examples/python/simulation/ex01_BasicParticles/AllFormfactorsAvailable.py
* Examples/python/simulation/...
-* Tests/UnitTests/Core/Sample/FormFactorBasicTest.cpp
+* Tests/UnitTests/Core/Sample/FormfactorBasicTest.cpp
* Tests/UnitTests/GUI/TestGUICoreObjectCorrespondence.cpp
-* Tests/ReferenceData/Core/FormFactors_*
-* Tests/ReferenceData/Core/FormFactorsWithAbsorption_*
+* Tests/ReferenceData/Core/Formfactors_*
+* Tests/ReferenceData/Core/FormfactorsWithAbsorption_*
If the form factor is supported by the GUI, then also:
* GUI/Models/GroupInfoCatalogue.cpp
* GUI/Models/item_constants.h
-* GUI/Models/FormFactorItems.h and .cpp
+* GUI/Models/FormfactorItems.h and .cpp
* GUI/Models/GUIDomainSampleVisitor.h and .cpp
* GUI/Models/ItemCatalogue.cpp
* GUI/Models/item_constants.h
diff --git a/hugo/content/ex/sim/scatter2d/mc.md b/hugo/content/ex/sim/scatter2d/mc.md
index 69d0195cc3c..fe382e2d3b0 100644
--- a/hugo/content/ex/sim/scatter2d/mc.md
+++ b/hugo/content/ex/sim/scatter2d/mc.md
@@ -17,8 +17,8 @@ The simulation generates four plots using different sizes of the particles, (rad
* The incident angles are $\alpha\_i = 0.2 ^{\circ}$ and $\varphi\_i = 0^{\circ}$.
{{< galleryscg >}}
-{{< figscg src="/img/draw/LargeParticlesFormFactor_setup.jpg" width="700px" caption="Real-space model">}}
-{{< figscg src="/img/auto/scatter2d/LargeParticlesFormFactor.png" width="350px" caption="Intensity image">}}
+{{< figscg src="/img/draw/LargeParticlesFormfactor_setup.jpg" width="700px" caption="Real-space model">}}
+{{< figscg src="/img/auto/scatter2d/LargeParticlesFormfactor.png" width="350px" caption="Intensity image">}}
{{< /galleryscg >}}
-{{< show-ex file="scatter2d/LargeParticlesFormFactor.py" >}}
+{{< show-ex file="scatter2d/LargeParticlesFormfactor.py" >}}
diff --git a/hugo/content/ref/sample/particle/ff/_index.md b/hugo/content/ref/sample/particle/ff/_index.md
index 4eaafdf6438..34074bb21b7 100644
--- a/hugo/content/ref/sample/particle/ff/_index.md
+++ b/hugo/content/ref/sample/particle/ff/_index.md
@@ -29,7 +29,7 @@ also hold for complex $\mathbf{q}$.
#### Implementation
-The interface class {{% ref-class "Sample/Particle" "IFormFactor" %}}
+The interface class {{% ref-class "Sample/Particle" "IFormfactor" %}}
cannot be instantiated directly.
Instead, one has to choose one of the following child classes:
diff --git a/hugo/content/ref/sample/particle/ff/custom/index.md b/hugo/content/ref/sample/particle/ff/custom/index.md
index 285b9e43b79..aa4faae102b 100644
--- a/hugo/content/ref/sample/particle/ff/custom/index.md
+++ b/hugo/content/ref/sample/particle/ff/custom/index.md
@@ -15,8 +15,8 @@ Scattering from a monodisperse distribution of particles, whose form factor is d
* The incident angles are $\alpha\_i = 0.2 ^{\circ}$ and $\varphi\_i = 0^{\circ}$.
{{< galleryscg >}}
-{{< figscg src="/img/draw/CustomFormFactor_setup.jpg" width="350px" caption="Real-space model">}}
-{{< figscg src="/img/auto/scatter2d/CustomFormFactor.png" width="350px" caption="Intensity image">}}
+{{< figscg src="/img/draw/CustomFormfactor_setup.jpg" width="350px" caption="Real-space model">}}
+{{< figscg src="/img/auto/scatter2d/CustomFormfactor.png" width="350px" caption="Intensity image">}}
{{< /galleryscg >}}
-{{< show-ex file="scatter2d/CustomFormFactor.py" >}}
+{{< show-ex file="scatter2d/CustomFormfactor.py" >}}
diff --git a/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md b/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md
index c76a756dc1a..c3de5a26851 100644
--- a/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md
+++ b/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md
@@ -34,12 +34,12 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Bipyramid4]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron
provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$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].$$
diff --git a/hugo/content/ref/sample/particle/ff/hard/box.md b/hugo/content/ref/sample/particle/ff/hard/box.md
index ac5018229d0..0f5dbb20bf3 100644
--- a/hugo/content/ref/sample/particle/ff/hard/box.md
+++ b/hugo/content/ref/sample/particle/ff/hard/box.md
@@ -28,12 +28,12 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Box]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
$$F(\mathbf{q})=LWH \space \exp\Big(iq_{z}\dfrac{H}{2}\Big) \space \text{sinc}\Big(q_{x}\dfrac{L}{2}\Big) \space \text{sinc}\Big(q_{y}\dfrac{W}{2}\Big) \space \text{sinc}\Big(q_{z}\dfrac{H}{2}\Big).$$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$V=LWH.$$
diff --git a/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md b/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md
index 2d96a849d5c..7670e053882 100644
--- a/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md
+++ b/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md
@@ -33,11 +33,11 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [CantellatedCube]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron with inversion symmetry provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V= L^3 - 6Lt^2 + \dfrac{16}{3} t^3. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/cone.md b/hugo/content/ref/sample/particle/ff/hard/cone.md
index 97b435a5be1..58398910431 100644
--- a/hugo/content/ref/sample/particle/ff/hard/cone.md
+++ b/hugo/content/ref/sample/particle/ff/hard/cone.md
@@ -32,7 +32,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "Cone" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Computation involves numerical integration in radial direction,
$$F(\mathbf{q})=2\pi \exp(i \tilde{q_{z}} R) \tan\alpha \int_{R_H}^R d\rho\thinspace \rho^2
@@ -43,7 +43,7 @@ $$\quad R_{H} := R-\dfrac{H}{\tan\alpha}, \quad
q_{||} := \sqrt{q_{x}^2 + q_{y}^2}, \quad
\tilde{q_{z}} := q_{z} \tan\alpha.$$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$V=\dfrac{\pi}{3}\tan\alpha \left( R^3 - R_H^3\right).$$
diff --git a/hugo/content/ref/sample/particle/ff/hard/cylinder.md b/hugo/content/ref/sample/particle/ff/hard/cylinder.md
index eb30b29f73d..199e11be9b2 100644
--- a/hugo/content/ref/sample/particle/ff/hard/cylinder.md
+++ b/hugo/content/ref/sample/particle/ff/hard/cylinder.md
@@ -27,7 +27,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "Cylinder" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -36,7 +36,7 @@ $$ F(\mathbf{q})=2\pi R^2H \space \exp\Big(iq_z\dfrac{H}{2}\Big) \text{sinc}\Big
with the notation
$$ q_{||} := \sqrt{q_x^2 + q_y^2}. $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$V=\pi R^2H.$$
diff --git a/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md b/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md
index 37c3ad1d13e..dd869024be1 100644
--- a/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md
+++ b/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md
@@ -29,11 +29,11 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Dodecahedron]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron with inversion symmetry provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V= \dfrac{1}{4}(15+7\sqrt{5})a^3 \approx 7.663 \space a^3. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md b/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md
index e68ba3073dc..1f581b94272 100644
--- a/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md
+++ b/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md
@@ -28,7 +28,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "EllipsoidalCylinder" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -37,7 +37,7 @@ $$ F(\mathbf{q})=2\pi R_aR_b H \space \exp\Big(iq_z\dfrac{H}{2}\Big) \text{sinc}
with the notation
$$ \gamma := \sqrt{(q_xR_a)^2 + (q_yR_b)^2}. $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$V=\pi R_aR_bH.$$
diff --git a/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md b/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md
index 2edde517070..fc37ddd14cd 100644
--- a/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md
+++ b/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md
@@ -28,7 +28,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "HemiEllipsoid" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Computation involves numerical integration in vertical direction,
@@ -40,7 +40,7 @@ $$ r_{a,z}:=R_{a}\sqrt{1-\Big( \dfrac{z}{H} \Big)^2}, \quad r_{b,z}:=R_{b}\sqrt{
$$ \quad \gamma_{z} := \sqrt{(q_xr_{a,z})^2 + (q_yr_{b,z})^2}. $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{2\pi}{3} R_aR_bH. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md b/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md
index 84dc10f8501..17f59ec03e4 100644
--- a/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md
+++ b/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md
@@ -38,14 +38,14 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "HorizontalCylinder" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
$$ F(\mathbf{q})=2 L \space \text{sinc}\Big(q_x\dfrac{L}{2}\Big)
\int_{b}^{t} \text{d}z \space \sqrt{R^2-z^2} \space \text{sinc}(q_y\sqrt{R^2-z^2}) \exp\[iq_z(z-b)\] , $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$V=L \Big\( t\sqrt{R^2-t^2}- b\sqrt{R^2-b^2} + R^2 \Big\[\text{asin}\Big(\frac{t}{R}\Big) - \text{asin}\Big(\frac{b}{R}\Big) \Big\]
\Big\).$$
diff --git a/hugo/content/ref/sample/particle/ff/hard/icosahedron.md b/hugo/content/ref/sample/particle/ff/hard/icosahedron.md
index 67c64052c4e..3db04665d4d 100644
--- a/hugo/content/ref/sample/particle/ff/hard/icosahedron.md
+++ b/hugo/content/ref/sample/particle/ff/hard/icosahedron.md
@@ -29,11 +29,11 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Icosahedron]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron with inversion symmetry provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V= \dfrac{5}{12}(3+\sqrt{5})a^3 \approx 2.182 \space a^3. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md b/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md
index 0cd94bc5f33..797a1d74c91 100644
--- a/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md
+++ b/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md
@@ -29,11 +29,11 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [PlatonicOctahedron]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V= \dfrac{\sqrt{2}}{3}L^3. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md b/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md
index d574a83ab1e..8c316370c1c 100644
--- a/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md
+++ b/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md
@@ -30,11 +30,11 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [PlatonicTetrahedron]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V= \dfrac{\sqrt{2}}{12}L^3. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/prism3.md b/hugo/content/ref/sample/particle/ff/hard/prism3.md
index 40497991af1..72db3d6c2ad 100644
--- a/hugo/content/ref/sample/particle/ff/hard/prism3.md
+++ b/hugo/content/ref/sample/particle/ff/hard/prism3.md
@@ -27,7 +27,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Prism3]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -35,7 +35,7 @@ $$ F(\mathbf{q})=H \space \exp\Big(iq_z\dfrac{H}{2}\Big) \space \text{sinc}\Big(
where the form factor $F_{||}(\mathbf{q}_{||}) $ computation is based on the generic form factor of a planar polygon provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{\sqrt3}{4}HL^2. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/prism6.md b/hugo/content/ref/sample/particle/ff/hard/prism6.md
index 4b061c02f15..6d6fc94457a 100644
--- a/hugo/content/ref/sample/particle/ff/hard/prism6.md
+++ b/hugo/content/ref/sample/particle/ff/hard/prism6.md
@@ -27,7 +27,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Prism6]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -35,7 +35,7 @@ $$ F(\mathbf{q})=H \space \exp\Big(iq_z\dfrac{H}{2}\Big) \space \text{sinc}\Big(
where the form factor $F_{||}(\mathbf{q}_{||}) $ computation is based on the generic form factor of a planar polygon with two-fold symmetry $(S_2)$ provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{3\sqrt3}{2}HR^2. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid2.md b/hugo/content/ref/sample/particle/ff/hard/pyramid2.md
index bc0e0abfdb1..6052e7d4c48 100644
--- a/hugo/content/ref/sample/particle/ff/hard/pyramid2.md
+++ b/hugo/content/ref/sample/particle/ff/hard/pyramid2.md
@@ -33,12 +33,12 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Pyramid2]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron
provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=H\Big[LW-\dfrac{(L+W)H}{\tan\alpha}+\dfrac{4}{3}\dfrac{H^2}{\tan^2\alpha}\Big]. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid3.md b/hugo/content/ref/sample/particle/ff/hard/pyramid3.md
index b007c4048e5..d24df8f7a15 100644
--- a/hugo/content/ref/sample/particle/ff/hard/pyramid3.md
+++ b/hugo/content/ref/sample/particle/ff/hard/pyramid3.md
@@ -35,12 +35,12 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Pyramid3]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron
provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{L^3\tan\alpha}{24}\Big[1-\Big(1-\dfrac{2\sqrt3H}{L\tan\alpha}\Big)^3\Big]. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid4.md b/hugo/content/ref/sample/particle/ff/hard/pyramid4.md
index 6922913be0e..91761292dbc 100644
--- a/hugo/content/ref/sample/particle/ff/hard/pyramid4.md
+++ b/hugo/content/ref/sample/particle/ff/hard/pyramid4.md
@@ -32,13 +32,13 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Pyramid4]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron
provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{L^3\tan\alpha}{6}\Big[1-\Big(1-\dfrac{2H}{L\tan\alpha}\Big)^3\Big]. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid6.md b/hugo/content/ref/sample/particle/ff/hard/pyramid6.md
index bbcb26fcbd9..3b34a50fe4e 100644
--- a/hugo/content/ref/sample/particle/ff/hard/pyramid6.md
+++ b/hugo/content/ref/sample/particle/ff/hard/pyramid6.md
@@ -34,12 +34,12 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [Pyramid6]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron
provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{3}{4}R^3\tan\alpha\Big[1-\Big(1-\dfrac{2H}{\sqrt3R\tan\alpha}\Big)^3\Big]. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/sphere.md b/hugo/content/ref/sample/particle/ff/hard/sphere.md
index 0493a23083a..5cf4777d3d6 100644
--- a/hugo/content/ref/sample/particle/ff/hard/sphere.md
+++ b/hugo/content/ref/sample/particle/ff/hard/sphere.md
@@ -26,7 +26,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "Sphere" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -36,7 +36,7 @@ $$ F(\mathbf{q})=4\pi R^3 \exp(iq_z R) \dfrac{\sin(qR) - qR \cos(qR)}{(qR)^3} ,
with the notation
$$ q := \sqrt{q_x^2 + q_y^2+ q_z^2}. $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{4\pi}{3} R^3. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/spheroid.md b/hugo/content/ref/sample/particle/ff/hard/spheroid.md
index dfaab3483fb..36105003886 100644
--- a/hugo/content/ref/sample/particle/ff/hard/spheroid.md
+++ b/hugo/content/ref/sample/particle/ff/hard/spheroid.md
@@ -27,7 +27,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "Spheroid" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -35,7 +35,7 @@ $$ F(\mathbf{q})=4\pi R^2h \exp(iq_zh) \dfrac{\sin(s) - s \cos(s)\}{s^3} , $$
with the notation
$$ h:=H/2, \quad s := \sqrt{(Rq_x)^2 + (Rq_y)^2+ (hq_z)^2}. $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{2\pi}{3} R^2H. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md b/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md
index 81e833faa20..d11b9df0409 100644
--- a/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md
+++ b/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md
@@ -32,12 +32,12 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class [TruncatedCube]({{% url-src %}}/Sample/HardParticle/Polyhedra.h) inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor computation is based on the generic form factor of a polyhedron
provided by {{% link-libformfactor %}}.
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V= L^3 - \dfrac{4}{3} t^3. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md b/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md
index f31a61acd1b..34a461ce445 100644
--- a/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md
+++ b/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md
@@ -32,7 +32,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "TruncatedSphere" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Computation involves numerical integration in vertical direction,
@@ -42,7 +42,7 @@ with the notation
$$ q_{||} := \sqrt{q_x^2 + q_y^2}, \quad R_z:=\sqrt{R^2-z^2} $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{\pi}{3} \[ 3R(H^2-dh^2) + dh^3 -H^3 \]. $$
diff --git a/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md b/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md
index 0b3d26d3fbd..7d23a8a27c5 100644
--- a/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md
+++ b/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md
@@ -33,7 +33,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "TruncatedSpheroid" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Computation involves numerical integration in vertical direction,
@@ -43,7 +43,7 @@ with the notation
$$ q_{||} := \sqrt{q_x^2 + q_y^2}, \quad R_z:=\sqrt{R^2-z^2/f_p^2} $$
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{\pi}{3f_p^2} \[ 3f_pR(H^2-dh^2) + dh^3 -H^3 \]. $$
diff --git a/hugo/content/ref/sample/particle/ff/ripples/bar.md b/hugo/content/ref/sample/particle/ff/ripples/bar.md
index 11438d38791..c302b624c58 100644
--- a/hugo/content/ref/sample/particle/ff/ripples/bar.md
+++ b/hugo/content/ref/sample/particle/ff/ripples/bar.md
@@ -33,7 +33,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "Bar" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -45,7 +45,7 @@ $$ f_\bot(q_y,q_z) = WH \space \exp\Big(iq_{z}\dfrac{H}{2}\Big) \space \text{si
Corresponding factor $ f_\parallel(q_x) $ is chosen according to [longitudinal profile](/ref/sample/particle/ff/ripples/).
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$V=LWH.$$
diff --git a/hugo/content/ref/sample/particle/ff/ripples/cosine.md b/hugo/content/ref/sample/particle/ff/ripples/cosine.md
index 1fa9a720146..05ea03296c8 100644
--- a/hugo/content/ref/sample/particle/ff/ripples/cosine.md
+++ b/hugo/content/ref/sample/particle/ff/ripples/cosine.md
@@ -31,7 +31,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "CosineRipple" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -40,7 +40,7 @@ $$ F(\mathbf{q}) = f_\parallel(q_x) f_\bot(q_y,q_z), $$
where $ f_\bot(q_y,q_z) $ is calculated numerically
and $ f_\parallel(q_x) $ is chosen according to [longitudinal profile](/ref/sample/particle/ff/ripples/).
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{LWH}{2}. $$
diff --git a/hugo/content/ref/sample/particle/ff/ripples/sawtooth.md b/hugo/content/ref/sample/particle/ff/ripples/sawtooth.md
index 5d46354277c..e964922e632 100644
--- a/hugo/content/ref/sample/particle/ff/ripples/sawtooth.md
+++ b/hugo/content/ref/sample/particle/ff/ripples/sawtooth.md
@@ -36,7 +36,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/HardParticle" "SawtoothRipple" %}} inherits from the interface class
-{{% ref-class "Sample/Particle" "IFormFactor" %}}.
+{{% ref-class "Sample/Particle" "IFormfactor" %}}.
Form factor is computed as
@@ -56,7 +56,7 @@ $$ \alpha_{+} = H q_z + \frac{q_y W}{2} + q_y d, \quad
Corresponding factor $ f_\parallel(q_x) $ is chosen according to [longitudinal profile](/ref/sample/particle/ff/ripples/).
-Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormFactorBasicTest.cpp)
+Volume [has been validated]({{% url-src %}}/Tests/Unit/Sample/FormfactorBasicTest.cpp)
against
$$ V=\dfrac{LWH}{2}. $$
diff --git a/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md b/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md
index a41956264cb..18ab4ec90dc 100644
--- a/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md
+++ b/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md
@@ -23,7 +23,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/SoftParticle" "FuzzySphere" %}} inherits
-from the interface class {{% ref-class "Sample/Particle" "IFormFactor" %}}.
+from the interface class {{% ref-class "Sample/Particle" "IFormfactor" %}}.
The form factor is computed as
$$F(q)=F_{\rm sphere}(q) \exp(-\sigma^2 q^2 /2)$$
diff --git a/hugo/content/ref/sample/particle/ff/soft/gauss.md b/hugo/content/ref/sample/particle/ff/soft/gauss.md
index 49b2a70dbc8..8c56537b412 100644
--- a/hugo/content/ref/sample/particle/ff/soft/gauss.md
+++ b/hugo/content/ref/sample/particle/ff/soft/gauss.md
@@ -23,7 +23,7 @@ As for any other [Form factor](/ref/sample/particle/ff).
#### Implementation
Class {{% ref-class "Sample/SoftParticle" "Gauss" %}} inherits
-from the interface class {{% ref-class "Sample/Particle" "IFormFactor" %}}.
+from the interface class {{% ref-class "Sample/Particle" "IFormfactor" %}}.
The form factor is computed as
$$F(q)=R^3 \exp\left(-|q|^2R^2/(4\pi)\right).$$
--
GitLab