annotateSpeciesAbsPtclData2.py

This analysis script enables the raw h5 data recorded in a speciesAbsPtclData2 history to be available as a field showing the number density of the macroparticles deposited in each cell, and any of the other parameters you have written out. It requires that the first components measured in the history are the particles’ spatial coordinates, like ptclAttributes = [xPosition yPosition kineticEnergy current ] for a 2D simulation, whether a ZR or xy coordinate system, and is specific to particles collected with collectMethod = recordForEachPtcl.

-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.

-H <histname>, --historyName=<histname>

(string, required)

<histname> is the name of the species to be analyzed.

-T <thresh>, --threshold=<thresh>

(float, optional)

Particle densities below <thresh> will be ignored.

-Z, --compMajorC

(flag)

The indexing order for written datasets. If checked, use “compMajorC”. If unchecked, use the default “compMinorC”

-w, --overwrite

(flag)

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

Output

This analysis script outputs a VizSchema field file evaluating the sum of particles deposited in each cell in that timestep, as well as a cumulative sum total.

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.