sgreen.1.in (4475B)
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 1 17 .Os 18 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 19 .Sh NAME 20 .Nm sgreen 21 .Nd statistical solving of coupled thermal systems 22 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 23 .Sh SYNOPSIS 24 .Nm 25 .Op Fl ehv 26 .Op Fl a Pa arguments 27 .Op Fl g Pa green 28 .Op Fl s Pa summary 29 .Op Fl t Ar threads_count 30 .Op Fl V Ar verbosity_level 31 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 32 .Sh DESCRIPTION 33 .Nm 34 is a post processing tool that can be used on 35 .Xr stardis 1 36 Green functions 37 .Pq a.k.a propagators , 38 as contained in binary files. 39 The main functionality is to apply different boundary conditions to a 40 system once solved by 41 .Xr stardis 1 42 in Green mode 43 .Pq Fl G No option of Xr stardis 1 . 44 The provided file should comply with the 45 .Xr sgreen-input 5 46 format. 47 .Pp 48 Using this Green function approach, when possible, produces the very 49 same results as a full Monte Carlo computation, but only requires a 50 fraction of the computation time. 51 .Pp 52 The propagator is of great value to thermal engineers as it gives some 53 crucial information to analyse heat transfers in the system. 54 It helps engineers answer questions like 55 .Dq Where from does the heat come at this location? . 56 Propagators seamlessly agregate all the provided geometrical and 57 physical information on the system in an unbiased and very-fast 58 statistical model. 59 .Pp 60 .Nm 61 also offers an additional feature: summarizing information on a Green 62 function in HTML format to help understand what's important in the 63 simulated system. 64 .Pp 65 The options are as follows: 66 .Bl -tag -width Ds 67 .It Fl a Pa arguments 68 Apply a Green function using the arguments listed in the 69 .Pa arguments 70 file. 71 Can only be applied in conjunction with option 72 .Fl g . 73 .It Fl e 74 Use extended format to output Monte Carlo results. 75 Can only be used in conjunction with option 76 .Fl a . 77 .It Fl g Pa green 78 Read a Green function from a file for further processing. 79 .It Fl h 80 Output short help and exit. 81 .It Fl s Pa summary 82 Create a summary of a Green function and write it to a file in HTML 83 format. 84 Can only be applied in conjunction with option 85 .Fl g . 86 .It Fl t Ar threads_count 87 Advice on the number of threads to use. 88 By default, 89 .Nm 90 uses as many threads as processor cores. 91 .It Fl V Ar verbosity_level 92 Set the verbosity level. 93 Possible values are 94 .Li 0 Pq no message , 95 .Li 1 Pq error messages only , 96 .Li 2 error and warning messages , 97 All the messages are written to standard error. 98 Default is @GREEN_ARGS_DEFAULT_VERBOSE_LEVEL@. 99 .It Fl v 100 Output version information and exit. 101 .El 102 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 103 .Sh EXIT STATUS 104 .Ex -std 105 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 106 .Sh EXAMPLES 107 Create a summary of the 108 .Pa heatsink.green 109 Green function and write it in the 110 .Pa heatsink_green.html 111 file: 112 .Bd -literal -offset Ds 113 sgreen -g heatsink.green -s heatsink_green.html 114 .Ed 115 .Pp 116 Apply the settings from the file 117 .Pa cube_settings.txt 118 to the 119 .Pa cube.green 120 Green function and output the corresponding Monte Carlo results to 121 stdout in extended format. 122 Set verbosity level to 2: 123 .Bd -literal -offset Ds 124 sgreen -g cube.green -a cube_settings.txt -e -V 2 125 .Ed 126 .Pp 127 Create a summary of the 128 .Pa heatsink.green 129 Green function and write it in the 130 .Pa heatsink_green.html 131 file; also apply the settings from the file 132 .Pa heatsink_settings.txt 133 and output the corresponding Monte Carlo results to standard output in 134 compact format: 135 .Bd -literal -offset Ds 136 sgreen -g heatsink.green \\ 137 -s heatsink_green.html \\ 138 -a heatsink_settings.txt 139 .Ed 140 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 141 .Sh SEE ALSO 142 .Xr stardis 1 , 143 .Xr sgreen-input 5 , 144 .Xr sgreen-output 5