commit dc45d44a429fbdf7277bed8193b914764ea01d4e
parent 42b1dad5561fc2cc87954113f25a3699efe4ab09
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 21 Mar 2016 10:01:57 +0100
Document the ellipsoid distribution in the schiff-geometry man-page
Diffstat:
1 file changed, 44 insertions(+), 17 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -16,22 +16,28 @@ geometry distribution of soft particles with a collection of geometry
distributions, each representing a specific sub-set of shapes of the soft
particles to handle.
.PP
-\fBschiff-geometry\fR supports two main geometry types: the \fBcylinder\fR and
-the \fBsphere\fR. A geometry type defined the shape of the soft particles that is
-then discretized by
-.BR schiff (1)
-in triangular meshes with respect to its \fBslices\fR attribute, i.e. the
-number of discrete divisions along 2PI. By default \fBslices\fR is set to 64.
-.PP
-To declare a spherical distribution of soft particles, one have to setup the
-distribution of the \fBradius\fR of a \fBsphere\fR geometry. A cylindrical
-distribution can be defined in two ways. The first way is to directly control
-the distribution of the \fBheight\fR and the \fBradius\fR of the cylinder. The
-second way is to fix its height/radius \fBaspect_ratio\fR and define the
-distribution of sphere \fBradius\fR whose volume is equal to the volume of the
-cylinder.
-.PP
-All the aforementioned parameters can be distributed with respect to the
+\fBschiff-geometry\fR supports three geometry types: the \fBellipsoid\fR, the
+\fBcylinder\fR and the \fBsphere\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.
+.PP
+An ellipsoidal distribution of the soft particle shapes is controlled by the
+distribution of the 3 semi\-principal axis \fBa\fR, \fBb\fR and \fBc\fR of the
+\fBellipsoid\fR equation:
+.IP " " 4
+(x/\fBa\fR)^2 + (y/\fBb\fR)^2 + (z/\fBc\fR)^2 = 1
+.PP
+A cylindrical distribution can be defined in two ways. The first manner is to
+directly control the distribution of the \fBheight\fR and the \fBradius\fR of
+the \fBcylinder\fR. The second way is to fix its height/radius
+\fBaspect_ratio\fR and define the distribution of a sphere \fBradius\fR whose
+volume is equal to the volume of the \fBcylinder\fR. Finally, a spherical
+distribution is simply controlled by the distribution of the \fBradius\fR of
+the \fBsphere\fR.
+.PP
+All the aforementioned shape parameters can be distributed with respect to the
following distributions:
.IP \(bu 4
the constant distribution simply fixes the value of the parameter. Actually
@@ -63,9 +69,18 @@ the example section for illustrations of such alternatives.
<\fIgeometry\-list\fR> ::=
\fB-\fR <\fIgeometry\fR>
[ \fB-\fR <\fIgeometry\fR> ]
+.PP
+\l'20'
.TP
<\fIgeometry\fR> ::=
- <\fIcylinder\-geometry\fR> | <\fIsphere\-geometry\fR>
+ <\fIellipsoid\-geometry\fR>
+ | <\fIcylinder\-geometry\fR>
+ | <\fIsphere\-geometry\fR>
+.TP
+<\fIellipsoid\-geometry\fR>
+ \fBa:\fR <\fIdistribution\fR>
+ \fBb:\fR <\fIdistribution\fR>
+ \fBc:\fR <\fIdistribution\fR>
.TP
<\fIcylinder\-geometry\fR> ::=
\fBcylinder:
@@ -79,6 +94,8 @@ the example section for illustrations of such alternatives.
\fBradius:\fR <\fIdistribution\fR>
[ \fBslices:\fI INTEGER\fR ] # Discretisation along 2PI
[ \fBproba:\fI REAL\fR ]
+.PP
+\l'20'
.TP
<\fIdistribution\fR> ::=
\fIREAL\fR| <\fIlognormal\fR> | <\fIhistogram\fR>
@@ -115,6 +132,16 @@ histogram:
- 1.23
- 3\fR
.PP
+Soft particles are ellipsoids whose one of its semi-principal axis is
+distributed with respect to a lognormal distribution:
+ \fBellipsoid:
+ a: 1.0
+ b: 2.1
+ c:
+ lognormal:
+ sigma: 0.2
+ zeta: 1.3\fR
+.PP
Soft particles are cylinders. Their radius is constant and their height is
distributed according to a lognormal distribution. The cylinder geometry is
discretized in 64 slices along 2PI:
