commit adcfccd101cb1ffb0fb09a82e5ca39e59017d55c
parent 89c04bddf4a34740babed5bbcdd3cf0ba33ca146
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Tue, 29 Sep 2020 10:44:22 +0200
Fix documentation (add effects of the -e option on output)
Diffstat:
1 file changed, 53 insertions(+), 26 deletions(-)
diff --git a/doc/stardis-output.5.txt b/doc/stardis-output.5.txt
@@ -87,11 +87,11 @@ when neither verbatim nor count, is a comment and is not part of the output.
[verse]
_______
-<output> ::= <single-MC-result>
- | <binary-green>
- | <ascii-green>
- | <geometry-dump>
- | <infrared-image>
+<output> ::= <single-MC-result>
+ | <binary-green>
+ | <ascii-green>
+ | <geometry-dump>
+ | <infrared-image>
_______
== SINGLE MONTE CARLO
@@ -101,42 +101,69 @@ temperature or flux, this result is output first to _standard output_, possibly
followed by some of the heat paths involved in the computation if option *-D*
was used too.
+Two different formats are possible: a compact, numbers only format (the default)
+or an extended format that mixes numbers and their descriptions (if option *-e*
+is used).
+
[verse]
_______
-<single-MC-result> ::= <probe-temp>
- | <medium-temp>
- | <mean-temp>
- | <mean-flux>
+<single-MC-result> ::= <single-MC-result>
+ | <ext-single-MC-result>
+
+<single-MC-result> ::= <probe-temp>
+ | <medium-temp>
+ | <mean-temp>
+ | <mean-flux>
+
+<ext-single-MC-result> ::= <ext-probe-temp>
+ | <ext-medium-temp>
+ | <ext-mean-temp>
+ | <ext-mean-flux>
-------------------------------------
-<probe-temp> ::= "Temperature at" <probe-position> <time> <MC-estimate>
- <failures-report>
+<probe-temp> ::= <MC-estimate> <failures-report>
-<mean-temp> ::= "Temperature at boundary" <file-name> <time> <MC-estimate>
- <failures-report>
+<mean-temp> ::= <MC-estimate> <failures-report>
-<mean-flux> ::= "Temperature at boundary" <file-name> <time> <MC-estimate>
- "Convective flux at boundary " <file-name> <time> \
- <MC-estimate>
- "Radiative flux at boundary" <file-name> <time> <MC-estimate>
- "Total flux at boundary" <file-name> <time> <MC-estimate>
+<mean-flux> ::= <MC-estimate> <MC-estimate> <MC-estimate> <MC-estimate>\
<failures-report>
+ # MC estimates order is: temperature, convective flux,
+ # radiative flux, total flux
-<medium-temp> ::= "Temperature in medium" <medium-name> <time> <MC-estimate>
- <failures-report>
+<medium-temp> ::= <MC-estimate> <failures-report>
+
+<MC-estimate> ::= <expected-value> <standard-deviation>
+
+<failures-report> ::= <error-count> <success-count>
+
+<ext-probe-temp> ::= "Temperature at" <probe-position> <time> <MC-estimate>
+ <failures-report>
+
+<ext-mean-temp> ::= "Temperature at boundary" <file-name> <time> <MC-estimate>
+ <failures-report>
+
+<ext-mean-flux> ::= "Temperature at boundary" <file-name> <time> <MC-estimate>
+ "Convective flux at boundary " <file-name> <time> \
+ <MC-estimate>
+ "Radiative flux at boundary" <file-name> <time> <MC-estimate>
+ "Total flux at boundary" <file-name> <time> <MC-estimate>
+ <failures-report>
+
+<ext-medium-temp> ::= "Temperature in medium" <medium-name> <time> <MC-estimate>
+ <failures-report>
-<probe-position> ::= "[" <x-value> "," <y-value> "," <z-value> "]"
+<ext-probe-position> ::= "[" <x-value> "," <y-value> "," <z-value> "]"
-<time> ::= "at t=" <time-value> "="
+<ext-time> ::= "at t=" <time-value> "="
-<MC-estimate> ::= <expected-value> "+/-" <standard-deviation>
+<ext-MC-estimate> ::= <expected-value> "+/-" <standard-deviation>
-<failures-report> ::= "#failures:" <error-count> "/" <success-count>
+<ext-failures-report> ::= "#failures:" <error-count> "/" <success-count>
-<file-name> ::= STRING # as provided in input data
+<ext-file-name> ::= STRING # as provided in input data
-<medium-name> ::= STRING # as provided in input data
+<ext-medium-name> ::= STRING # as provided in input data
-------------------------------------
