gradVecUpdater

gradVecUpdater¶

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

Multifield updater that computes the gradient of a scalar field given by the readFields parameter and writes the resulting vector field to writeFields.

gradVecUpdater Parameters¶

The gradVecUpdater 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 scalar field for which to compute the gradient.

writeFields (required string vector): A single element, the vector field to update with the computed gradient.

factor (optional float, default = 1): Factor by which to multiply the field.

differencing (optional string, default = forward)

The direction in which to take the finite differences, one of:

forward:
Performs a gradient of a nodal field to compute the gradient on grid edges.
backward:
Performs a gradient of a cell-centered field to compute the gradient on grid faces.

Example gradVecUpdater Block¶

<FieldUpdater grad_T>
  kind        = gradVecUpdater
  lowerBounds = [ 0  0  0]
  upperBounds = [$NX+1$ $NY+1$ $NZ+1$]
  readFields  = [Temperature]
  writeFields = [HeatFlux]
</FieldUpdater>