schiff

commit 84cd957f3a5e0255ad75cf889bec785a76f21fa4
parent 5ab29f8ffab000ebc458af6234441e4915a9cb57
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Thu, 24 Mar 2016 15:45:21 +0100

Document the default proba value

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

1 file changed, 17 insertions(+), 11 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -19,12 +19,9 @@ variate of geometries. This allow to finely tune the shapes of the soft
 particles with a collection of geometries, each representing a specific sub-set
 of shapes of the soft particles to handle.
 .SS Geometry types
+A geometry type defined the overall shape of the soft particles.
 \fBschiff-geometry\fR supports four geometry types: the \fBellipsoid\fR, the
-\fBcylinder\fR, the \fBsphere\fR and the \fBsupershape\fR. A geometry type
-defined the overall shape of the soft particles. This shape is discretized by
-.BR schiff (1)
-in triangular meshes with respect to the \fBslices\fR attribute, i.e. the number
-of discrete divisions along 2PI. By default \fBslices\fR is set to 64.
+\fBcylinder\fR, the \fBsphere\fR and the \fBsupershape\fR.
 .IP \(bu 4
 An ellipsoidal geometry can be controlled in two ways. One can either
 directly define the distribution of its semi\-principal axis \fBa\fR and
@@ -94,6 +91,12 @@ human readable data format [1]. The YAML format provides several ways to define
 a mapping or a sequence of data. The following grammar always uses the more
 verbose form but any alternative YAML formatting can be used instead. Refer to
 the example section for illustrations of such alternatives.
+.PP
+Each geometry has the 2 optionnal attributes \fBslices\fR and \fBproba\fR. The
+former controls the number of discret divisions along 2PI used to generate the
+triangulated mesh of the geometry. If it is not defined, \fBslices\fR is
+assumed to be 64. The latter defines the unnormalized probability to sample the
+geometry. By default, it is equal to 1.
 .TP
 \fBschiff\-geometry\fR ::=
   <\fIgeometry\fR> | <\fIgeometry\-list>
@@ -112,8 +115,9 @@ the example section for illustrations of such alternatives.
 .TP
 <\fIellipsoid\-geometry\fR> ::=
   \fBellipsoid:\fR
-    <\fIellipsoid\-parameters\fR>
-  | <\fIellipsoid\-sphere\-parameters\fR>
+    <\fIellipsoid\-parameters\fR> | <\fIellipsoid\-sphere\-parameters\fR>
+  [ \fBslices:\fI INTEGER\fR ]
+  [ \fBproba:\fI REAL\fR ]
 .TP
 <\fIellipsoid\-parameters\fR> ::=
   \fBa:\fR <\fIdistribution\fR>
@@ -133,13 +137,15 @@ the example section for illustrations of such alternatives.
 <\fIsphere\-geometry\fR> ::=
   \fBsphere:\fR
     \fBradius:\fR <\fIdistribution\fR>
-  [ \fBslices:\fI INTEGER\fR ] # Discretisation along 2PI
+  [ \fBslices:\fI INTEGER\fR ]
   [ \fBproba:\fI REAL\fR ]
 .TP
 <\fIsupershape\-geometry\fR> ::=
   \fBsupershape:\fR
     \fBformula0:\fR <\fIsuperformula\fR>
     \fBformula1:\fR <\fIsuperformula\fR>
+  [ \fBslices:\fI INTEGER\fR ]
+  [ \fBproba:\fI REAL\fR ]
 .TP
 <\fIsuperformula\fR> ::=
   \fBA:\fR <\fIdistribution\fR>
@@ -238,20 +244,20 @@ Soft particles are supershapes whose 2 parameters of each of its superformulas
 are controlled by gaussian distributions:
 .IP " " 4
 \fBsupershape:
-  formula0: 
+  formula0:
     A: 1
     B: 1
     M: { gaussian: { mu: 5, sigma: 1 } }
     N0: 1
     N1: 1
     N2: { gaussian: { mu: 3, sigma: 1 } }
-  formula1: 
+  formula1:
     A: 1
     B: 1
     M: { gaussian: { mu: 1.2, sigma: 0.3 } }
     N0: 1
     N1: 1
-    N2: { gaussian: { mu: 1, sigma: 0.3 } } 
+    N2: { gaussian: { mu: 1, sigma: 0.3 } }
 .PP
 Soft particles are spheres and cylinders with 2 times more spheres than
 cylinders. The cylinder parameters are controlled by lognormal distributions