setToSTFuncCrossDev

setToSTFuncCrossDev

Works with XSimBase license.

MultiField updater for Cross Devices that sets the values of any number of kind=regularCrossDev fields (writeFields) based on the evaluation of a provided function.

setToSTFuncCrossDev Parameters

The setToSTFuncCrossDev updater takes the lowerBounds, upperBounds, lowerCoords, upperCoords, gridBndry, writeFields, and readFields parameters of Field Slab updaters, as well as the following parameters:

writeComponent (required integer vector)

The component of the field to be set.

STFunc (STFunc block, required)

A STFunc block that evaluates to determine the value of the field.

Example setToSTFuncCrossDev block

<FieldUpdater resistivityUpdater>
  kind = setToSTFuncCrossDev
  lowerBounds = [-2  -2  -2]
  upperBounds = [66  66  14]
  writeComponent = 0
  writeFields = [eta]

  <STFunc function>
    kind = expression
    expression = x * 1.0e-4
  </STFunc>
</FieldUpdater>

Notes

History

setToSTFuncCrossDev was introduced in XSim 1.