field2ScalarUpdater

field2ScalarUpdater

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

Scalar updater that applies a contraction operation on one field, and writes the result to scalars.

field2ScalarUpdater Parameters

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

readField (required string)

The name of the single field on which to operate.

reduceMethod (required string)

Contraction operation to apply to the field. sum is the only one option available now. It sums over a given components of a field and write the total sum result to a scalar.

readComponents (required integer vector)

The components to use in the operand fields.

writeScalars (required string vector)

The scalars where results are written into. There shoul be same number of scalars as number of components in readComponents. As each scalar corresponds to operation on one component of a field.

Example field2ScalarUpdater Block

# A7 = sum(F1_x), A8 = sum(F1_z)
<Updater fieldSum>
  kind = field2ScalarUpdater
  reduceMethod = sum
  readField = F1
  lowerBounds = [0 0 0]
  upperBounds = [NX1 NY1 NZ1]
  readComponents = [0 2]
  writeScalars = [A7 A8]
</Updater>