computeAED.py
This analyzer computes the Angular Energy Distribution (AED) function of a kinetic species hitting a surface. To use this analyzer, the user must set up a Log History called Absorbed Particle Log. Before setting up the history, the user must also set up a Boundary Absorb and Save for at least one species. Once the history is included, right click on your mouse with the mouse hovering over the history name. Then you will have the ability to add the particle data you want to save. To use this analyzer, you must save the particles location, velocity, time, energy, weight, charge, and number of particles in a macroparticle. Note that in 2D, you need to save 2 positions and you need to save all three velocity components. See the Wafer Impact input file as an example.
- -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 <SPECIESNAME>, --SpeciesName=<SPECIESNAME>
(string, required)
<SPECIESNAME> is the name of the species to compute the AED for. Example: “ions”
- -T1 <STARTTIME>, --startTime=<STARTTIME>
(float, required)
<STARTTIME> is the time (in seconds) you want to start with when computing the AED.
- -T2 <ENDTIME>, --endTime=<ENDTIME>
(float, required)
<ENDTIME> is the time (in seconds) you want to end with when computing the AED.
- -P1L <LOWERPOS1>, --lowerPos1=<LOWERPOS1>
(float, required)
<LOWERPOS1> is the lower position in dimension 1 to include when computing the AED. In 1D, this parameter is ignored
- -P1U <UPPERPOS1>, --upperPos1=<UPPERPOS1>
(float, required)
<UPPERPOS1> is the upper position in dimension 1 to to include when computing the AED. In 1D, this parameter is ignored
- -P2L <LOWERPOS2>, --lowerPos2=<LOWERPOS2>
(float, required)
<LOWERPOS2> is the lower position in dimension 2 to include when computing the AED. In 1D and 2D, this parameter is ignored
- -P2U <UPPERPOS2>, --upperPos2=<UPPERPOS2>
(float, required)
<UPPERPOS2> is the upper position in dimension 2 to to include when computing the AED. In 1D and 2D, this parameter is ignored
- -H <HISTORYNAME>, --historyName=<HISTORYNAME>
(string, required)
<HISTORYNAME> is the name of the history that you provide when you create the history. Some default value is created when you make the history. You can also change the name by double clicking on the history name in Composer.
- -Neng <NUMENGERYBINS>, --numEnergyBins=<NUMENERGYBINS>
(integer, required)
<NUMENERGYBINS> is the number of energy bins to use when binning the data. This is used in a Python histrogram function
- -Nang <NUMANGLEBINS>, --numAngleBins=<NUMANGLEBINS>
(integer, required)
<NUMANGLEBINS> is the number of angular bins to use when binning the data. This is used in a Python histrogram function. Must be even integer.
- -E1 <LOWERENERGY>, --lowerEnergy=<LOWERENERGY>
(float, required)
<LOWERENERGY> is the lower energy to use when binning the data. This is used in a Python histrogram function
- -E2 <UPPERENERGY>, --upperEnergy=<UPPERENERGY>
(float, required)
<UPPERENERGY> is the upper energy to use when binning the data. This is used in a Python histrogram function
- -A1 <LOWERANGLE>, --lowerAngle=<LOWERANGLE>
(float, required)
<LOWERANGLE> is the lower angle to use when binning the data. This is used in a Python histrogram function
- -A2 <UPPERANGLE>, --upperAngle=<UPPERANGLE>
(float, required)
<UPPERANGLE> is the upper angle to use when binning the data. This is used in a Python histrogram function
- -f <ANGULARFREQUENCY>, --angularFrequency=<ANGULARFREQUENCY>
(float, required)
<ANGULARFREQUENCY> is the angular frequency (2 pi times the linear frequency) of you RF source. This value is used to confine the times that you choose for your startTime (T1) and endTime (T2).
- -ndim <NDIM>, --NDIM=<NDIM>
(integer, required)
<NDIM> is the number of dimensions of you simulation. The analyzer currently works in 1D and 2D
- -P <PERPDIR>, --perpDir=<PERPDIR>
(string, required)
<PERPDIR> is the perpendicular direction to surface that charges are collected on. Accepted values are 0,1, or 2. Y-axis would have perpendicular direction of 0. X-axis would have perpendicular direction of 1. This is ignored if the normTan flag is checked.
- -NT, --normTan
(flag)
Check this flag if norm-tangent coordinate system is used in velocity history. Uncheck if the default simulation coordinate system is used in velocity history.
- -W, --writeData
(flag)
If flag is checked, then the 1D angular and energy distributions will be written into a text file. The weighted averaged and standard deviation of the angular distribution will also be printed in the output.
- -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 analyzer outputs a 2D angular and energy distribution function. It also outputs the 1D angular distribution fucntion (integrated over all energies) and 1D energy distribution function (integegrated over all angles).
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.