Data Management (DM)

DM objects are used to manage communication between the algebraic structures in PETSc (Vec and Mat) and mesh data structures in PDE-based (or other) simulations. See, for structured grids DMDA, for staggered grids DMSTAG, and for unstructured grids DMPLEX. Users guide chapter: DM: Interfacing Between Solvers and Models/Discretizations.

Examples

Manual Pages by Level

Beginner - Basic usage

DMAdaptFlag DMAdaptationCriterion DMAdaptationStrategy DMBoundaryConditionType DMBoundaryType DMClearLabelStratum DMClearLabelValue DMClone DMCompositeGetNumberDM DMCreate DMCreateGlobalVector DMCreateLocalVector DMCreateMatrix DMDirection

DMEnclosureType DMGetBoundingBox DMGetDimension DMGetGlobalVector DMGetLabelIdIS DMGetLabelSize DMGetLabelValue DMGetLocalBoundingBox DMGetLocalVector DMGetNeighbors DMGetStratumIS DMGetStratumSize DMGetUseNatural

DMGlobalToLocal DMLocalToGlobal DMPolytopeType DMRestoreGlobalVector DMRestoreLocalVector DMSetDimension DMSetLabelValue DMSetStratumIS DMSetUseNatural DMType DMView PetscPartitionerCreate PetscUnit

Intermediate - Setting options for algorithms and data structures

DM DMAdaptLabel DMAddBoundary DMAddField DMBlockingType DMCOMPOSITE DMClearDS DMClearFields DMCompareLabels DMCompositeGetLocalISs DMConvert DMCopyLabels DMCreateDS DMCreateDomainDecomposition DMCreateFEDefault DMCreateFieldDecomposition DMCreateFieldIS DMCreateLabel DMCreateLabelAtIndex DMCreateSectionSubDM DMCreateSectionSuperDM DMCreateSubDM DMCreateSuperDM DMField DMFieldEvaluate DMFieldEvaluateFE DMFieldEvaluateFV DMFieldGetDM DMFieldGetDegree DMFieldGetNumComponents DMFieldType DMGetApplicationContext DMGetBlockSize DMGetCeed DMGetCellCoordinateDM DMGetCellCoordinateSection DMGetCellCoordinates DMGetCellCoordinatesLocal DMGetCoarseDM DMGetCoordinateDM DMGetCoordinateDim DMGetCoordinateSection DMGetCoordinates DMGetCoordinatesLocal DMGetDS

DMGetDimPoints DMGetField DMGetFieldAvoidTensor DMGetFineDM DMGetGlobalSection DMGetISColoringType DMGetLabel DMGetLabelByNum DMGetLabelName DMGetLocalSection DMGetMatType DMGetNaturalSF DMGetNearNullSpaceConstructor DMGetNullSpaceConstructor DMGetNumDS DMGetNumFields DMGetNumLabels DMGetOutputDM DMGetOutputSequenceNumber DMGetPointSF DMGetSectionSF DMGetType DMGetVecType DMGlobalToLocalBegin DMGlobalToLocalEnd DMHasLabel DMInterpolationInfo DMLoad DMLocalToGlobalBegin DMLocalToGlobalEnd DMLocalToLocalBegin DMLocalToLocalEnd DMMonitorCancel DMMonitorSet DMOutputSequenceLoad DMPointLocationType DMProjectBdFieldLabelLocal DMProjectCoordinates DMProjectFieldLabel DMProjectFieldLabelLocal DMProjectFieldLocal DMREDUNDANT DMSLICED DMSetApplicationContext

DMSetApplicationContextDestroy DMSetCellCoordinateDM DMSetCellCoordinateSection DMSetCellCoordinates DMSetCellCoordinatesLocal DMSetCoarseDM DMSetCoordinateDM DMSetCoordinateDim DMSetCoordinateSection DMSetCoordinates DMSetCoordinatesLocal DMSetField DMSetFieldAvoidTensor DMSetFromOptions DMSetGlobalSection DMSetISColoringType DMSetLabel DMSetLocalSection DMSetMatType DMSetNaturalSF DMSetNearNullSpaceConstructor DMSetNullSpaceConstructor DMSetNumFields DMSetOutputSequenceNumber DMSetPointSF DMSetSectionSF DMSetType DMSetUp DMSetVariableBounds DMSetVecType DMViewFromOptions MatGetDM PETSCPARTITIONERCHACO PETSCPARTITIONERGATHER PETSCPARTITIONERPARMETIS PETSCPARTITIONERPTSCOTCH PETSCPARTITIONERSHELL PETSCPARTITIONERSIMPLE PetscPartitionerGetType PetscPartitionerSetType PetscPartitionerShellGetRandom PetscPartitionerShellSetRandom PetscPartitionerViewFromOptions VecGetDM

