cyclotronFrequency (1d, 2d, 3d)

Computes the inverse cyclotron frequency which will then be used in determining the time step restriction.


speciesCharge (float, required)
Charge of the species for which we are computing the cyclotron frequency.
speciesMass (float, required)
Mass of the species for which we are computing the cyclotron frequency.
magneticFieldIndexes (integer vector, required)
The index of the magnetic field in the input data structure in timeStepRestrictionUpdater (1d, 2d, 3d)

Parent Updater Data

The following data structures should be specified to the timeStepRestrictionUpdater (1d, 2d, 3d) that calls the cyclotronFrequency Time Step Restriction.

in (string vector, required)
Mass Density (nodalArray, at least 1 component, required)
The mass density of the plasma. The component of the data structure that contains the mass density is specified with the parameter massIndex (see below).


The following block demonstrates cyclotronFrequency used in combination with timeStepRestrictionUpdater (1d, 2d, 3d) and plasmaFrequency (1d, 2d, 3d) to compute the time-step restriction in a plasma:

<Updater twofluidTimeStepRestrictions>
  kind = timeStepRestrictionUpdater1d
  in = [q]
  restrictions = [wpe, wce]
  onGrid = domain
  courantCondition = 1.0

  <TimeStepRestriction wpe>
      kind = plasmaFrequency1d
      cfl = 1.0
      speciesCharge = ELECTRON_CHARGE
      speciesMass = ELECTRON_MASS
      epsilon0 = 1.0
      massDensityIndex = 0

  <TimeStepRestriction wce>
      kind = cyclotronFrequency1d
      speciesCharge = ELECTRON_CHARGE
      speciesMass = ELECTRON_MASS
      magneticFieldIndexes = [23, 24, 25]
      massDensityIndex = 0