ScalarDepositor

ScalarDepositor

More flexible way of depositing charge from charged particles in a simulation into depFields than the classical way of depositing charge into the zeroth component of a SumRhoJ field.

Note

The ScalarDepositor should not be used in a MultiField block of kind = emMultiField, or errors will occur in the simulation.

Note

Higher order particles are incompatible with the polar/cylindrical axis. If particles in the simulation pass near the polar/cylindrical coordinate axis at r = 0, only areaWeightingCP or esirk1stOrderCP can be used.

ScalarDepositor Parameters

kind (string, default = areaWeighting)

Kind of deposition algorithm; choices are:

• areaWeighting

  Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.

• esirk1stOrder

  Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.

• esirk2ndOrder, …, esirk7thOrder

  Works with VSimPD and VSimPA licenses.

• areaWeightingCP (for coordProdGrid)

  Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.

• esirk1stOrderCP (for coordProdGrid)

  Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses. When working with CoordProd grids these work slighty different for cartesian and cylindrical grids. If working with cylindrical grids the deposited quantity is Charge, and not ChargeDensity. To compensate for this it is necessary to use a scaling field that will apply the function 1/(PI*DZ*( (y+DR/2)^2 - (max(0, y-DR/2) )^2)) For an example of this it is recommended to review a visual setup example input file using the “maximum stabilty” particle deposition.

• esirk2ndOrderCP, …, esirk7thOrderCP (for coordProdGrid)

  Works with VSimPD and VSimPA licenses.

depField (string)

Scalar defined in the MultiField block that will contain the deposited charge.

Note

When using higher order deposition (esirk2ndOrder, …, esirk7thOrder), maxIntDepHalfWidth must be set accordingly in the Grid block (see Additional Attributes for Particle Simulations).

Example ScalarDepositor Block

<ScalarDepositor chargeDep>
  kind = areaWeighting
  depField = myEmField.rho
</ScalarDepositor>

Example Reference to ScalarDepositor in a Species Block

<Species  electrons>
  kind = relBorisDF
  chargeDeps = [chargeDep]
  .
  .
  .
</Species>