sgreen-input.5 (3520B)
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-INPUT 5 17 .Os 18 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 19 .Sh NAME 20 .Nm sgreen-input 21 .Nd settings description for 22 .Xr sgreen 1 23 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 24 .Sh DESCRIPTION 25 .Nm 26 is the format used by the 27 .Xr sgreen 1 28 program to describe settings when applying a Green function. 29 It relies on a line-based ad-hoc syntax. 30 .Pp 31 A settings file is composed of lines of text, each one describing the 32 settings to apply for a Green function call. 33 Each line contains 34 .Li variable = value 35 pairs 36 in any number 37 .Pq at least one pair for a line to be meaningful . 38 A list of all legit variable names can be found in the Green function 39 summary, as produced by 40 .Xr sgreen 1 41 option 42 .Fl s . 43 Except the name 44 .Li AMBIENT , 45 that refers to the ambient radiative temperature and is always a legit 46 name in settings, the list of names that can be used to form settings is 47 the list of medium and boundary case-sensitive names defined in the 48 .Xr stardis-input 5 49 files used when creating the Green function applied to the settings. 50 .Pp 51 In what follows, text introduced by the sharp character 52 .Pq Li # 53 is a comment and is not part of the description. 54 Any physical quantity involved in settings files is expected in the 55 International System of Units 56 .Pq metre, kelvin, Watt . 57 .Pp 58 The file format is as follows: 59 .Bl -column (****************) (::) () 60 .It Ao Va settings Ac Ta ::= Ta 61 .Op Ao Va affectation Ac ... 62 .Op Ao Va comment Ac 63 .It Ta Ta ... 64 .It Ao Va affectation Ac Ta ::= Ta Ao Va val Ac Li = Ao Va value Ac 65 .It Ao Va var Ac Ta ::= Ta Ao Va description-name Ac Ns Li \&. Ns Ao Va field Ac 66 .It Ta \& \& | Ta Li AMBIENT No # Ambient radiative temperature 67 .It Ao Va description-name Ac Ta ::= Ta Vt string No # \&No space allowed 68 .It Ao Va field Ac Ta ::= Ta Li T No # temperature 69 .It Ta \& \& | Ta Li F No # flux 70 .It Ta \& \& | Ta Li VP No # volumic power 71 .It Ao Va value Ac Ta ::= Ta Vt real 72 .It Ao Va comment Ac Ta ::= Ta Li # Vt string 73 .El 74 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 75 .Sh EXAMPLES 76 Apply a Green function with 77 .Li AMBIENT 78 radiative temperature set to 0\& K: 79 .Bd -literal -offset Ds 80 AMBIENT = 0 81 .Ed 82 .Pp 83 First apply a Green function with volumic power in medium 84 .Qq AL 85 set to 100\& W/m^3 and temperature of the 86 .Qq Left 87 boundary set to 300\& K. 88 Then apply it with the same variables set to 120 and 350 respectively. 89 Finally, apply it with the same variables set to 140 and 360 90 respectively and temperature of the 91 .Qq Right 92 boundary set to 380\& K: 93 .Bd -literal -offset Ds 94 AL.VP=100 Left.T=300 95 AL.VP=120 Left.T=350 96 AL.VP=140 Left.T=360 Right.T=380 97 .Ed 98 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 99 .Sh SEE ALSO 100 .Xr sgreen 1 , 101 .Xr stardis-input 5