Skip to content
Snippets Groups Projects
Commit b40c034c authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

update docs

parent db7bb1b7
No related branches found
No related tags found
1 merge request!2677rename "FormFactor" -> "Formfactor"
Showing
with 22 additions and 22 deletions
......@@ -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]. $$
......
......@@ -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]. $$
......
......@@ -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. $$
......
......@@ -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. $$
......
......@@ -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. $$
......
......@@ -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 \]. $$
......
......@@ -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 \]. $$
......
......@@ -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.$$
......
......@@ -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}. $$
......
......@@ -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}. $$
......
......@@ -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)$$
......
......@@ -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).$$
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment