Staggered, Structured Grids (DMSTAG)

The DMSTAG subclass of DM encapsulates a Cartesian structured mesh, with “staggered” data living on elements, faces, edges, and vertices. Users guide chapter DMSTAG: Staggered, Structured Grid.

Examples

Manual Pages by Level

Beginner - Basic usage

DMSTAG DMStagCreate1d DMStagCreate2d DMStagCreate3d DMStagGetCorners DMStagGetDOF DMStagGetGhostCorners DMStagGetGlobalSizes

DMStagGetLocalSizes DMStagGetLocationSlot DMStagGetStencilType DMStagGetStencilWidth DMStagSetStencilType DMStagSetStencilWidth DMStagSetUniformCoordinatesExplicit

DMStagStencil DMStagStencilLocation DMStagStencilType DMStagVecGetArray DMStagVecGetArrayRead DMStagVecRestoreArray DMStagVecRestoreArrayRead

Intermediate - Setting options for algorithms and data structures

DMStagCreateCompatibleDMStag DMStagGetBoundaryTypes DMStagGetIsFirstRank DMStagGetIsLastRank DMStagGetLocationDOF

DMStagGetNumRanks DMStagGetOwnershipRanges DMStagGetProductCoordinateArrays DMStagGetProductCoordinateArraysRead DMStagGetProductCoordinateLocationSlot

DMStagMatSetValuesStencil DMStagRestoreProductCoordinateArrays DMStagRestoreProductCoordinateArraysRead DMStagSetUniformCoordinatesProduct

Advanced - Setting more advanced options and customization

DMStagCreateISFromStencils DMStagMatGetValuesStencil DMStagMigrateVec DMStagRestrictSimple

DMStagSetBoundaryTypes DMStagSetCoordinateDMType DMStagSetDOF DMStagSetGlobalSizes

DMStagSetUniformCoordinates DMStagVecGetValuesStencil DMStagVecSetValuesStencil DMStagVecSplitToDMDA

Developer - Interfaces rarely needed by applications programmers

DMStagDuplicateWithoutSetup DMStagGetEntries DMStagGetEntriesLocal

DMStagGetEntriesPerElement DMStagPopulateLocalToGlobalInjective DMStagSetNumRanks

DMStagSetOwnershipRanges DMStagStencilToIndexLocal

Single list of manual pages

DMSTAG DMStagCreate1d DMStagCreate2d DMStagCreate3d DMStagCreateCompatibleDMStag DMStagCreateISFromStencils DMStagDuplicateWithoutSetup DMStagGetBoundaryTypes DMStagGetCorners DMStagGetDOF DMStagGetEntries DMStagGetEntriesLocal DMStagGetEntriesPerElement DMStagGetGhostCorners DMStagGetGlobalSizes DMStagGetIsFirstRank DMStagGetIsLastRank DMStagGetLocalSizes DMStagGetLocationDOF

DMStagGetLocationSlot DMStagGetNumRanks DMStagGetOwnershipRanges DMStagGetProductCoordinateArrays DMStagGetProductCoordinateArraysRead DMStagGetProductCoordinateLocationSlot DMStagGetStencilType DMStagGetStencilWidth DMStagMatGetValuesStencil DMStagMatSetValuesStencil DMStagMigrateVec DMStagPopulateLocalToGlobalInjective DMStagRestoreProductCoordinateArrays DMStagRestoreProductCoordinateArraysRead DMStagRestrictSimple DMStagSetBoundaryTypes DMStagSetCoordinateDMType DMStagSetDOF DMStagSetGlobalSizes

DMStagSetNumRanks DMStagSetOwnershipRanges DMStagSetStencilType DMStagSetStencilWidth DMStagSetUniformCoordinates DMStagSetUniformCoordinatesExplicit DMStagSetUniformCoordinatesProduct DMStagStencil DMStagStencilLocation DMStagStencilToIndexLocal DMStagStencilType DMStagVecGetArray DMStagVecGetArrayRead DMStagVecGetValuesStencil DMStagVecRestoreArray DMStagVecRestoreArrayRead DMStagVecSetValuesStencil DMStagVecSplitToDMDA