STFuncStencilElement

STFuncStencilElement

For use with stFuncStencilFiller class in filling matrix entries.

STFuncStencilElement Parameters

minDim (integer, default = 1)

If NDIM < minDim, the element will not be inserted into the matrix.

rowFieldIndex (integer, required)

Row index of this element (always the writeFieldIndex in linIterUpdater).

columnFieldIndex (integer, required)

Column index of this element (always the readFieldIndex in linIterUpdater).

cellOffset (integer vector, required)

[\(m_j\) \(n_j\) \(p_j\)], as described in the equations in linIterUpdater.

functionOffset (real vector, required)

The offsets, in fractions of the grid spacing, at which the STFunc of the containing stFuncStencilFiller will be evaluated. So, for example, [0.5 0.0 0.0] corresponds to evaluation at a point half a grid-cell in the x-direction from the point being considered.

value (real, required)

Value to be multiplied by the value of the STFunc of the containing stFuncStencilFiller.