Advanced - Setting more advanced options and customization

DMAdaptMetric DMAppendOptionsPrefix DMCoarsenHookAdd DMCoarsenHookRemove DMCompositeAddDM DMCompositeCreate DMCompositeGather DMCompositeGatherArray DMCompositeGetAccess DMCompositeGetAccessArray DMCompositeGetEntries DMCompositeGetEntriesArray DMCompositeGetGlobalISs DMCompositeGetISLocalToGlobalMappings DMCompositeGetLocalAccessArray DMCompositeGetLocalVectors DMCompositeRestoreAccess DMCompositeRestoreAccessArray DMCompositeRestoreLocalAccessArray DMCompositeRestoreLocalVectors DMCompositeScatter DMCompositeScatterArray DMCompositeSetCoupling DMComputeVariableBounds DMCopyAuxiliaryVec DMCopyDS DMCopyDisc DMCopyFields DMCopyLabelsMode DMCreateInterpolationScale DMFieldDestroy DMFieldGetType DMFieldRegister DMFieldRegisterAll DMFieldSetType DMFieldView DMFindRegionNum DMGenerateRegister DMGenerateRegisterAll DMGetAuxiliaryLabels DMGetAuxiliaryVec DMGetBlockingType DMGetCellCoordinatesLocalNoncollective DMGetCellCoordinatesLocalSetUp

DMGetCompatibility DMGetCoordinatesLocalNoncollective DMGetCoordinatesLocalSetUp DMGetCoordinatesLocalTuple DMGetDefaultConstraints DMGetLocalToGlobalMapping DMGetNumAuxiliaryVec DMGetOptionsPrefix DMGetRegionDS DMGetRegionNumDS DMGetSection DMGlobalToLocalBeginDefaultShell DMGlobalToLocalEndDefaultShell DMGlobalToLocalHookAdd DMLocalToGlobalBeginDefaultShell DMLocalToGlobalEndDefaultShell DMLocalToGlobalHookAdd DMLocalToLocalBeginDefaultShell DMLocalToLocalEndDefaultShell DMPolytopeGetOrientation DMPolytopeGetVertexOrientation DMPolytopeInCellTest DMPolytopeMatchOrientation DMPolytopeMatchVertexOrientation DMRedundantCreate DMRedundantGetSize DMRedundantSetSize DMRefineHookAdd DMRefineHookRemove DMRegister DMRegisterAll DMSetAuxiliaryVec DMSetBlockingType DMSetDefaultConstraints DMSetOptionsPrefix DMSetRefineLevel DMSetRegionDS DMSetRegionNumDS DMSetSection DMShellCreate DMShellGetCoarsen DMShellGetContext DMShellGetCreateInjection

DMShellGetCreateInterpolation DMShellGetCreateRestriction DMShellGetCreateSubDM DMShellGetGlobalVector DMShellGetRefine DMShellSetCoarsen DMShellSetContext DMShellSetCreateDomainDecomposition DMShellSetCreateDomainDecompositionScatters DMShellSetCreateFieldDecomposition DMShellSetCreateGlobalVector DMShellSetCreateInjection DMShellSetCreateInterpolation DMShellSetCreateLocalVector DMShellSetCreateMatrix DMShellSetCreateRestriction DMShellSetCreateSubDM DMShellSetDestroyContext DMShellSetGlobalToLocal DMShellSetGlobalToLocalVecScatter DMShellSetGlobalVector DMShellSetLocalToGlobal DMShellSetLocalToGlobalVecScatter DMShellSetLocalToLocal DMShellSetLocalToLocalVecScatter DMShellSetLocalVector DMShellSetMatrix DMShellSetRefine DMSlicedCreate DMSlicedSetBlockFills DMSlicedSetGhosts DMSlicedSetPreallocation DMSubDomainHookAdd DMSubDomainHookRemove MatFDColoringUseDM PetscDSRegisterAll PetscDualSpaceRegisterAll PetscFERegisterAll PetscFVRegisterAll PetscLimiterRegisterAll PetscPartitionerRegister PetscPartitionerRegisterAll PetscSpaceRegisterAll

Developer - Interfaces rarely needed by applications programmers

