StencilElement

StencilElement

A code block describing a stencil element in MultiField updaters that use a user-defined stencil. The updater is:

linIterUpdater

StencilElement Parameters

minDim (optional integer, default = 1)

If the dimension of the simulation is less than minDim, the element will not be used in the stencil.

rowFieldIndex (required integer)

The index of the field to which this stencil element maps. Thus, when treating the stencil operation as a matrix, a value in this field corresponds to a matrix row.

columnFieldIndex (required integer)

The index of the field from which this stencil element maps. Thus, when treating the stencil operation as a matrix, a value in this field corresponds to a matrix column.

cellOffset (required integer vector)

The offset between the field component the stencil element maps to and the field component the element maps from. Thus, a cellOffset of [\(m\) \(n\) \(p\)] means that a cell will be updated from a cell displaced by \(m\Delta x + n\Delta y + p\Delta z\).

value (required float)

The coefficient of the linear operation between the the mapped field values. Thus, when treating the stencil operation as a matrix, this is the value of the matrix entry.