computeMassFlux.py
This analyzer generates mass flux in units of kg*m^-2*s^-1 from particles stored in history data files. It is intended for finding the emission flux or absorption flux through a plane, especially for neutral species which necessarily have zero current. It expects a history of kind speciesAbsPtclData2 with records: xPosition yPosition … numPtclsInMacro time. (Time is always last and added by Vorpal automatically.) Derived from annotateSpeciesAbsPtclData2.py Currently only works for Cylindrical.
- -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 history for which the number density is to be calculated.
- -t <time>, --startTime=<time>
(float, required)
<time> is the time in seconds at which to begin flux rate calculations. Often this should be set to a time after steady state conditions have been achieved in the simulation.
- -T <timeint>, --timeInterval=<timeint>
(float, required)
Replace <timeint> with the desired time interval. Only events in startTime - [startTime + timeInterval] will be counted. This interval should be the period of interest.
- -D <direction>, --fluxDir=<direction>
(int, required, default = 0)
Replace <direction> with the direction the flux is going (0 or 1). Used to decide which cell unit lengths to use in flux determination.
- -m <mass>, --mass=<mass>
(float, required)
Replace <mass> with the mass of the physical atom/molecule in the species flux.
- -d, --density
(flag)
Divide by the mass density to get linear etch rate in m/s. Specifying this option on the command line sets this flag to true. The default is false.
- -I, --integrate
(flag)
Integrate linear etch rate over timeInterval to get the erosion depth (only works with -d). Specifying this option on the command line sets this flag to true. The default is false.
- -w, --overwrite
(flag)
Whether a dataset or group should be overwritten if it already exists.
Output
Particle number density, temperature, and debye length/max grid length data as fields. These density fields can help to analyze the particle distribution results in the simulation domain.
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.