DMAdaptor DMAddLabel DMClearGlobalVectors DMClearLocalVectors DMCoarsen DMCoarsenHierarchy DMComputeError DMComputeExactSolution DMComputeL2Diff DMComputeL2FieldDiff DMComputeL2GradientDiff DMCreateColoring DMCreateDomainDecompositionScatters DMCreateInjection DMCreateInterpolation DMCreateMassMatrix DMCreateMassMatrixLumped DMCreateRestriction DMCreateSectionSF DMDestroy DMExtrude DMFieldCreateDefaultQuadrature DMFieldCreateFEGeom DMFieldFinalizePackage DMFieldInitializePackage DMFinalizePackage DMGetAdjacency DMGetBasicAdjacency DMGetCellDS DMGetCoarsenLevel DMGetCoordinatesLocalized DMGetCoordinatesLocalizedLocal

DMGetLabelOutput DMGetNamedGlobalVector DMGetNamedLocalVector DMGetPeriodicity DMGetRefineLevel DMGetWorkArray DMHasBasisTransform DMHasColoring DMHasCreateInjection DMHasCreateRestriction DMHasNamedGlobalVector DMHasNamedLocalVector DMHasVariableBounds DMInitializePackage DMInterpolate DMInterpolateSolution DMLocalizeCoordinate DMLocalizeCoordinates DMLocatePoints DMMonitor DMMonitorSetFromOptions DMProjectFunction DMProjectFunctionLabel DMProjectFunctionLabelLocal DMProjectFunctionLocal DMRefine DMRefineHierarchy DMRemoveLabel DMRemoveLabelBySelf DMRestoreNamedGlobalVector DMRestoreNamedLocalVector DMRestoreWorkArray

DMRestrict DMSetAdjacency DMSetBasicAdjacency DMSetCoarsenLevel DMSetFineDM DMSetLabelOutput DMSetMatrixPreallocateOnly DMSetMatrixPreallocateSkip DMSetMatrixStructureOnly DMSetPeriodicity DMSubDomainRestrict DMUniversalLabel MatSetDM PETSCPARTITIONERMATPARTITIONING PetscDSFinalizePackage PetscDSInitializePackage PetscFEFinalizePackage PetscFEInitializePackage PetscFVFinalizePackage PetscFVInitializePackage PetscPartitionerDestroy PetscPartitionerFinalizePackage PetscPartitionerInitializePackage PetscPartitionerMatPartitioningGetMatPartitioning PetscPartitionerPartition PetscPartitionerReset PetscPartitionerSetFromOptions PetscPartitionerSetUp PetscPartitionerShellSetPartition PetscPartitionerView VecSetDM

Single list of manual pages

DM DMAdaptFlag DMAdaptLabel DMAdaptMetric DMAdaptationCriterion DMAdaptationStrategy DMAdaptor DMAddBoundary DMAddField DMAddLabel DMAppendOptionsPrefix DMBlockingType DMBoundaryConditionType DMBoundaryType DMCOMPOSITE DMClearDS DMClearFields DMClearGlobalVectors DMClearLabelStratum DMClearLabelValue DMClearLocalVectors DMClone DMCoarsen DMCoarsenHierarchy DMCoarsenHookAdd DMCoarsenHookRemove DMCompareLabels DMCompositeAddDM DMCompositeCreate DMCompositeGather DMCompositeGatherArray DMCompositeGetAccess DMCompositeGetAccessArray DMCompositeGetEntries DMCompositeGetEntriesArray DMCompositeGetGlobalISs DMCompositeGetISLocalToGlobalMappings DMCompositeGetLocalAccessArray DMCompositeGetLocalISs DMCompositeGetLocalVectors DMCompositeGetNumberDM DMCompositeRestoreAccess DMCompositeRestoreAccessArray DMCompositeRestoreLocalAccessArray DMCompositeRestoreLocalVectors DMCompositeScatter DMCompositeScatterArray DMCompositeSetCoupling DMComputeError DMComputeExactSolution DMComputeL2Diff DMComputeL2FieldDiff DMComputeL2GradientDiff DMComputeVariableBounds DMConvert DMCopyAuxiliaryVec DMCopyDS DMCopyDisc DMCopyFields DMCopyLabels DMCopyLabelsMode DMCreate DMCreateColoring DMCreateDS DMCreateDomainDecomposition DMCreateDomainDecompositionScatters DMCreateFEDefault DMCreateFieldDecomposition DMCreateFieldIS DMCreateGlobalVector DMCreateInjection DMCreateInterpolation DMCreateInterpolationScale DMCreateLabel DMCreateLabelAtIndex DMCreateLocalVector DMCreateMassMatrix DMCreateMassMatrixLumped DMCreateMatrix DMCreateRestriction DMCreateSectionSF DMCreateSectionSubDM DMCreateSectionSuperDM DMCreateSubDM DMCreateSuperDM DMDestroy DMDirection DMEnclosureType DMExtrude DMField DMFieldCreateDefaultQuadrature DMFieldCreateFEGeom DMFieldDestroy DMFieldEvaluate DMFieldEvaluateFE DMFieldEvaluateFV DMFieldFinalizePackage DMFieldGetDM DMFieldGetDegree DMFieldGetNumComponents DMFieldGetType DMFieldInitializePackage DMFieldRegister DMFieldRegisterAll DMFieldSetType DMFieldType DMFieldView DMFinalizePackage DMFindRegionNum DMGenerateRegister DMGenerateRegisterAll DMGetAdjacency DMGetApplicationContext DMGetAuxiliaryLabels DMGetAuxiliaryVec DMGetBasicAdjacency DMGetBlockSize DMGetBlockingType DMGetBoundingBox DMGetCeed DMGetCellCoordinateDM DMGetCellCoordinateSection DMGetCellCoordinates DMGetCellCoordinatesLocal DMGetCellCoordinatesLocalNoncollective DMGetCellCoordinatesLocalSetUp DMGetCellDS DMGetCoarseDM DMGetCoarsenLevel DMGetCompatibility DMGetCoordinateDM DMGetCoordinateDim DMGetCoordinateSection

