star-phor-output.scd (3865B)
1 star-phor-input(5) "UNIX" 2 3 ; Copyright (C) 2024-2026 Centre National de la Recherche Scientifique 4 ; Copyright (C) 2024-2026 Clermont Auvergne INP 5 ; Copyright (C) 2024-2026 INSA Lyon 6 ; Copyright (C) 2024-2026 Institut Mines Télécom Albi-Carmaux 7 ; Copyright (C) 2024-2026 Institut National Polytechnique de Toulouse 8 ; Copyright (C) 2024-2026 |Méso|Star> (contact@meso-star.com) 9 ; Copyright (C) 2024-2026 PhotonLyX (info@photonlyx.com) 10 ; Copyright (C) 2024-2026 Université de Lorraine 11 ; Copyright (C) 2024-2026 Université Paul Sabatier 12 ; Copyright (C) 2024-2026 Université Toulouse - Jean Jaurès 13 ; 14 ; This program is free software: you can redistribute it and/or modify 15 ; it under the terms of the GNU General Public License as published by 16 ; the Free Software Foundation, either version 3 of the License, or 17 ; (at your option) any later version. 18 ; 19 ; This program is distributed in the hope that it will be useful, 20 ; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 ; GNU General Public License for more details. 23 ; 24 ; You should have received a copy of the GNU General Public License 25 ; along with this program. If not, see <http://www.gnu.org/licenses/>. 26 27 # NAME 28 29 star-phor-output - file format specification for *star-phor* results. 30 31 # DESCRIPTION 32 33 The output of the *star-phor*(1) program consists of a list of observable 34 estimators. Each estimator is described on a separate line. 35 36 *star-phor* outputs are closely related to the *star-phor-input*(5) file that 37 has generated the simulation. For each sensor defined in the input file, 38 star-phor writes a set of output values at different levels: per-volume sensor 39 mean volumetric rate of energy absorption (MVREA); per component MVREA within 40 each specified volume; and per-sensor surface LOSSES. 41 42 In addition, the total estimate of each observable (MVREA or LOSSES), combining 43 all sensors of a given type, is also provided. 44 45 # GRAMMAR 46 47 This sections outlines the *star-phor* output files specification syntax using 48 the Backus-Naur notation system. 49 50 Some lines end with a backslash (\\). This allows the description to continue on 51 the next line for formatting purposes. However, this trick cannot be used in 52 description files, and actual description lines must remain on a single line. 53 54 The syntax rules enabling the description of a photoreactor are as follows: 55 56 ``` 57 <star-phor-output> ::= <observable-output> 58 ... 59 60 <observable-output> ::= <combined-estimator> 61 <per-sensor-estimator> 62 ... 63 [<per-component-estimator> 64 ...] 65 66 <combined-estimator> ::= <observable>:\\ 67 <mean-value>:\\ 68 <standard-error> 69 70 <per-sensor-estimator> ::= <observable>:\\ 71 <sensor-name>:\\ 72 <mean-value>:\\ 73 <standard-error> 74 75 <per-component-estimator> ::= <observable>:\\ 76 <sensor-name>:\\ 77 <component-name>:\\ 78 <mean-value>:\\ 79 <standard-error> 80 81 <observable> ::= MVREA | LOSSES 82 <sensor-name> ::= <volume-name> | <surface-name> 83 <volume-name> ::= 'string' 84 <surface-name> ::= 'string' 85 <component-name> ::= 'string' 86 <mean-value> ::= 'real' 87 <standard-error> ::= 'real' 88 ``` 89 90 # SEE ALSO 91 _star-phor_(1), _sphin-lint_(1), _star-phor-input_(5) 92 93 https://en.wikipedia.org/wiki/Backus-Naur_form 94 95 # HISTORY 96 97 *star-phor* has been developed thanks to the funding of the ECOCHEM 98 project (ProjetIA-22-PESP-0006) belonging to the *PEPR SPLEEN*.