secondaryEmitter

secondaryEmitter Parameters

ptclAbsorber (string)

To emit secondaries from primary particles that are absorbed (or, more generally, that run into a ParticleSink), this option should specify the name of the ParticleSink (which must be of a kind that stores absorbed particles). When used with a gridBoundary the ptclAbsorber should probably always be of type absSavTriCutCell (with recordParticleData=true), since that is currently the only cut-cell absorber that records the exact time of absorption and the surface normal.

ptclSource (string)

(This option may be specified instead of ptclAbsorber.) To emit secondaries from primary particles that are emitted from a ParticleSource, this option should specify the name of the particle source that emits the primary particles whose emission triggers secondary emission. If the ParticleSource emits a species other than the Species block that contains the ParticleSource, then sourceSpecies must also be specified. This is typically used to allow secondary emission of a Species based on secondary emission of another Species. The ParticleSource block must specify recordParticleData=true because secondaries will be emitted based on the recorded particles.

sourceSpecies (string)

The name of the Species emitted by the ptclSource; this is required only if a ptclSource is specified that emits a Species other than the Species block containing the ParticleSource.

lowerBounds (integer vector, optional, default = global simulation bounds)

The lower (global cell) bounds within which a primary particle can produce secondaries.

upperBounds (integer vector, optional, default = global simulation bounds)

The upper (global cell) bounds within which a primary particle can produce secondaries.

gridBoundary (string, optional)

A gridBoundary specifying the surface from which secondaries are emitted; it is strongly recommended that this be the same gridBoundary at which primary particles are absorbed. The gridBoundary supplies the surface-normal where secondary emission occurs. If, in pathological cases, there is no surface in the cell where emission occurs, the normal will be taken to be opposite the primary particle’s velocity.

emissionDirection (vector, optional)

if no gridBoundary is specified, this gives the outward surface normal direction for secondary emission.

depositCurrentFromCorner (boolean, optional, default = true)

This option should generally be true in electromagnetic simulations, especially for emission from metallic (conducting) surfaces; it avoids the creation of artificial stationary charges. In electromagnetic simulation, emitting a charge from the middle of a cell automatically creates (or rather, leads to electromagnetic fields that act as if there were) an opposite charge that remains at the emission location forever. If this option is true, then electrical current will be deposited from a corner of the emission cell that is inside the absorber to the emission location.

functionVariables (vector of strings, optional, default = empty vector)

a list of quantities, describing the primary particle, upon which the Expressions sey, velocityAndTag, and internVars can depend. For example, including velocity_0 in this list allows the first component of the primary particle’s velocity to be used in the sey function. Valid options are the same as for ptclAttributes in speciesBinning.

sey (block, required)

The expression <Expression sey> (see Introduction to UserFuncs and Expressions) that defines the secondary emission yield (SEY). It must be named sey, and can take arguments listed in functionVariables which depend on the particular primary particle. It must return a scalar value which is the (expected or average) number of physical secondary particles to be emitted for each physical primary particle. The interpretation of what to do if the SEY calls for a fractional secondary macroparticle, or multiple secondary macroparticles, depends on the ptclCountType option.

emitIntoGridBoundaryInterior (boolean, optional, default = true)

Typically the gridBoundary interior is the physical domain in which particles move, while the exterior absorbs particles (and this option should be true); in case the gridBoundary interior is the absorbing material, with particles moving in the region exterior to the gridBoundary, this option can be set to false so that secondary particles will be emitted into the exterior of gridBoundary. If false, the ptclAbsorber should probably specify absorberIsInGridBoundary=true (currently, only ParticleSink absSavTriCutCell has that option).

ptclCountType (string, optional, default = emitCounting)

Describes how the emission of fractional or multiple secondary particles is handled. This parameter is optional, and defaults to emitCounting. In the following, a primary macroparticle represents \(P\) physical particles and the expected number of secondary physical particles is \(S = P \times SEY\). Valid options are:

• emitCounting (default for constant-weight secondaries)

  Emit multiple secondary macroparticles with default weight. I.e., if \(M\) is the default number of physical particles per secondary macroparticle, then either floor(\(S/M\)) or ceil(\(S/M\)) secondary macroparticles will be emitted, with a probability chosen so that on average \(S\) physical secondaries are emitted.

• noCounting

  This is the same as emitCounting except that at most 1 macroparticle is emitted (i.e., either 0 or 1 secondary macroparticles). This gives the wrong result if \(S\) exceeds the default number of physical particles per secondary macroparticle. However, it may be appropriate if that situation is rare and one wants to avoid emitting a glut of secondary macroparticles on those rare occasions.

• vwCounting (default for variable-weight secondaries)

  For variable-weight secondary species, emit a single macroparticle with weight set to represent \(S\) secondary physical particles.

autoGenerateTag (boolean, optional, default = true)

Whether a tag will be automatically generated for each secondary; if false then the velocityAndTag Expression must specify the tag.

<Expression velocityAndTag> (block, required)

An expression (see Introduction to UserFuncs and Expressions) that defines the velocity and (possibly) tag of the secondary particle. It must be named velocityAndTag, and can take arguments listed in functionVariables which depend on the particular primary particle. If autoGenerateTag is true then this must return 3 velocity components; if false then this must return 4 components, three velocities plus a tag for the secondary. The tag is used only if the secondary Species is tagged. The “velocity” components are actually the spatial four-velocity components in a coordinate system that depends on the emission surface and the primary particle. The first coordinate \(u_n\) is the component normal to the surface; the second is perpendicular to the first and in the plane of the primary particle’s velocity. The third coordinate is then normal to the first two, and in right-hand-rule order. If the primary particle is incident along the normal, then the third coordinate is the cardinal direction (e.g., +x, +y, or +z in cartesian systems) most perpendicular to the normal; and the second is then chosen normal to the first and third in right-hand order. In 2D, the third coordinate is always in the direction of the unsimulated direction, with its sign chosen so that the primary incident velocity and the cross product of the third and first coordinates are in the same drection.

