neutralBoltzmannUpdater

neutralBoltzmannUpdater

Works with VSimPD license.

MultiField updater that computes the electrostatic potential satisfying the Boltzmann relation. It reads a charge density field \(\rho\) and updates a potential field.

\[\phi = - T_{0}\ ln\Big(\dfrac{\rho}{n_{0}q_{0}}\Big) - \phi_{0}\]

neutralBoltzmannUpdater Parameters

The neutralBoltzmannUpdater takes the lowerBounds and upperBounds parameters of FieldUpdater, as well as the following parameters:

readFields (required string vector)

A single element, the name of the field containing the charge density in component 0.

writeFields (required string vector)

A single element, the name of field to update. Component 0 of this field will be updated with the electrostatic potential.

n0 (required float)

Background density in #/m³.

T0 (required float)

Temperature (in eV).

q0 (required float)

Charge of electron.

phi0 (required float)

Constant offset to electrostatic potential.

mion (required float)

(not used).

mindensity (required float)

Lowest density allowed.

Example neutralBoltzmannUpdater Block

<FieldUpdater esSolve>
  kind = neutralBoltzmannUpdater

  n0 = ELECDENS
  T0 = ELECTEMPERATURE
  q0 = ELECCHARGE
  phi0 = 4.6
  mindensity = NP2C

  lowerBounds = [0 0 0]
  upperBounds = [NX NY NZ]
  readFields  = [rhoJ]
  writeFields = [phi]
</FieldUpdater>