physsetemits.mac

This macro file can be imported to an input file with

$ import physsetemits

It is imported at the top of all simulation runs.

This macro file is available to all packages.

This macro file defines the macros for setting up and writing physics-set-flux emitters into particle species definition.

Public Macros

addPhysicsSetFluxEmitterSource(sourceName, sourceKind, owningSpecies, start, stop, vbar, vsig, workFunc, fldEvalOff, temp, fldEnhance, fluxMult, A, B, Cv, Cy, emOff, maskFunction, object, location)

Adds a particle emitter source to a particle species. This macro handles the case of emission from a shape geometry.

Parameters:
  • sourceName – The name of the source block.
  • sourceKind – The kind of emission model being used.
  • owningSpecies – The name of the species that contains this source block.
  • star – Time to start emission.
  • stop – Time to end emission.
  • vbar – The mean velocity of the distribution of emitted particles.
  • vsig – The standard deviation of the velocity distribution of emitted particles.
  • workFunc – The work function. The minimum energy required to emit an electron (eV).
  • fldEvalOff – Field evaluation offset. Presumably the offset from the surface where the field resulting from the particle is evaluated. No use of this in the regression tests.
  • temp – Temperature of the emitting surface (K).
  • fldEnhance – Field enhancement. Multiplies the measured electric field by this amount.
  • fluxMult – Flux multiplier. Multiplies the resulting output current by this amount.
  • A – Coefficient A of the Fowler-Nordheim emission model.
  • B – Coefficient B of the Fowler-Nordheim emission model.
  • Cv – Coefficient Cv of the Fowler-Nordheim emission model.
  • Cy – Coefficient Cy of the Fowler-Nordheim emission model.
  • emOff – The distance away from the object that emission begins, a computational contrivance.
  • maskFunction – The masking function to tailor emission as desired.
  • object – The shape geometry to emit off of.
  • location – The plane from which to emit.
addChildLangmuirEmitter(sourceName, owningSpecies, start, stop, vbar, vsig, emOff, maskFunction, object)

Adds a particle emitter source to a particle species with Child Langmuir properties. Child Langmuir specifies the mean and standard deviation of a velocity distribution.

addRichardsonDushmanEmitter(sourceName, owningSpecies, start, stop, fldEnhance, fldEvalOff, fluxMult, temp, workFunc, emOff, maskFunction, object)

Adds a particle emitter source to a particle species with Reichardson Dushman properties.

addFowlerNordheimEmitter(sourceName, owningSpecies, start, stop, A, B, Cv, Cy, fldEnhance, workFunc, emOff, maskFunction, object)

Adds a particle emitter source to a particle species with Fowler Nordheim properties.