addSpeciesWithKinEnrgInEV.py

This analysis script creates a new particle species and appends an additional column containing particle energy in eV. It labels the new column _WithKinEnrg (unless a different name is specified). If there is already a column with this label in the particles output file, then the script gracefully does nothing with an explanation for the user. If the user intends to run the computeDeybeLength.py analyzer, then you should un-check outputXcomponent, outputYcomponent, and outputZcomponent. In other words, if you want to use the output from this analyzer as input into comoputeDebyeLength.py, then you should only check the box titled outputMagnitude (and Remove and overwrite if you desire).

-s <SIMULATIONNAME>, --simulationName=<SIMULATIONNAME>

(string, required)

<SIMULATIONNAME> is the name of the simulation to be analyzed. The file extension should NOT be included in this text field.

-S <SPECIES>, --speciesName=<SPECIES>

(string, required)

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

-o <OUTPUTSPECIESNAME>, --outputSpeciesName=<OUTPUTSPECIESNAME>

(string, required)

Name appended to new particle data set. Default is “<SPECIES>_WithKinEnrg”, where <SPECIES> is the original species name.

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

-m, --outputMagnitude

(flag)

Whether to write the total kinetic energy in eV. This should be checked if you want to run computeDebyeLength.py after running this analyzer.

-x, --outputXcomponent

(flag)

Whether to write the kinetic energy due to the x-component of velocity in eV. This should be unchecked if you want to run computeDebyeLength.py after running this analyzer.

-y, --outputYcomponent

(flag)

Whether to write the kinetic energy due to the y-component of velocity in eV. This should be unchecked if you want to run computeDebyeLength.py after running this analyzer.

-z, --outputZcomponent

(flag)

Whether to write the kinetic energy due to the z-component of velocity in eV. This should be unchecked if you want to run computeDebyeLength.py after running this analyzer.

Output

This analysis script creates a new particle species and appends an additional column containing particle energy in eV. It labels the new column <SPECIES>_KineticEnrg.

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.