beamemitters.mac

This macro file can be imported to an input file with

$ import beamemitters

It is imported by VSim whenever a simulation contains particles.

This macro file is available to all packages.

This macro file defines macros for adding beam emitters for particles to be emitted from.

Public Macros

addBeamEmitter(sourceName, owningSpecies, start, stop, vbar, vsig, fluxSetting, fluxOrCurrent, location)

Add a particle emitter source block to the simulation. Velocity is given by the mean and standard deviation of the velocity distribution of the emitted particles. Current density is given by explicitly being set or by setting the desired flux whereby a calculation is done later. Location of emission can be off a GridBoundary shape or a boundary of the simulation domain. Delegates to addSettableFluxEmitter(15 args).

Parameters

  • sourceName – The name of the particle source block.

  • owningSpecies – The name of the emitted particle the source belongs to. Can be an electron, an ion, or a neutral particle.

  • start – The simulation time at which emission begins.

  • stop – The simulation time at which emission ends.

  • vbar – A three-vector of mean velocities.

  • vsig – A three-vector of rms velocities.

  • fluxSetting – A string used to determine whether to explicitly set the current density or to calculate it.

  • fluxOrCurrent – The function or numerical value used to set the current density or to calculate it.

  • location – The boundary plane of the simulation domain to emit off.

addBeamEmitter(sourceName, owningSpecies, start, stop, vbar, vsig, fluxSetting, fluxOrCurrent, emOff, maskFunction, object)

Add a particle emitter source block to the simulation. Velocity is given by the mean and standard deviation of the velocity distribution of the emitted particles. Current density is given by explicitly being set or by setting the desired flux whereby a calculation is done later. Location of emission can be off a GridBoundary shape or a boundary of the simulation domain. Delegates to addSettableFluxEmitter(15 args).

Parameters

  • sourceName – The name of the particle source block.

  • owningSpecies – The name of the emitted particle the source belongs to. Can be an electron, an ion, or a neutral particle.

  • start – The simulation time at which emission begins.

  • stop – The simulation time at which emission ends.

  • vbar – A three-vector of mean velocities.

  • vsig – A three-vector of rms velocities.

  • fluxSetting – A string used to determine whether to explicitly set the current density or to calculate it.

  • fluxOrCurrent – The function or numerical value used to set the current density or to calculate it.

  • emOff – The distance away from the emitting object to emit.

  • maskFunction – A function used to tailor the shape of emission off of the emitting object.

  • object – The shape object, or GridBoundary as it is called in vorpal, off of which to emit.

addBeamEmitter(sourceName, owningSpecies, start, stop, vbar, vsig, fluxSetting, fluxOrCurrent, coordinate, minValue, maxValue, location)
:noindex:

Add a particle emitter source block to the simulation. Velocity is given by the mean and standard deviation of the velocity distribution of the emitted particles. Current density is given by explicitly being set or by setting the desired flux whereby a calculation is done later. Location of emission can be off a GridBoundary shape or a boundary of the simulation domain. Delegates to addSettableFluxEmitter(15 args).

Parameters

  • sourceName – The name of the particle source block.

  • owningSpecies – The name of the emitted particle the source belongs to. Can be an electron, an ion, or a neutral particle.

  • start – The simulation time at which emission begins.

  • stop – The simulation time at which emission ends.

  • vbar – A three-vector of mean velocities.

  • vsig – A three-vector of rms velocities.

  • fluxSetting – A string used to determine whether to explicitly set the current density or to calculate it.

  • fluxOrCurrent – The function or numerical value used to set the current density or to calculate it.

  • coordinate – The coordinate of the plane of emission. For a Z-Plane, an R-coordinate.

  • minValue – A coordinate defining the minimum spatial value for emission. For a Z-Plane a Z-coordinate.

  • maxValue – A coordinate defining the maximum spatial value for emission. For a Z-Plane a Z-coordinate.

  • location – The boundary plane of the simulation domain to emit off.