This analysis script will write a new file for each particle that you wish to track over time. This requires the use of tagged particle species with a unique tag identifier for each particle.
The new .h5 file will contain the particle positions and velocities for each time dump of your simulation. Since the analyzer reads in the data from existing species dump files (e.g. simulation_electrons_*.h5), it is beneficial to set your simulation to dump frequently.
Note
This analyzer requires tagged particle species as the order of particles may be affected by particle creation, removal, and sorting operations.
-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 tagged species that contains the particle to be tracked.
-p, --ptclIndex(int, required)
Tag ID of the particle to be tracked.
-w, --overwrite(flag)
Whether a dataset or group should be overwritten if it already exists.
createParticletclsTracks.py writes simulationname_speciesnameTrackNN_0.h5 for each value of NN where NN=ptclIndex is the tag number in the particle file to use.
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.