matrices.mac

This macro file can be imported to an input file with

$ import matrices

It is imported by VSimEs.mac.

This macro file is available to all packages.

This macro file defines macros for matrices. None of the macros are considered public, i.e., with stable APIs.

Public Macros

StencilElementMacro(name, value, minDim, offset, rowFldIndx, colFldIndx)

Insert a constant-value matrices StencilElement.

Parameters

  • name – The name to give the stencil element.

  • value – The value of the stencil element.

  • minDim – The minimum dimensionality to apply this stencil element.

  • offset – The offset (in index space) of the column cell from the row cel.

  • rowFldIndx – The index in the matrices for the row. This corresponds to the writefield for multiply, to the readfield for solve.

  • colFldIndx – The index in the matrices for the column. This corresponds to the readfield for multiply, to the writefield for solve.

STFuncStencilElementMacro(name, value, minDim, cellOffset, funcOffset, rowFldIndx, colFldIndx)

Insert a function-value matrices StencilElement.

Parameters

  • name – The name to give the stencil element.

  • value – The value of the stencil element.

  • minDim – The minimum dimensionality to apply this stencil element.

  • cellOffset – The offset (in index space) of the column cell from the row cel.

  • funcOffset – The offset (in real space, as a multiple of the grid spacing) of the function evaluation point from the row cell.

  • rowFldIndx – The index in the matrices for the row. This corresponds to the writefield for multiply, to the readfield for solve.

  • colFldIndx – The index in the matrices for the column. This corresponds to the readfield for multiply, to the writefield for solve.

CoordProdSTFuncStencilElementMacro(name, value, minDim, cellOffset, funcOffset, gridDir, gridOffset, rowFldIndx, colFldIndx)

Insert a function-value matrices StencilElement in coordProd grid.

Parameters

  • name – The name to give the stencil element.

  • value – The value of the stencil element.

  • minDim – The minimum dimensionality to apply this stencil element.

  • cellOffset – The offset (in index space) of the column cell from the row cel.

  • funcOffset – The offset (in real space, as a multiple of the grid spacing) of the function evaluation point from the row cell.

  • gridDir – The direction in which differencing is being done for the stencil. Determines which grid spacing and face area to use.

  • gridOffset – The offset (in index space) from the row cell at which the grid spacing and face area are taken.

  • rowFldIndx – The index in the matrices for the row. This corresponds to the writefield for multiply, to the readfield for solve.

  • colFldIndx – The index in the matrices for the column. This corresponds to the readfield for multiply, to the writefield for solve.