DMGetCoordinates DMGetCoordinatesLocal DMGetCoordinatesLocalNoncollective DMGetCoordinatesLocalSetUp DMGetCoordinatesLocalTuple DMGetCoordinatesLocalized DMGetCoordinatesLocalizedLocal DMGetDS DMGetDefaultConstraints DMGetDimPoints DMGetDimension DMGetField DMGetFieldAvoidTensor DMGetFineDM DMGetGlobalSection DMGetGlobalVector DMGetISColoringType DMGetLabel DMGetLabelByNum DMGetLabelIdIS DMGetLabelName DMGetLabelOutput DMGetLabelSize DMGetLabelValue DMGetLocalBoundingBox DMGetLocalSection DMGetLocalToGlobalMapping DMGetLocalVector DMGetMatType DMGetNamedGlobalVector DMGetNamedLocalVector DMGetNaturalSF DMGetNearNullSpaceConstructor DMGetNeighbors DMGetNullSpaceConstructor DMGetNumAuxiliaryVec DMGetNumDS DMGetNumFields DMGetNumLabels DMGetOptionsPrefix DMGetOutputDM DMGetOutputSequenceNumber DMGetPeriodicity DMGetPointSF DMGetRefineLevel DMGetRegionDS DMGetRegionNumDS DMGetSection DMGetSectionSF DMGetStratumIS DMGetStratumSize DMGetType DMGetUseNatural DMGetVecType DMGetWorkArray DMGlobalToLocal DMGlobalToLocalBegin DMGlobalToLocalBeginDefaultShell DMGlobalToLocalEnd DMGlobalToLocalEndDefaultShell DMGlobalToLocalHookAdd DMHasBasisTransform DMHasColoring DMHasCreateInjection DMHasCreateRestriction DMHasLabel DMHasNamedGlobalVector DMHasNamedLocalVector DMHasVariableBounds DMInitializePackage DMInterpolate DMInterpolateSolution DMInterpolationInfo DMLoad DMLocalToGlobal DMLocalToGlobalBegin DMLocalToGlobalBeginDefaultShell DMLocalToGlobalEnd DMLocalToGlobalEndDefaultShell DMLocalToGlobalHookAdd DMLocalToLocalBegin DMLocalToLocalBeginDefaultShell DMLocalToLocalEnd DMLocalToLocalEndDefaultShell DMLocalizeCoordinate DMLocalizeCoordinates DMLocatePoints DMMonitor DMMonitorCancel DMMonitorSet DMMonitorSetFromOptions DMOutputSequenceLoad DMPointLocationType DMPolytopeGetOrientation DMPolytopeGetVertexOrientation DMPolytopeInCellTest DMPolytopeMatchOrientation DMPolytopeMatchVertexOrientation DMPolytopeType DMProjectBdFieldLabelLocal DMProjectCoordinates DMProjectFieldLabel DMProjectFieldLabelLocal DMProjectFieldLocal DMProjectFunction DMProjectFunctionLabel DMProjectFunctionLabelLocal DMProjectFunctionLocal DMREDUNDANT DMRedundantCreate DMRedundantGetSize DMRedundantSetSize DMRefine DMRefineHierarchy DMRefineHookAdd DMRefineHookRemove DMRegister DMRegisterAll DMRemoveLabel DMRemoveLabelBySelf DMRestoreGlobalVector DMRestoreLocalVector DMRestoreNamedGlobalVector DMRestoreNamedLocalVector DMRestoreWorkArray DMRestrict DMSLICED DMSetAdjacency DMSetApplicationContext DMSetApplicationContextDestroy DMSetAuxiliaryVec DMSetBasicAdjacency DMSetBlockingType

