commit 900372082fa4dc19fd75d7d76078cf57df796dc6
parent 279862edbd47adcf7278314d8fc10bff014bbbe7
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 28 Mar 2016 20:54:47 +0200
Update the schiff documentation
Fix misspellings in the schiff-geometry man page. Slight improvements of
the schiff program description. Improve the documentation of the
characteristic length option.
Diffstat:
2 files changed, 14 insertions(+), 11 deletions(-)
diff --git a/doc/schiff-geometry.5 b/doc/schiff-geometry.5
@@ -39,7 +39,7 @@ independently controlled by their own distribution. In the second case, the
height/radius \fBaspect_ratio\fR is fixed and its volume is equal to the volume
of a sphere whose \fRradius\fR is controlled by a distribution;
.IP \(bu 4
-An helical pipe is an helipsoid whose meridian shape is a circle that is
+An helical pipe is an helicoid whose meridian shape is a circle that is
orthogonal to the helicoid slope. Its \fBpitch\fR defines the width of a
complete helicoid turn and its \fBheight\fR controls the overall distance between
the beginning and the end of the helicoid. Finally, the \fBradius_helicoid\fR
@@ -117,7 +117,7 @@ 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
-All the geometries have the \fBproba\fR optionnal attribute That defines the
+All the geometries have the \fBproba\fR optionnal attribute that defines the
unnormalized probability to sample the geometry. If it is not defined, it is
assumed to be equal to 1.
.TP
@@ -273,8 +273,9 @@ an histogram:
upper: 4.56
probabilities: [ 2, 1.2, 3, 0.2 ]\fR
.PP
-Soft particle are helical pipes. Their helicoid curve is split in 256 steps
-while its meridian is discretised in 128 slices:
+Soft particle are helical pipes whose attributes are controlled by several
+distribution types. Their helicoid curve is split in 256 steps while its
+meridian is discretised in 128 slices:
.IP "" 4
\fBhelical_pipe:
slices_helicoid: 256
diff --git a/doc/schiff.1 b/doc/schiff.1
@@ -11,11 +11,11 @@ schiff \- estimate radiative properties of soft particles
[\fIFILE\fR]
.SH DESCRIPTION
\fBschiff\fR computes the radiative properties of soft particles with an
-"Approximation Method for Short Wavelength or High Energy Scattering" [1]. It
-relies on the Monte\-Carlo method to solve Maxwell's equations within Schiff's
-approximation [2]; it estimates total cross sections (extinction, absorption
-and scattering cross-sections) in addition of the inverse cumulative phase
-function.
+"Approximation Method for Short Wavelength or High Energy Scattering" [1]. The
+implemented model is detailed in [2]. It relies on the Monte\-Carlo method to
+solve Maxwell's equations within Schiff's approximation; it estimates total
+cross sections (extinction, absorption and scattering cross-sections) in
+addition of the inverse cumulative phase function.
.PP
The shapes of the soft particles are controlled by the
.BR schiff-geometry (5)
@@ -64,7 +64,9 @@ define the
file that controls the geometry distribution of the soft particles.
.TP
.B \-l \fILENGTH\fR
-characteristic length in micron of the soft particles.
+characteristic length in micron of the soft particles. Used for the definition
+of the angle that sets the limit between small and large scattering angles (see
+equation. 7 in [2]).
.TP
.B \-n \fINUM_THREADS\fR
hint on the number of threads to use during the integration. By default use as
@@ -100,7 +102,7 @@ Sample \fB10\fR soft particles whose shape is defined by the \fBgeometry.yaml\fR
file and write their triangulated geometric data to the \fBtemp_output\fR file.
Use the
.BR csplit (1)
-Unix command on the \fBtemp_output\fR file to create 10 files named
+Unix command to split the \fBtemp_output\fR file in 10 files named
particle<\fINUM\fR>.obj, with NUM in [0, 9], each storing the geometric data of
a sampled soft particle:
.IP " " 4
