computeLoadBalancedDecomp.py

This analyzer script generates a custom decomposition file based on the mesh and particles data files. It works in 1D, 2D, and 3D Cartesian, as well as 2D RZ cylindrical.

--simulationName=SIMULATIONNAME, -s SIMULATIONNAME

(string, required)

Name of the simulation to be analyzed. The file extension should NOT be included in this text field.

--species=SPECIES, -S SPECIES

(string, required)

The names of the species. Should be a comma separated list with no spaces.

--nnodes=NNODES, -n NNODES

(integer, required)

The number of compute nodes.

--ncores=NCORES, -c NCORES

(integer, required)

The number of compute cores per node. (i.e. The total cores used is NNODES*NCORES).

--periodic_dirs=PERIODIC_DIRS, -p PERIODIC_DIRS

(integer, required)

The periodic directions of the simulation.

--dump_number=DUMP_NUMBER, -d DUMP_NUMBER

(integer, required)

The simulation dump number.

--intra_slice, -i

(flag)

Whether to use slicing algorithm rather than primefurcation for intranode decomp

--inter_slice, -I

(flag)

Whether to use slicing algorithm rather than primefurcation for internode decomp

-w, --overwrite

(flag)

Whether a dataset or group should be overwritten if it already exists.

Output

This analyzer script writes a new VizSchema-compliant dump file containing the resulting simulation decomposition. The decomposition file follows the naming convention <SIMULATIONNAME>_decomp_<DUMP_NUMBER>.mac. This .mac file can then be loaded into a simulation under Basic Settings. To do so, change the domain decomposition option to manual decomposition. Then write the filename in the field for file name. This analyzer also writes out a PNG file for easier visualization of what the domain decomposition is. This file follows the naming convention <SIMULATIONNAME>_decomp_<DUMP_NUMBER>.png. Both .mac and .png files are written to the working directotry.

If you are running this analyzer from the UI, and the output file already exists, then it will be overwritten each time the analyzer is run, unless you uncheck the Overwrite Existing Files box near the bottom of the Analysis Results pane.

If you are running the analyzer from the command line, the dataset will not be overwritten unless the -w, or --overwrite flag is specified on the command line.

The results of your analyzer may not be written into the output file if you have not specified the overwrite option to be True.