DMSetCellCoordinateDM DMSetCellCoordinateSection DMSetCellCoordinates DMSetCellCoordinatesLocal DMSetCoarseDM DMSetCoarsenLevel DMSetCoordinateDM DMSetCoordinateDim DMSetCoordinateSection DMSetCoordinates DMSetCoordinatesLocal DMSetDefaultConstraints DMSetDimension DMSetField DMSetFieldAvoidTensor DMSetFineDM DMSetFromOptions DMSetGlobalSection DMSetISColoringType DMSetLabel DMSetLabelOutput DMSetLabelValue DMSetLocalSection DMSetMatType DMSetMatrixPreallocateOnly DMSetMatrixPreallocateSkip DMSetMatrixStructureOnly DMSetNaturalSF DMSetNearNullSpaceConstructor DMSetNullSpaceConstructor DMSetNumFields DMSetOptionsPrefix DMSetOutputSequenceNumber DMSetPeriodicity DMSetPointSF DMSetRefineLevel DMSetRegionDS DMSetRegionNumDS DMSetSection DMSetSectionSF DMSetStratumIS DMSetType DMSetUp DMSetUseNatural DMSetVariableBounds DMSetVecType DMShellCreate DMShellGetCoarsen DMShellGetContext DMShellGetCreateInjection DMShellGetCreateInterpolation DMShellGetCreateRestriction DMShellGetCreateSubDM DMShellGetGlobalVector DMShellGetRefine DMShellSetCoarsen DMShellSetContext DMShellSetCreateDomainDecomposition DMShellSetCreateDomainDecompositionScatters DMShellSetCreateFieldDecomposition DMShellSetCreateGlobalVector DMShellSetCreateInjection DMShellSetCreateInterpolation DMShellSetCreateLocalVector DMShellSetCreateMatrix DMShellSetCreateRestriction DMShellSetCreateSubDM DMShellSetDestroyContext DMShellSetGlobalToLocal DMShellSetGlobalToLocalVecScatter DMShellSetGlobalVector DMShellSetLocalToGlobal DMShellSetLocalToGlobalVecScatter DMShellSetLocalToLocal DMShellSetLocalToLocalVecScatter DMShellSetLocalVector DMShellSetMatrix DMShellSetRefine DMSlicedCreate DMSlicedSetBlockFills DMSlicedSetGhosts DMSlicedSetPreallocation DMSubDomainHookAdd DMSubDomainHookRemove DMSubDomainRestrict DMType DMUniversalLabel DMView DMViewFromOptions MatFDColoringUseDM MatGetDM MatSetDM PETSCPARTITIONERCHACO PETSCPARTITIONERGATHER PETSCPARTITIONERMATPARTITIONING PETSCPARTITIONERPARMETIS PETSCPARTITIONERPTSCOTCH PETSCPARTITIONERSHELL PETSCPARTITIONERSIMPLE PetscDSFinalizePackage PetscDSInitializePackage PetscDSRegisterAll PetscDualSpaceRegisterAll PetscFEFinalizePackage PetscFEInitializePackage PetscFERegisterAll PetscFVFinalizePackage PetscFVInitializePackage PetscFVRegisterAll PetscLimiterRegisterAll PetscPartitionerCreate PetscPartitionerDestroy PetscPartitionerFinalizePackage PetscPartitionerGetType PetscPartitionerInitializePackage PetscPartitionerMatPartitioningGetMatPartitioning PetscPartitionerPartition PetscPartitionerRegister PetscPartitionerRegisterAll PetscPartitionerReset PetscPartitionerSetFromOptions PetscPartitionerSetType PetscPartitionerSetUp PetscPartitionerShellGetRandom PetscPartitionerShellSetPartition PetscPartitionerShellSetRandom PetscPartitionerView PetscPartitionerViewFromOptions PetscSpaceRegisterAll PetscUnit VecGetDM VecSetDM