stardis-green

Post-processing of green functions
git clone git://git.meso-star.fr/stardis-green.git
Log | Files | Refs | README | LICENSE

sgreen-output.5 (3870B)


      1 .\" Copyright (C) 2020-2022, 2024 |Méso|Star> (contact@meso-star.com)
      2 .\"
      3 .\" This program is free software: you can redistribute it and/or modify
      4 .\" it under the terms of the GNU General Public License as published by
      5 .\" the Free Software Foundation, either version 3 of the License, or
      6 .\" (at your option) any later version.
      7 .\"
      8 .\" This program is distributed in the hope that it will be useful,
      9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     11 .\" GNU General Public License for more details.
     12 .\"
     13 .\" You should have received a copy of the GNU General Public License
     14 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     15 .Dd April 26, 2024
     16 .Dt SGREEN-OUTPUT 5
     17 .Os
     18 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     19 .Sh NAME
     20 .Nm sgreen-output
     21 .Nd output format of
     22 .Xr sgreen 1
     23 results
     24 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     25 .Sh DESCRIPTION
     26 The type of the data that are generated depends on the options used when
     27 .Xr sgreen 1
     28 is invoked.
     29 When invoked with option
     30 .Fl a ,
     31 .Xr sgreen 1
     32 outputs Monte Carlo results, either in extended or compact format,
     33 whether option
     34 .Fl e
     35 is used or not.
     36 .Pp
     37 When invoked with the
     38 .Fl s
     39 option,
     40 .Xr sgreen 1
     41 silently creates an HTML file containing a summary of the Green function
     42 used.
     43 As it conforms to the HTML format found in the HTML specification
     44 documents, these will not be described in further detail below.
     45 This summary HTML file contains the following sections:
     46 .Bl -bullet -compact -offset indent
     47 .It
     48 List of variables
     49 .It
     50 Formula of the Monte Carlo estimate
     51 .It
     52 Counts
     53 .It
     54 Solids
     55 .It
     56 Fluids
     57 .It
     58 T boundaries for solids
     59 .It
     60 T boundaries for fluids
     61 .It
     62 H boundaries for solids
     63 .It
     64 H boundaries for fluids
     65 .It
     66 F boundaries for solids
     67 .It
     68 Solid-Fluid connections
     69 .It
     70 Solid-Solid connections
     71 .It
     72 Radiative temperatures
     73 .El
     74 .Pp
     75 In what follows, some lines end with a backslash
     76 .Pq Li \e .
     77 This is used as a convenience to continue a description next line.
     78 However, this trick cannot be used in actual description files and
     79 actual description lines must be kept single-line.
     80 Text introduced by the sharp character
     81 .Pq Li #
     82 in descriptions is a comment and is not part of the description.
     83 .Pp
     84 The file format for Monte Carlo results is as follows:
     85 .Bl -column (****************) (::) ()
     86 .It Ao Va results Ac Ta ::= Ta Ao Va results-raw Ac | Ao Va results-ext Ac
     87 .It Ao Va results-raw Ac Ta ::= Ta Ao Va estimate-raw Ac
     88 .It Ta Ta ...
     89 .It Ao Va results-ext Ac Ta ::= Ta Li message: Initialisation time = Aq Va time
     90 .It Ta Ta Li message: Computation time = Aq Va time
     91 .It Ta Ta Ao Va estimate-ext Ac
     92 .It Ta Ta ...
     93 .It Ao Va estimate-raw Ac Ta ::= Ta Ao Va expected-value Ac Ao Va standard-error Ac
     94 .It Ao Va estimate-ext Ac Ta ::= Ta Ao Va expected-value Ac Li K +/- Ao Va standard-error Ac \e
     95 .It Ta Ta Ao Va applied-settings Ac
     96 .It \  Ta Ta
     97 .It Ao Va expected-value Ac Ta ::= Ta Vt real
     98 .It Ao Va standard-error Ac Ta ::= Ta Vt real
     99 .It Ao Va time Ac Ta :: Ta
    100 .Op Ao Va h Ac Li hour
    101 .Op Ao Va m Ac Li min
    102 .Op Ao Va s Ac Li sec
    103 \e
    104 .It Ta Ta
    105 .Op Ao Va ms Ac Li msec
    106 .Op Ao Va us Ac Li usec
    107 .It Ao Va h Ac Ta ::= Ta Vt integer No # \&In Bq 1, INF
    108 .It Ao Va m Ac Ta ::= Ta Vt integer No # \&In Bq 1, 59
    109 .It Ao Va s Ac Ta ::= Ta Vt integer No # \&In Bq 1, 59
    110 .It Ao Va ms Ac Ta ::= Ta Vt integer No # \&In  Bq 1, 999
    111 .It Ao Va us Ac Ta ::= Ta Vt integer No # \&In Bq 1, 999
    112 .It Ao Va applied-settings Ac Ta ::= Ta Vt string No # Verbatim from the settings file
    113 .El
    114 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    115 .Sh SEE ALSO
    116 .Xr sgreen 1
    117 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    118 .Sh STANDARDS
    119 .Rs
    120 .%A Web Hypertext Application Technology Working Group
    121 .%T HTML Living Standard
    122 .%U https://html.spec.whatwg.org/
    123 .Re