<Expression internVars> (block, optional)

An optional expression (see Introduction to UserFuncs and Expressions) that defines the final internal variables (e.g., velocity, tag, weight, etc.) of each secondary particle (this is an advanced feature that is rarely needed). It must be named internVars, and can take arguments listed in functionVariables as well as the recommended internal variables selected for the secondary particle, e.g., by velocityAndTag and ptclCountType. These are accessed by the variables secInternVars_0, secInternVars_1, etc. This expression allows ultimate flexibility in setting the final internal variables of the secondary particle, but one must be very careful that one understands exactly what those internal variables are.

emitForPrimariesWithoutSurfaceNormal (boolean, default = false)

Absorption of particles, especially at curved surfaces, can be complicated with finite precision computations. In pathological cases, particles may occasionally be absorbed in such a way that the surface normal (at absorption location) is unknown; that is usually because the particles are not absorbed at a surface. For example, a particle may be (intentionally or not) loaded inside an absorber, i.e., so that a particle may be absorbed without crossing the surface of the absorber. If this option is true then secondaries will still be emitted even for primaries for which no surface normal is known (in this case, the emission location is probably not the surface of the absorber, but may be deep in the bulk absorber). Typically the only reason for this to be true is if the failure to emit a secondary would result in a systematic conservation error.

suppressEnergy (float, optional, default = -1.)

If negative, this has no effect on emission. If this is zero, then emission does not occur if the electric force on the particle (at emission location) points back toward the surface, regardless of the secondary particle’s energy. If this is positive, then emission does not occur if the electric field forces the particle back toward the surface and the electric force is sufficiently strong. Specifically, the electric force on the particle, projected onto the surface normal, will be calculated; if the force is away from the surface, there is no effect (the secondary particle will be emitted). If the force is back toward the surface, then secondary emission is suppressed if the (projected) force times the cell diagonal (in Joules) exceeds (or equals) suppressEnergy. E.g., if suppressEnergy is zero, then emission will be suppressed whenever the electric force points toward the emission surface. If suppressEnergy is 1.6e-19, then emission will be suppressed (for an electron or singly-charged ion) if the electric field times the cell-diagonal-length is greater than 1 V; i.e., an emitted electron with less than 1 eV could not travel a cell-diagonal before being turned back toward the surface. If suppressEnergy is very large, then emission will not be suppressed, just as if suppressEnergy is negative. Note that the calculation of whether secondary emission is suppressed has nothing to do with the energy of primary or secondary particles, but depends only on the local electric field at the location of the primary particle. If non-negative, suppressEnergy is typically set to zero to emit only when the electric force points away from the surface, or it may set to a value on the order of typical secondary particle energy, ensuring that emission will be suppressed only if the electric force would prevent typical particles from traveling a cell-diagonal.

<ParticleSource coneSecEmitter>
  kind = secondaryEmitter
  recordParticleData = true
  gridBoundary = coneSurf
  ptclAbsorber = coneSurfSink
  functionVariables = []

  <Expression sey>
    kind = expression
    expression = 1.0
  </Expression>

  autoGenerateTag = false

  <Expression velocityAndTag>
    kind = expression
    expression = vector(0.1*299792458.0,0.,0.,1.3)
  </Expression>

  ptclCountType = emitCounting
  depositCurrentFromCorner = true
</ParticleSource>

<ParticleSource specSecEmitter>
  kind = secondaryEmitter
  gridBoundary = specSurf
  ptclAbsorber = specSurfSink
  functionVariables = ['gammaVelocity_0'  'gammaVelocity_1' \
           'gammaVelocity_2'  'surfaceNormalIntoAbsorber_0' \
           'surfaceNormalIntoAbsorber_1'  'surfaceNormalIntoAbsorber_2' \
           'surfaceTangent1_0'  'surfaceTangent1_1'  'surfaceTangent1_2' \
           'surfaceTangent2_0'  'surfaceTangent2_1'  'surfaceTangent2_2']

  <Expression sey>
    kind = expression
    expression = 0.9
  </Expression>

  autoGenerateTag = false

  <Expression velocityAndTag>
    kind = expression
    expression = vector( \
     (gammaVelocity_0*surfaceNormalIntoAbsorber_0+ \
      gammaVelocity_1*surfaceNormalIntoAbsorber_1+ \
      gammaVelocity_2*surfaceNormalIntoAbsorber_2), \
    (gammaVelocity_0*surfaceTangent1_0+ \
     gammaVelocity_1*surfaceTangent1_1+ \
     gammaVelocity_2*surfaceTangent1_2), \
    (gammaVelocity_0*surfaceTangent2_0+ \
     gammaVelocity_1*surfaceTangent2_1+ \
     gammaVelocity_2*surfaceTangent2_2),\
    -1.)
  </Expression>

  <Expression internVars>
    kind = expression
    expression = vector(\
      secInternVars_0,secInternVars_1,secInternVars_2,secPtclWeight)
  </Expression>

  ptclCountType = vwCounting
  depositCurrentFromCorner = true
</ParticleSource>