subselectParticles.py

This analysis script, selects particles within a range.

-s <simname>, --simulationName=<simname>

(string, required)

<simname> is the name of the simulation with the particle files. 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 subselected.

-o <outspname>, --outputSpeciesName=<outspname>

(string, required, default = subselection)

<outspname> is the name of the species that will be the result of the subselection.

-c <comp>, --component=<comp>

(int, required, default = 0)

<comp> is the component index integer to filter. Depends on species kind and dimensionality.

-l <lb>, --lowerBounds=<lb>

(float, optional)

Minimum value of the component for keeping a particle.

-u <ub>, --upperBounds=<ub>

(float, optional)

Maximum value of the component for keeping a particle.

-f <fl>, --flipLimits=<fl>

(int, required, default = 0)

Where upper and lower bounds are both provided, this allows subselecting particles outside the range, rather than inside.

-m,--move  RESERVED for future use

(int, optional)

Setup for moving window calculation - will set the velocity of the 0th component.

-w, --overwrite

(flag)

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

Output

This analysis script outputs a set of VizSchema compatible HDF5 files readable in VSimComposer, VisIt and other tools containing a filtered set of particles.

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.