commit 356d1ece5ec34fc4083f93e78564957f410cf7e0
parent b4250069275b380c04dabb9e3f7b074a2cd70fe9
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Thu, 24 Jun 2021 16:38:00 +0200
Add documentation for -x and -X options
Diffstat:
1 file changed, 20 insertions(+), 4 deletions(-)
diff --git a/doc/stardis.1.txt.in b/doc/stardis.1.txt.in
@@ -48,7 +48,7 @@ the evaluation of the propagator (a.k.a the *Green function*).
The propagator is of great value for thermicist engineers as it gives some
crucial information to analyse heat transfers in the system. It helps engineers
answer questions like _"Where from does the heat come at this location?"_.
-Propagators seamlessly agregate all the provided geometrical and physical
+Propagators seamlessly aggregate all the provided geometrical and physical
information on the system in an unbiased and very-fast statistical model.
*stardis*(1) also provides two additional functionalities: converting the
@@ -63,7 +63,7 @@ cinema industry (FX and animated movies), this theoretical framework can now
be practically used on the most geometrically complex systems.
Everytime the linear assumption is relevant, this theoretical framework allows
-to encompass all the heat transfer mecanisms (conductive-convective-radiative)
+to encompass all the heat transfer mechanisms (conductive-convective-radiative)
in an unified statistical model. Such systems can be solved by a Monte-Carlo
approach just by sampling heat paths. This can be seen as an extension of
Monte-Carlo algorithms that solve radiative transfer by sampling optical paths.
@@ -207,7 +207,7 @@ options that write to _standard output_ (-g, -h, -R, -v).
rank starting at index 00000000, and possibly followed by *_err* for failure
paths: prefix00000000.vtk, prefix00000001_err.vtk, ...
+
-This option can only be used in conjuction with options that compute a
+This option can only be used in conjunction with options that compute a
result (-F, -m, -P, -p, -R, -S, -s) and cannot be used in conjunction with
options -g or -G.
@@ -259,6 +259,16 @@ different temperature, flux or volumic power values.
and informative messages). All the messages are written to _standard error_.
Default verbosity *level* is @STARDIS_ARGS_DEFAULT_VERBOSE_LEVEL@.
+*-x* _file_name_::
+ Read the provided file and use its content to initialize the random
+ generator's internal state. Used in conjunction with the *-X* option, this
+ can be used to ensure statistical independence between subsequent
+ computations.
+
+*-X* _file_name_::
+ Write the random generator's internal state, as it is at the end of the
+ computation, to the provided file.
+
EXAMPLES
--------
Preprocess the system as described in *scene 5.txt* when intending to compute
@@ -289,6 +299,12 @@ time range. The system is read from the file *model.txt*:
$ stardis -M model.txt -p 1,2.5,0,50,5000
+Compute 3 probe temperatures, ensuring statistical independence:
+
+ $ stardis -M model.txt -p 1,1.5,0,50,5000 -Xstate1
+ $ stardis -M model.txt -p 1,2.5,0,50,5000 -xstate1 -Xstate2
+ $ stardis -M model.txt -p 1,3.5,0,50,5000 -xstate2
+
Render the system as described in *scene.txt* with default settings:
$ stardis -M scene.txt -R :
@@ -304,7 +320,7 @@ post-processed using *htpp*(1) with default settings to obtain a png file.
-D error,err_path_ > img.ht
$ htpp -o img.pgn -v -m default img.ht
-Compute the Green fonction that computes the temperature at the probe point
+Compute the Green function that computes the temperature at the probe point
*0, 0, 0* at steady state. The system is read from the file *model.txt* and
the Green function is written to the *probe.green file* and the heat paths'
ends are written to the *probe_ends.csv* file:
