NAME

sgreen — statistical solving of coupled thermal systems

SYNOPSIS

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.

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 also offers an additional feature: summarizing information on a Green function in HTML format to help understand what's important in the simulated system.

The options are as follows:

-a arguments

Apply a Green function using the arguments listed in the arguments 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

Read a Green function from a file for further processing.

-h

Output short help and exit.

-s summary

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

Advice on the number of threads to use. By default, sgreen uses as many threads as processor cores.

-V verbosity_level

Set the verbosity level. Possible values are 0 (no message), 1 (error messages only), 2 error and warning messages, All the messages are written to standard error. Default is 1.

-v

Output version information and exit.

EXIT STATUS

The sgreen utility exits 0 on success, and >0 if an error occurs.

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 standard output in compact format:

sgreen -g heatsink.green \
       -s heatsink_green.html \
       -a heatsink_settings.txt

SEE ALSO

stardis(1), sgreen-input(5), sgreen-output(5)