- speciesCurrEmit
speciesCurrEmit¶
Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.
Indicates Vorpal should record the emitted current of a species from a particle source. speciesCurrEmit requires both a
species
parameter andptclSource
parameter. This History tracks the emitted current of a charged species from a particle source. It only tracks one particle source of one given species.
speciesCurrEmit Parameters¶
- species (string, required)
Indicates particle species type for a History kind that reports data for particle species. Exactly one species name should be specified.
- ptclSource (string, required)
Specifies the name of a ParticleSource. Only one source name should be specified. The ParticleSource must be a LoaderEmitter (xvLoaderEmitter) type particle source with
emit
set as true (the default value), or asourceType
.
- sourceType (integer, required)
Specifies the type of a ParticleSource, whether to measure the current from an emitter, a loader, or both. Set it 0 to measure emitter current only, 1 to measure loader current only, and 2 to measure currents from both emitter and loader combined.
speciesCurrEmit History Example¶
<History currEmit>
kind = speciesCurrEmit
species = [ electrons ]
ptclSource = electrons.xvLoaderEmitterSource
sourceType = 0
</History>