commit f7ce89531da8269e8f12108300b1d8ad1074bba1
parent 5213a1acdc9f5bda48043347d27fc3440f328aba
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 18 Mar 2016 15:13:23 +0100
Remove the duplicated schiff-geometry man page
Diffstat:
| D | doc/schiff-geometry.5 | | | 156 | ------------------------------------------------------------------------------- |
1 file changed, 0 insertions(+), 156 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -1,156 +0,0 @@
-.TH SCHIFF-GEOMETRY 5
-.SH NAME
-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 soft particles. The
-.BR schiff (1)
-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 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.
-A 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
-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.
-.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
-this distribution is implicitly used if the parameter value is a constant;
-.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
-\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
-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
-\fBschiff\-geometry\fR ::=
- <\fIgeometry\fR> | <\fIgeometry\-list>
-.TP
-<\fIgeometry\-list\fR> ::=
- \fB-\fR <\fIgeometry\fR>
- [ \fB-\fR <\fIgeometry\fR> ]
-.TP
-<\fIgeometry\fR> ::=
- <\fIcylinder\-geometry\fR> | <\fIsphere\-geometry\fR>
-.TP
-<\fIcylinder\-geometry\fR> ::=
- \fBcylinder:
- \fBradius:\fR <\fIdistribution\fR>
- \fBheight:\fR <\fIdistribution\fR> | \fBaspect_ratio:\fR <\fIdistribution\fR>
- [ \fBslices:\fI integer\fR ]
- [ \fBproba:\fI real\fR ]
-.TP
-<\fIsphere\-geometry\fR>
- \fBsphere:\fR
- \fBradius:\fR <\fIdistribution\fR>
- [ \fBslices:\fI integer\fR ] # Discretisation along 2PI
- [ \fBproba:\fI real\fR ]
-.TP
-<\fIdistribution\fR> ::=
- \fIreal\fR| <\fIlognormal\fR> | <\fIhistogram\fR>
-.TP
-<\fIlognormal\fR> ::=
- \fBlognormal:
- zeta: \fIreal\fB
- sigma:\fI real\fB
-.TP
-<\fIhistogram\fR> ::=
- \fBhistogram:\fR
- \fBlower:\fI real\fR
- \fBupper:\fI real\fR
- \fBprobabilities:\fR
- <\fIprobabilities\-list\fR>
-.TP
-<\fIprobabilities\-list\fR> ::=
- \fB-\fI real\fR
- [ \fB-\fR <\fIprobabilities\-list\fR> ]
-.SH EXAMPLES
-.PP
-Soft particles are spheres whose radius is distributed according to an
-histogram:
-.PP
- \fBsphere:
- radius:
- histogram:
- lower: 1.0 # Min radius
- upper: 2.1 # Max radius
- probabilities:
- - 2
- - 1
- - 0.4
- - 1.23
- - 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:
-.PP
- \fBcylinder:
- slices: 64
- radius: 1
- height:
- lognormal:
- zeta: 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
-an histogram:
-.PP
- \fBcylinder:
- aspect_ratio: 1
- radius:
- histogram:
- lower: 1.24
- upper: 4.56
- probabilities: [ 2, 1.2, 3, 0.2 ]\fR
-.PP
-Soft particles are spheres and cylinders with 2 times more spheres than
-cylinders. The cylinder parameters are controlled by lognormal distributions
-and spherical soft particles have a fixed radius:
-.PP
- \fB- sphere: { radius 1.12, proba: 2.0, slices: 64 }
- \fB- cylinder:
- radius: {lognormal: { sigma: 2.3, zeta: 0.2 } }
- height: {lognormal: { zeta: 1, sigma: 1.5 } }
- slices: 32 # Discretisation in 32 slices
- proba: 1\fR
-.SH NOTES
-.TP
-[1]
-YAML Ain't Markup Language \- http://yaml.org
-.SH SEE ALSO
-.BR schiff (1)
-
