schiff

commit 51ee422cf8413d3c09b157508d1c939dc3a6cd31
parent 2f167ea14d8d18716a0f35b1687438f57843c266
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 23 Mar 2016 10:58:51 +0100

Document the gaussian distribution

Diffstat:
M
doc/schiff-geometry.5
 | 
19
+++++++++++++++----

1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -50,6 +50,12 @@ distributions:
 the constant distribution fixes the value of the parameter. Actually this
 distribution is implicitly used if the parameter value is a constant;
 .IP \(bu 4
+the \fBgaussian\fR distribution use the following probability distribition to
+define the parameter according to the mean value \fBmu\fR and the standard
+deviation \fBsigma\fR:
+.IP " " 8
+P(x) dx = 1 / (\fBsigma\fR*sqrt(2*PI)) * exp(1/2*((x-\fBmu\fR)/\fBsigma\fR)^2) dx
+.IP \(bu 4
 the \fBhistogram\fR distribution splits the parameter domain [\fBlower\fR,
 \fBupper\fR] in \fIN\fR intervals of length (\fBupper\fR-\fBlower\fR)/\fIN\fR.
 The list of unnormalized probabilities of the interval bounds are listed in the
@@ -114,12 +120,17 @@ the example section for illustrations of such alternatives.
 \l'20'
 .TP
 <\fIdistribution\fR> ::=
-    \fIREAL\fR| <\fIlognormal\fR> | <\fIhistogram\fR>
+    \fIREAL\fR| <\fIlognormal\fR> | <\fIgaussian\fR\> | <\fIhistogram\fR>
 .TP
 <\fIlognormal\fR> ::=
   \fBlognormal:
     mu: \fIREAL\fB
-    sigma: \fIREAL\fB
+    sigma: \fIREAL\fR
+.TP
+<\fIgaussian\fR> ::=
+  \fBgaussian:
+    mu: \fIREAL\fB
+    sigma: \fIREAL\fR
 .TP
 <\fIhistogram\fR> ::=
   \fBhistogram:\fR
@@ -171,13 +182,13 @@ follows an histogram distribution:
       probabilities: [ 0.5, 2, 1 ]\fR
 .PP
 Soft particles are cylinders. Their radius is constant and their height is
-distributed according to a lognormal distribution. The cylinder geometry is
+distributed according to a gaussian distribution. The cylinder geometry is
 discretized in 64 slices along 2PI:
 .IP " " 4
 \fBcylinder:
   slices: 64
   radius: 1
-  height: { lognormal: { mu: 1.3, sigma: 0.84 } }\fR
+  height: { gaussian: { mu: 1.3, sigma: 0.84 } }\fR
 .PP
 Soft particles are cylinders whose height/radius ratio is fixed. Their volume
 is equal to the volume of a sphere whose radius is distributed with respect to