sgreen(1)
NAME
sgreen - postprocessing of Green functionsSYNOPSIS
sgreen [option]
DESCRIPTION
sgreen is a post processing tool that can be used on stardis(1) Green functions (a.k.a propagators), as contained in binary files. The main functionality is to apply different boundary conditions to a system once solved by stardis(1) in Green mode (-G option of stardis(1)). The provided file should comply with the sgreen-input(5) format, that is also the stardis-output(1) format in binary Green mode.
Using this Green function approach, when possible, produces the very same results as a full Monte-Carlo computation, but only requires a fraction of the computation time.
The propagator is of great value to thermal engineers as it gives some crucial information to analyse heat transfers in the system. It helps engineers answer questions like "Where from does the heat come at this location?". Propagators seamlessly agregate all the provided geometrical and physical information on the system in an unbiased and very-fast statistical model.
sgreen(1) also provides an additional functionality: summarize information on a Green function in HTML format to help understand what matters on the simulated system.
OPTIONS
-a FILE_NAME
- Apply a Green function using the variable settings read from a file. Can only be applied in conjunction with option -g.
-e
- Use extended format to output Monte-Carlo results. Can only be used in conjunction with option -a.
-g GREEN_BINARY_FILE
- Read a Green function from a file for further processing.
-h
- Output short help and exit.
-s FILE_NAME
- Create a summary of a Green function and write it to a file in HTML format. Can only be applied in conjunction with option -g.
-t threads-count
- Hint on the number of threads to use. By default use as many threads as CPU cores.
-v
- Output version information and exit.
-V level
- Set the verbosity level. Possible values are 0 (no message), 1 (error messages only), 2 (error and warning messages), and 3 (error, warning and informative messages). All the messages are written to standard error. Default verbosity level is 1.
EXAMPLES
Create a summary of the heatsink.green Green function and write it in the heatsink_green.html file:
-
$ sgreen -g heatsink.green -s heatsink_green.html
Apply the settings from the file cube_settings.txt to the cube.green Green function and output the corresponding Monte-Carlo results to stdout in extended format. Set verbosity level to 2.
-
$ sgreen -g cube.green -a cube_settings.txt -e -V 2
Create a summary of the heatsink.green Green function and write it in the heatsink_green.html file; also apply the settings from the file heatsink_settings.txt and output the corresponding Monte-Carlo results to stdout in compact format.
-
$ sgreen -g heatsink.green -s heatsink_green.html -a heatsink_settings.txt
COPYRIGHT
Copyright © 2020 |Meso|Star>. License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. This is free software. You are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
SEE ALSO
sgreen-input(5), sgreen-output(5), stardis(1)