update docs

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

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" >}}

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:
 

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" >}}

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].$$
 

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.$$
 

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. $$
 

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).$$
 

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.$$
 

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. $$
 

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.$$
 

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. $$
 

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\).$$

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. $$
 

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. $$
 

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. $$
 

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. $$
 

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. $$
 

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]. $$
 

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]. $$