CoordProdSTFuncStencilElement

CoordProdSTFuncStencilElement

For use with coordProdSTFuncStencilFiller class in filling matrix entries.

CoordProdSTFuncStencilElement 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 coordProdSTFuncStencilFiller 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.

gridDirection (integer, required)

The direction for the (dual) grid parameters, such as grid spacing and face area, to be used in calculating the matrix entry. Each entry is multiplied by the area specified by gridDirection and gridOffset, and divided by the corresponding grid spacing and cell volume.

gridOffset (integer vector, required)

The offset for the (dual) grid parameters, such as grid spacing and face area, to be used in calculating the matrix entry. Each entry is multiplied by the area specified by gridDirection and gridOffset, and divided by the corresponding grid spacing and cell volume.

value (real, required)

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