frequency (1d, 2d, 3d)¶

Computes the minimum time step suggested by an array of frequencies.

Parameters¶

components (int, required): Number of components in the input array. Each of the values in the array will be used to compute a time step restriction.

Parent Updater Data¶

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

in (string vector, required)

Reaction Frequency (nodalArray, N components, required): An set of reaction frequencies to compute the restriction from

Example¶

The following block demonstrates frequency used in combination with timeStepRestrictionUpdater (1d, 2d, 3d) to compute a time-step restriction for a set of reactions:

<Updater timestepRestriction>
 kind = timeStepRestrictionUpdater2d
  in = [reactionFreq]
  onGrid = domain
  restrictions = [reaction]
  courantCondition = CFLR

  <TimeStepRestriction reaction>
    kind = frequency2d
    components = 1
  </TimeStepRestriction>
</Updater>