potentialUpdater

potentialUpdater

Works with VSimEM, VSimPD, and VSimMD licenses.

An updater that calculates the potential due to a charge distribution field.

potentialUpdater Parameters

The potentialUpdater MultiField updater takes the lowerBounds and upperBounds parameters of FieldUpdater. In addition, potentialUpdater takes the following parameters:

sourceLowerBounds (required int vector)

The lower bounds of the region containing sources.

sourceUpperBounds (required int vector)

The upper bounds of the region containing sources.

direction (required integer)

The direction associated with the update region.

factor (required float)

Multiplicative factor for scaling of potential.

readField (required string vector)

A vector containing a single element, the name of the field to use in the potentialUpdater.

writeField (required string vector)

A vector containing a single element, the name of the field to update with appropriate values for a potentialUpdater.

readComponent (optional integer)

The component of the read field to be used.

writeComponent (optional integer)

The component of the write field to write to.

gammaVec (optional float vector)

Relativistic gamma used for scaling of lengths.

minDim (optional integer)

The minimum dimensionality for which to apply the updater.

Example potentialUpdater Block

<FieldUpdater psiZHiBoundaryCalculation>
  kind = potentialUpdater
  lowerBounds = [0 0 176]
  upperBounds = [129 177 177]
  minDim = 3
  readField = kappa
  readComponent = 0
  writeField = psi
  writeComponent = 0
  direction = 2
  sourceLowerBounds = [0 0 0]
  sourceUpperBounds = [129 177 177]
  restoreTimeFromField = phi
  factor = 112940906675.81473
  gammaVec = [490.2367906066536 1.0 1.0]
</FieldUpdater>