This analysis script helps locate particles which have breached the computational domain. This helps determine where they may have come from, to identify potential issues with sources and sinks. Additionally the analyzer writes a ‘history’ type particle dataset with a time mesh given by dumps which can be plotted on one axis against the extents of the species coordinates as they vary through the simulation. As such it can also find the fastest particles in a simulation, which is useful for checking that timesteps and mesh size are okay.
-s <simname>, --simulationName=<simname>(string, required)
<simname> is the name of the simulation to be analyzed. The file extension should NOT be included in this text field.
-S <spname>, --speciesName=<spname>(string, required)
<spname> is the name of the species to be analyzed.
-O <outname>, --outputFileName=<outname>(string, optional)
<outname> is the filename to write the history output containing maximum and minimum particle coordinates for each timestep. The default is simulationname_MaxMinData_*.vsh5. If a filename is given, the user should include the simulationName and the extension .vsh5.
-w, --overwrite(flag)
Whether a dataset or group should be overwritten if it already exists.
The output is a VizSchema compatible dataset containing a set of ‘history’ or 1D vs time data. The contents will be xmax, ymax, vxmax, vymin, etc. and should be equally suited to cylindrical and Cartesian datasets.
If you are running this analyzer from the UI, and the output dataset 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.