commit 6998f7cade78ade3b79bd381a6dfa7ee1d6c83f0
parent 008cace40d1b8d6cc3a565027f847d39dc61a89f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 18 Mar 2016 14:34:22 +0100
Update the schiff-geometry man page
Diffstat:
1 file changed, 23 insertions(+), 23 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -1,18 +1,18 @@
.TH SCHIFF-GEOMETRY 5
.SH NAME
-schiff-geometry \- control the shape of micro organisms
+schiff-geometry \- control the shape of soft particles
.SH DESCRIPTION
A \fBschiff-geometry\fR is a YAML [1] file that controls the geometry
-distribution of a family of micro organisms. The
+distribution of a family of soft particles. The
.BR schiff (1)
-program relies on this description to sample a set micro organism shapes
+program relies on this description to sample a set of soft particles
in order to estimate the radiative properties of their family.
.PP
A geometry is defined by a shape type whose parameters are controlled by a
specific distribution. Several geometries with their own probability can be
declared in the same \fBschiff-geometry\fR file to define a discrete random
variates of geometry distributions. This allow to finely tune the overall
-geometry distribution of a micro organism family with a collection of geometry
+geometry distribution of a soft particle family with a collection of geometry
distributions, each representing a specific sub-set of the family shapes.
.PP
There is two main shape types: the \fBcylinder\fR and the \fBsphere\fR.
@@ -22,9 +22,9 @@ 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
-To declare a spherical geometry distribution, simply map the \fBsphere\fR shape to
-a distribution of its \fBradius\fR. A cylindrical geometry distribution can be
-declared in two ways. Either directly, by defining the distribution of the
+To declare a spherical geometry distribution, simply map the \fBsphere\fR shape
+to a distribution of its \fBradius\fR. A cylindrical geometry distribution can
+be declared in two ways. Either directly, by defining the distribution of the
\fBheight\fR and the \fBradius\fR of the cylinder shape, or by fixing its
height/radius \fBaspect_ratio\fR and defining the distribution of the
\fBradius\fR of a sphere whose volume is equal to the cylinder volume.
@@ -38,20 +38,20 @@ this distribution is implicitly used if the parameter value is a constant;
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
-\fBprobabilities\fR array of \fIN\fR+1 entries used to build the cumulative
-distribution of the parameter. Let a random number "r" in [0, 1], the
-corresponding parameter value is computed by retrieving the interval of the
-parameter from the aforementioned cumulative before linearly interpolating its
-bounds with respect to "r";
+\fBprobabilities\fR array and are used to build the cumulative distribution of
+the parameter. Let a random number "r" in [0, 1], the corresponding parameter
+value is computed by retrieving the interval of the parameter from the
+aforementioned cumulative before linearly interpolating its bounds with respect
+to "r";
.IP \(bu 4
with the \fBlognormal\fR distribution, the parameter is distributed with respect
to a mean value \fBzeta\fR and a standard deviation \fBsigma\fR:
P(x) dx = 1/(log(\fBsigma\fR)*x*sqrt(2*PI) *
exp(-(ln(x)-log(\fBzeta\fR))^2 / (2*log(\fBsigma\fR)^2)) dx
.SS Grammar
-The section describes the \fBschiff\-geometry\fR grammar based on the YAML [1]
-human readable data format. The YAML format provides several ways to define a
-mapping or a sequence of data. The following grammar always uses the more
+This section describes the \fBschiff\-geometry\fR grammar based on the YAML
+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.
.TP
@@ -98,7 +98,7 @@ the example section for illustrations of such alternatives.
[ \fB-\fR <\fIprobabilities\-list\fR> ]
.SH EXAMPLES
.PP
-Micro organisms are spheres whose radius is distributed according to an
+Soft particles are spheres whose radius is distributed according to an
histogram:
.PP
\fBsphere:
@@ -113,7 +113,7 @@ histogram:
- 1.23
- 3\fR
.PP
-Micro organisms are cylinders. Their radius is constant and their height is
+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:
.PP
@@ -125,9 +125,9 @@ discretized in 64 slices along 2PI:
zeta: 1.3
sigma: 0.84\fR
.PP
-Micro organisms are cylinders whose height/radius is fixed. Their volume is
-equal to the volume of a sphere whose radius is distributed with respect to an
-histogram:
+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
+an histogram:
.PP
\fBcylinder:
aspect_ratio: 1
@@ -137,9 +137,9 @@ histogram:
upper: 4.56
probabilities: [ 2, 1.2, 3, 0.2 ]\fR
.PP
-Micro organisms are spheres and cylinders with 2 times more spheres than
+Soft particles are spheres and cylinders with 2 times more spheres than
cylinders. The cylinder parameters are controlled by lognormal distributions
-and spherical micro organisms have a fix radius:
+and spherical soft particles have a fixed radius:
.PP
\fB- sphere: { radius 1.12, proba: 2.0, slices: 64 }
\fB- cylinder:
@@ -150,7 +150,7 @@ and spherical micro organisms have a fix radius:
.SH NOTE
.TP
[1]
-YAML Ain't Markup Language - http://yaml.org
+YAML Ain't Markup Language \- http://yaml.org
.SH SEE ALSO
.BR schiff (1)
