commit 748858125c196e92968c1c571be8cf4ff96c7315
parent 7d668672df6c16d0ad5251b77422c946ad8000b3
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Fri, 19 Mar 2021 10:28:33 +0100
Catching up man pages with sgreen output changes
Diffstat:
1 file changed, 39 insertions(+), 14 deletions(-)
diff --git a/doc/sgreen-output.5.txt b/doc/sgreen-output.5.txt
@@ -27,8 +27,8 @@ DESCRIPTION
The type of the data that are generated depends on the options used when
*sgreen*(1) is invoked. When invoked with option *-a*, *sgreen*(1) outputs
Monte-Carlo results, either in extended or compact format, whether option *-e*
-is used or not. Also, when invoked whith option *-s* *sgreen*(1) outputs an
-HTML file contening a summary of the Green function used.
+is used or not. Also, when invoked whith option *-s* *sgreen*(1) silently
+creates an HTML file contening a summary of the Green function used.
GRAMMAR
-------
@@ -43,25 +43,46 @@ in a description is a comment and is not part of the output.
[verse]
_______
-<output> ::= <MC-result>
- <output> # as many ouput lines as provided setting
- # lines
+<output> ::= <compact-results>
+ | <extended-results>
-<MC-result> ::= <compact-MC-result>
- | <extended-MC-result>
+<compact-results> ::= <compact-MC-result> # as many results as provided
+ <compact-results> # setting lines
+
+<extended-results> ::= "message: Initialisation time = " <time value>
+ "message: Computation time = " <time value>
+ <extended-MC-results>
+
+-------------------------------------
+
+<compact-MC-result> ::= <estimate> <standard-deviation>
+
+<extended-MC-results> ::= <extended-MC-result> # as many results as provided
+ | <extended-MC-results> # setting lines
+
+<time value> ::= [<h> "hour"] [<m> "min"] [<s> "sec"] \
+ [<ms> "msec"] [<us> "usec"]
+
+<extended-MC-result> ::= <estimate> "K +/-" <standard-deviation> \
+ ";" <applied-settings>
+
+<estimate> ::= REAL
+
+<standard-deviation> ::= REAL # in [0, INF)
-------------------------------------
-<compact-MC-result> ::= <estimate> <standard-deviation>
+<applied-settings> ::= ASCII TEXT # verbatim from the settings file
-<extended-MC-result> ::= <estimate> "K +/-" <standard-deviation> \
- ";" <applied-settings>
+<h> ::= INTEGER # in [1 INF)
-<estimate> ::= REAL
+<m> ::= INTEGER # in [1 59]
-<standard-deviation> ::= REAL # in [0, INF)
+<s> ::= INTEGER # in [1 59]
-<applied-settings> ::= ASCII TEXT # verbatim from the settings file
+<ms> ::= INTEGER # in [1 999]
+
+<us> ::= INTEGER # in [1 999]
_______
HTML SUMMARY
@@ -87,7 +108,11 @@ HTML format. This document contains the following sections:
* H boundaries for fluids
-* F boundaries for dolids
+* F boundaries for solids
+
+* Solid-Fluid connections
+
+* Solid-Solid connections
* Radiative temperatures
