DMPlex (Unstructured Meshes)

DMPlexBuildCoordinatesFromCellList(petsclib::PetscLibType, dm::AbstractPetscDM, spaceDim::PetscInt, vertexCoords::Vector{PetscReal})

Build DM coordinates from a list of coordinates for each owned vertex (common mesh generator output)

Collective

Input Parameters:

• dm - The DM
• spaceDim - The spatial dimension used for coordinates
• vertexCoords - An array of numVertices*spaceDim numbers, the coordinates of each vertex

Level: advanced

See also: DM, DMPLEX, DMPlexBuildCoordinatesFromCellListParallel(), DMPlexCreateFromCellListPetsc(), DMPlexBuildFromCellList()

External Links

• PETSc Manual: DMPlex/DMPlexBuildCoordinatesFromCellList

DMPlexBuildCoordinatesFromCellListParallel(petsclib::PetscLibType, dm::AbstractPetscDM, spaceDim::PetscInt, sfVert::PetscSF, vertexCoords::Vector{PetscReal})

Build DM coordinates from a list of coordinates for each owned vertex (common mesh generator output)

Collective; No Fortran Support

Input Parameters:

• dm - The DM
• spaceDim - The spatial dimension used for coordinates
• sfVert - PetscSF describing complete vertex ownership
• vertexCoords - An array of numVertices*spaceDim numbers, the coordinates of each vertex

Level: advanced

See also: DM, DMPLEX, DMPlexBuildCoordinatesFromCellList(), DMPlexCreateFromCellListParallelPetsc(), DMPlexBuildFromCellListParallel()

External Links

• PETSc Manual: DMPlex/DMPlexBuildCoordinatesFromCellListParallel

DMPlexBuildFromCellList(petsclib::PetscLibType, dm::AbstractPetscDM, numCells::PetscInt, numVertices::PetscInt, numCorners::PetscInt, cells::Vector{PetscInt})

Build DMPLEX topology from a list of vertices for each cell (common mesh generator output)

Collective; No Fortran Support

Input Parameters:

• dm - The DM
• numCells - The number of cells owned by this process
• numVertices - The number of vertices owned by this process, or PETSC_DETERMINE
• numCorners - The number of vertices for each cell
• cells - An array of numCells x numCorners numbers, the global vertex numbers for each cell

Level: advanced

See also: DM, DMPLEX, DMPlexBuildFromCellListParallel(), DMPlexBuildCoordinatesFromCellList(), DMPlexCreateFromCellListPetsc()

External Links

• PETSc Manual: DMPlex/DMPlexBuildFromCellList

vertexSF::PetscSF,verticesAdjSaved::Ptr{PetscInt} = DMPlexBuildFromCellListParallel(petsclib::PetscLibType, dm::AbstractPetscDM, numCells::PetscInt, numVertices::PetscInt, NVertices::PetscInt, numCorners::PetscInt, cells::Vector{PetscInt})

Build a distributed DMPLEX topology from a list of vertices for each cell (common mesh generator output) where all cells have the same celltype

Collective; No Fortran Support

Input Parameters:

• dm - The DM
• numCells - The number of cells owned by this process
• numVertices - The number of vertices to be owned by this process, or PETSC_DECIDE
• NVertices - The global number of vertices, or PETSC_DETERMINE
• numCorners - The number of vertices for each cell
• cells - An array of numCells \times numCorners numbers, the global vertex numbers for each cell

Output Parameters:

• vertexSF - (Optional) PetscSF describing complete vertex ownership
• verticesAdjSaved - (Optional) vertex adjacency array, must be freed by user

Level: advanced

See also: DM, DMPLEX, DMPlexBuildFromCellList(), DMPlexCreateFromCellListParallelPetsc(), DMPlexBuildCoordinatesFromCellListParallel(), PetscSF

External Links

• PETSc Manual: DMPlex/DMPlexBuildFromCellListParallel

vertexSF::PetscSF,verticesAdjSaved::Ptr{PetscInt} = DMPlexBuildFromCellSectionParallel(petsclib::PetscLibType, dm::AbstractPetscDM, numCells::PetscInt, numVertices::PetscInt, NVertices::PetscInt, cellSection::PetscSection, cells::Vector{PetscInt})

Build distributed DMPLEX topology from a list of vertices for each cell (common mesh generator output) allowing multiple celltypes

Collective; No Fortran Support

Input Parameters:

• dm - The DM
• numCells - The number of cells owned by this process
• numVertices - The number of vertices to be owned by this process, or PETSC_DECIDE
• NVertices - The global number of vertices, or PETSC_DETERMINE
• cellSection - The PetscSection giving the number of vertices for each cell (layout of cells)
• cells - An array of the global vertex numbers for each cell

Output Parameters:

• vertexSF - (Optional) PetscSF describing complete vertex ownership
• verticesAdjSaved - (Optional) vertex adjacency array, must be freed by user

Level: advanced

See also: DM, DMPLEX, DMPlexBuildFromCellListParallel(), DMPlexCreateFromCellSectionParallel(), DMPlexBuildCoordinatesFromCellListParallel(), PetscSF

External Links

• PETSc Manual: DMPlex/DMPlexBuildFromCellSectionParallel

DMPlexCheck(petsclib::PetscLibType, dm::AbstractPetscDM)

Perform various checks of DMPLEX sanity

Input Parameter:

• dm - The DMPLEX object

Level: developer

See also: DM, DMPLEX, DMCreate(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheck

DMPlexCheckCellShape(petsclib::PetscLibType, dm::AbstractPetscDM, output::PetscBool, condLimit::PetscReal)

Checks the Jacobian of the mapping from reference to real cells and computes some minimal statistics.

Collective

Input Parameters:

• dm - The DMPLEX object
• output - If true, statistics will be displayed on stdout
• condLimit - Display all cells above this condition number, or PETSC_DETERMINE for no cell output

Level: developer

See also: DM, DMPLEX, DMSetFromOptions(), DMPlexComputeOrthogonalQuality()

External Links

• PETSc Manual: DMPlex/DMPlexCheckCellShape

DMPlexCheckFaces(petsclib::PetscLibType, dm::AbstractPetscDM, cellHeight::PetscInt)

Check that the faces of each cell give a vertex order this is consistent with what we expect from the cell type

Collective

Input Parameters:

• dm - The DMPLEX object
• cellHeight - Normally 0

Level: developer

See also: DM, DMPLEX, DMCreate(), DMPlexGetVTKCellHeight(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheckFaces

DMPlexCheckGeometry(petsclib::PetscLibType, dm::AbstractPetscDM)

Check the geometry of mesh cells

Input Parameter:

• dm - The DMPLEX object

Level: developer

See also: DM, DMPLEX, DMCreate(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheckGeometry

DMPlexCheckInterfaceCones(petsclib::PetscLibType, dm::AbstractPetscDM)

Check that points on inter-partition interfaces have conforming order of cone points.

Input Parameter:

• dm - The DMPLEX object

Level: developer

See also: DM, DMPLEX, DMPlexGetCone(), DMPlexGetConeSize(), DMGetPointSF(), DMGetCoordinates(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheckInterfaceCones

DMPlexCheckOrphanVertices(petsclib::PetscLibType, dm::AbstractPetscDM)

Check that no vertices are disconnected from the mesh, unless the mesh only consists of disconnected vertices.

Collective

Input Parameter:

• dm - The DMPLEX object

Level: developer

See also: DM, DMPLEX, DMPlexCheck(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheckOrphanVertices

DMPlexCheckPointSF(petsclib::PetscLibType, dm::AbstractPetscDM, pointSF::PetscSF, allowExtraRoots::PetscBool)

Check that several necessary conditions are met for the point PetscSF of this plex.

Collective

Input Parameters:

• dm - The DMPLEX object
• pointSF - The PetscSF, or NULL for PointSF attached to DM
• allowExtraRoots - Flag to allow extra points not present in the DM

Level: developer

See also: DM, DMPLEX, DMGetPointSF(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheckPointSF

DMPlexCheckSkeleton(petsclib::PetscLibType, dm::AbstractPetscDM, cellHeight::PetscInt)

Check that each cell has the correct number of vertices

Input Parameters:

• dm - The DMPLEX object
• cellHeight - Normally 0

Level: developer

See also: DM, DMPLEX, DMCreate(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheckSkeleton

DMPlexCheckSymmetry(petsclib::PetscLibType, dm::AbstractPetscDM)

Check that the adjacency information in the mesh is symmetric.

Input Parameter:

• dm - The DMPLEX object

Level: developer

See also: DM, DMPLEX, DMCreate(), DMSetFromOptions()

External Links

• PETSc Manual: DMPlex/DMPlexCheckSymmetry

DMPlexComputeBdIntegral(petsclib::PetscLibType, dm::AbstractPetscDM, X::AbstractPetscVec, label::DMLabel, numVals::PetscInt, vals::Vector{PetscInt}, noname::Ptr{Cvoid})

Form the integral over the specified boundary from the global input X using pointwise functions specified by the user

Input Parameters:

• dm - The mesh
• X - Global input vector
• label - The boundary DMLabel
• numVals - The number of label values to use, or PETSC_DETERMINE for all values
• vals - The label values to use, or NULL for all values
• funcs - The functions to integrate along the boundary for each field
• ctx - The application context

Output Parameter:

• integral - Integral for each field

Level: developer

See also: DM, DMPLEX, DMPlexComputeIntegralFEM(), DMPlexComputeBdResidualFEM()

External Links

• PETSc Manual: DMPlex/DMPlexComputeBdIntegral

DMPlexComputeBdJacobianSingle(petsclib::PetscLibType, dm::AbstractPetscDM, wf::PetscWeakForm, label::DMLabel, numValues::PetscInt, values::Vector{PetscInt}, fieldI::PetscInt, locX::AbstractPetscVec, locX_t::AbstractPetscVec, t::PetscReal, X_tShift::PetscReal, Jac::AbstractPetscMat, JacP::AbstractPetscMat)

Compute the local boundary Jacobian

Not collective

Input Parameters:

• dm - The output DM
• wf - The PetscWeakForm holding forms on this boundary
• label - The DMLabel indicating what faces should be integrated over
• numValues - The number of label values
• values - The array of label values
• fieldI - The test field for these integrals
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• t - The time
• X_tShift - The multiplier for dF/dxdot

Output Parameters:

• Jac - The local Jacobian
• JacP - The local Jacobian preconditioner

Level: developer

See also: DMPlexComputeBdJacobianSingleByLabel(), DMPlexComputeJacobianByKey(), DMPlexComputeResidualHybridByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeBdJacobianSingle

DMPlexComputeBdJacobianSingleByLabel(petsclib::PetscLibType, dm::AbstractPetscDM, wf::PetscWeakForm, label::DMLabel, numValues::PetscInt, values::Vector{PetscInt}, fieldI::PetscInt, facetIS::AbstractIS, locX::AbstractPetscVec, locX_t::AbstractPetscVec, t::PetscReal, coordField::DMField, X_tShift::PetscReal, Jac::AbstractPetscMat, JacP::AbstractPetscMat)

Compute the local boundary Jacobian for terms matching the input label

Not collective

Input Parameters:

• dm - The output DM
• wf - The PetscWeakForm holding forms on this boundary
• label - The DMLabel indicating what faces should be integrated over
• numValues - The number of label values
• values - The array of label values
• fieldI - The test field for these integrals
• facetIS - The IS giving the set of possible faces to integrate over (intersected with the label)
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• t - The time
• coordField - The DMField object with coordinates for these faces
• X_tShift - The multiplier for dF/dxdot

Output Parameters:

• Jac - The local Jacobian
• JacP - The local Jacobian preconditioner

Level: developer

See also: DMPlexComputeBdJacobianSingle(), DMPlexComputeJacobianByKey(), DMPlexComputeResidualHybridByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeBdJacobianSingleByLabel

DMPlexComputeBdResidualSingle(petsclib::PetscLibType, dm::AbstractPetscDM, wf::PetscWeakForm, key::PetscFormKey, locX::AbstractPetscVec, locX_t::AbstractPetscVec, t::PetscReal, locF::AbstractPetscVec)

Compute the local boundary residual

Not collective

Input Parameters:

• dm - The output DM
• wf - The PetscWeakForm holding forms on this boundary
• key - The PetscFormKey indicating what should be integrated
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• t - The time

Output Parameter:

• locF - The local residual

Level: developer

See also: DMPlexComputeBdResidualSingleByKey(), DMPlexComputeJacobianByKey(), DMPlexComputeResidualHybridByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeBdResidualSingle

DMPlexComputeBdResidualSingleByKey(petsclib::PetscLibType, dm::AbstractPetscDM, wf::PetscWeakForm, key::PetscFormKey, facetIS::AbstractIS, locX::AbstractPetscVec, locX_t::AbstractPetscVec, t::PetscReal, coordField::DMField, locF::AbstractPetscVec)

Compute the local boundary residual for terms matching the input key

Not collective

Input Parameters:

• dm - The output DM
• wf - The PetscWeakForm holding forms on this boundary
• key - The PetscFormKey indicating what should be integrated
• facetIS - The IS giving a set of faces to integrate over
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• t - The time
• coordField - The DMField object with coordinates for these faces

Output Parameter:

• locF - The local residual

Level: developer

See also: DMPlexComputeBdResidualSingle(), DMPlexComputeJacobianByKey(), DMPlexComputeResidualHybridByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeBdResidualSingleByKey

detJ::PetscReal = DMPlexComputeCellGeometryAffineFEM(petsclib::PetscLibType, dm::AbstractPetscDM, cell::PetscInt, v0::Vector{PetscReal}, J::Vector{PetscReal}, invJ::Vector{PetscReal})

Assuming an affine map, compute the Jacobian, inverse Jacobian, and Jacobian determinant for a given cell

Collective

Input Parameters:

• dm - the DMPLEX
• cell - the cell

Output Parameters:

• v0 - the translation part of this affine transform, meaning the translation to the origin (not the first vertex of the reference cell)
• J - the Jacobian of the transform from the reference element
• invJ - the inverse of the Jacobian
• detJ - the Jacobian determinant

Level: advanced

See also: DMPLEX, DMPlexComputeCellGeometryFEM(), DMGetCoordinateSection(), DMGetCoordinates()

External Links

• PETSc Manual: DMPlex/DMPlexComputeCellGeometryAffineFEM

DMPlexComputeCellGeometryFEM(petsclib::PetscLibType, dm::AbstractPetscDM, cell::PetscInt, quad::PetscQuadrature, v::Vector{PetscReal}, J::Vector{PetscReal}, invJ::Vector{PetscReal}, detJ::Vector{PetscReal})

Compute the Jacobian, inverse Jacobian, and Jacobian determinant at each quadrature point in the given cell

Collective

Input Parameters:

• dm - the DMPLEX
• cell - the cell
• quad - the quadrature containing the points in the reference element where the geometry will be evaluated. If quad is NULL, geometry will be

evaluated at the first vertex of the reference element

Output Parameters:

• v - the image of the transformed quadrature points, otherwise the image of the first vertex in the closure of the reference element. This is a

one-dimensional array of size cdim * Nq where cdim is the dimension of the DM coordinate space and Nq is the number of quadrature points

• J - the Jacobian of the transform from the reference element at each quadrature point. This is a one-dimensional array of size Nq * cdim * cdim containing

each Jacobian in column-major order.

• invJ - the inverse of the Jacobian at each quadrature point. This is a one-dimensional array of size Nq * cdim * cdim containing

each inverse Jacobian in column-major order.

• detJ - the Jacobian determinant at each quadrature point. This is a one-dimensional array of size Nq.

Level: advanced

See also: DMPLEX, DMGetCoordinateSection(), DMGetCoordinates()

External Links

• PETSc Manual: DMPlex/DMPlexComputeCellGeometryFEM

vol::PetscReal = DMPlexComputeCellGeometryFVM(petsclib::PetscLibType, dm::AbstractPetscDM, cell::PetscInt, centroid::Vector{PetscReal}, normal::Vector{PetscReal})

Compute the volume for a given cell

Collective

Input Parameters:

• dm - the DMPLEX
• cell - the cell

Output Parameters:

• vol - the cell volume
• centroid - the cell centroid
• normal - the cell normal, if appropriate

Level: advanced

See also: DMPLEX, DMGetCoordinateSection(), DMGetCoordinates()

External Links

• PETSc Manual: DMPlex/DMPlexComputeCellGeometryFVM

DMPlexComputeCellTypes(petsclib::PetscLibType, dm::AbstractPetscDM)

Infer the polytope type of every cell using its dimension and cone size.

Collective

Input Parameter:

• dm - The DMPLEX

Level: developer

See also: DM, DMPLEX, DMPlexCreate(), DMPlexSymmetrize(), DMPlexStratify(), DMGetLabel(), DMCreateLabel()

External Links

• PETSc Manual: DMPlex/DMPlexComputeCellTypes

DMPlexComputeCellwiseIntegralFEM(petsclib::PetscLibType, dm::AbstractPetscDM, X::AbstractPetscVec, F::AbstractPetscVec, ctx::Ptr{Cvoid})

Form the vector of cellwise integrals F from the global input X using pointwise functions specified by the user

Input Parameters:

• dm - The mesh
• X - Global input vector
• ctx - The application context

Output Parameter:

• F - Cellwise integrals for each field

Level: developer

See also: DM, DMPLEX, DMPlexSNESComputeResidualFEM()

External Links

• PETSc Manual: DMPlex/DMPlexComputeCellwiseIntegralFEM

DMPlexComputeClementInterpolant(petsclib::PetscLibType, dm::AbstractPetscDM, locX::AbstractPetscVec, locC::AbstractPetscVec)

This function computes the L2 projection of the cellwise values of a function u onto P1

Collective

Input Parameters:

• dm - The DM
• locX - The coefficient vector u_h

Output Parameter:

• locC - A Vec which holds the Clement interpolant of the function

Level: developer

See also: DM, DMPLEX, DMProjectFunction(), DMComputeL2Diff(), DMPlexComputeL2FieldDiff(), DMComputeL2GradientDiff()

External Links

• PETSc Manual: DMPlex/DMPlexComputeClementInterpolant

cellgeom::PetscVec,facegeom::PetscVec = DMPlexComputeGeometryFVM(petsclib::PetscLibType, dm::AbstractPetscDM)

Computes the cell and face geometry for a finite volume method

Input Parameter:

• dm - The DMPLEX

Output Parameters:

• cellgeom - A Vec of PetscFVCellGeom data
• facegeom - A Vec of PetscFVFaceGeom data

Level: developer

See also: DMPLEX, PetscFVFaceGeom, PetscFVCellGeom

External Links

• PETSc Manual: DMPlex/DMPlexComputeGeometryFVM

DMPlexComputeGradientClementInterpolant(petsclib::PetscLibType, dm::AbstractPetscDM, locX::AbstractPetscVec, locC::AbstractPetscVec)

This function computes the L2 projection of the cellwise gradient of a function u onto P1

Collective

Input Parameters:

• dm - The DM
• locX - The coefficient vector u_h

Output Parameter:

• locC - A Vec which holds the Clement interpolant of the gradient

Level: developer

See also: DM, DMPLEX, DMProjectFunction(), DMComputeL2Diff(), DMPlexComputeL2FieldDiff(), DMComputeL2GradientDiff()

External Links

• PETSc Manual: DMPlex/DMPlexComputeGradientClementInterpolant

dmGrad::PetscDM = DMPlexComputeGradientFVM(petsclib::PetscLibType, dm::AbstractPetscDM, fvm::PetscFV, faceGeometry::AbstractPetscVec, cellGeometry::AbstractPetscVec)

Compute geometric factors for gradient reconstruction, which are stored in the geometry data, and compute layout for gradient data

Collective

Input Parameters:

• dm - The DMPLEX
• fvm - The PetscFV
• cellGeometry - The face geometry from DMPlexComputeCellGeometryFVM()

Input/Output Parameter:

• faceGeometry - The face geometry from DMPlexComputeFaceGeometryFVM(); on output

the geometric factors for gradient calculation are inserted

Output Parameter:

• dmGrad - The DM describing the layout of gradient data

Level: developer

See also: DMPLEX, DMPlexGetFaceGeometryFVM(), DMPlexGetCellGeometryFVM()

External Links

• PETSc Manual: DMPlex/DMPlexComputeGradientFVM

sc::VecScatter = DMPlexComputeInjectorFEM(petsclib::PetscLibType, dmc::AbstractPetscDM, dmf::AbstractPetscDM, ctx::Ptr{Cvoid})

Compute a mapping from coarse unknowns to fine unknowns

Input Parameters:

• dmc - The coarse mesh
• dmf - The fine mesh
• ctx - The application context

Output Parameter:

• sc - The mapping

Level: developer

See also: DM, DMPLEX, DMPlexComputeInterpolatorNested()

External Links

• PETSc Manual: DMPlex/DMPlexComputeInjectorFEM

inj::PetscMat = DMPlexComputeInjectorReferenceTree(petsclib::PetscLibType, refTree::AbstractPetscDM)

Compute the injection matrix from fine to coarse degrees of freedom on the reference tree

Collective

Input Parameter:

• refTree - The reference-tree DMPLEX (see DMPlexCreateDefaultReferenceTree())

Output Parameter:

• inj - The newly created injection Mat mapping fine-space coefficients on the reference tree to their coarse-space counterparts

Level: developer

See also: DM, DMPLEX, DMPlexSetReferenceTree(), DMPlexCreateDefaultReferenceTree(), DMPlexComputeInjectorTree(), DMPlexComputeInterpolatorTree()

External Links

• PETSc Manual: DMPlex/DMPlexComputeInjectorReferenceTree

integral::PetscScalar = DMPlexComputeIntegralFEM(petsclib::PetscLibType, dm::AbstractPetscDM, X::AbstractPetscVec, ctx::Ptr{Cvoid})

Form the integral over the domain from the global input X using pointwise functions specified by the user

Input Parameters:

• dm - The mesh
• X - Global input vector
• ctx - The application context

Output Parameter:

• integral - Integral for each field

Level: developer

See also: DM, DMPLEX, DMPlexSNESComputeResidualFEM()

External Links

• PETSc Manual: DMPlex/DMPlexComputeIntegralFEM

DMPlexComputeInterpolatorGeneral(petsclib::PetscLibType, dmc::AbstractPetscDM, dmf::AbstractPetscDM, In::AbstractPetscMat, ctx::Ptr{Cvoid})

Form the local portion of the interpolation matrix from the coarse DM to a non-nested fine DM.

Input Parameters:

• dmf - The fine mesh
• dmc - The coarse mesh
• ctx - The application context

Output Parameter:

• In - The interpolation matrix

Level: developer

See also: DM, DMPLEX, DMPlexComputeInterpolatorNested()

External Links

• PETSc Manual: DMPlex/DMPlexComputeInterpolatorGeneral

DMPlexComputeInterpolatorNested(petsclib::PetscLibType, dmc::AbstractPetscDM, dmf::AbstractPetscDM, isRefined::PetscBool, In::AbstractPetscMat, ctx::Ptr{Cvoid})

Form the local portion of the interpolation matrix from the coarse DM to a uniformly refined DM.

Input Parameters:

• dmc - The coarse mesh
• dmf - The fine mesh
• isRefined - Flag indicating regular refinement, rather than the same topology
• ctx - The application context

Output Parameter:

• In - The interpolation matrix

Level: developer

See also: DM, DMPLEX, DMPlexComputeInterpolatorGeneral()

External Links

• PETSc Manual: DMPlex/DMPlexComputeInterpolatorNested

DMPlexComputeJacobianActionByKey(petsclib::PetscLibType, dm::AbstractPetscDM, key::PetscFormKey, cellIS::AbstractIS, t::PetscReal, X_tShift::PetscReal, locX::AbstractPetscVec, locX_t::AbstractPetscVec, locY::AbstractPetscVec, locF::AbstractPetscVec, ctx::Ptr{Cvoid})

Compute the local Jacobian for terms matching the input key

Collective

Input Parameters:

• dm - The output DM
• key - The PetscFormKey indicating what should be integrated
• cellIS - The IS give a set of cells to integrate over
• t - The time
• X_tShift - The multiplier for the Jacobian with respect to X_t
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• locY - The local vector acted on by J
• ctx - An optional application context, passed to the pointwise functions

Output Parameter:

• locF - The local residual F = J(X) Y

Level: developer

See also: DMPlexComputeResidualByKey(), DMPlexComputeJacobianByKey(), DMPlexComputeResidualHybridByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeJacobianActionByKey

DMPlexComputeJacobianByKey(petsclib::PetscLibType, dm::AbstractPetscDM, key::PetscFormKey, cellIS::AbstractIS, t::PetscReal, X_tShift::PetscReal, locX::AbstractPetscVec, locX_t::AbstractPetscVec, Jac::AbstractPetscMat, JacP::AbstractPetscMat, ctx::Ptr{Cvoid})

Compute the local Jacobian for terms matching the input key

Collective

Input Parameters:

• dm - The output DM
• key - The PetscFormKey indicating what should be integrated
• cellIS - The IS give a set of cells to integrate over
• t - The time
• X_tShift - The multiplier for the Jacobian with respect to X_t
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• ctx - An optional application context, passed to the pointwise functions

Output Parameters:

• Jac - The local Jacobian
• JacP - The local Jacobian preconditioner

Level: developer

See also: DMPlexComputeResidualByKey(), DMPlexComputeResidualHybridByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeJacobianByKey

DMPlexComputeJacobianByKeyGeneral(petsclib::PetscLibType, dmr::AbstractPetscDM, dmc::AbstractPetscDM, key::PetscFormKey, cellIS::AbstractIS, t::PetscReal, X_tShift::PetscReal, locX::AbstractPetscVec, locX_t::AbstractPetscVec, Jac::AbstractPetscMat, JacP::AbstractPetscMat, ctx::Ptr{Cvoid})

Assemble the Jacobian and its preconditioning matrix over a cell range described by a PetscFormKey for a general (possibly non-square, non-nested) pair of row/column DMs.

Collective

Input Parameters:

• dmr - the row DMPLEX
• dmc - the column DMPLEX
• key - the PetscFormKey selecting the label, value, part, and field for assembly
• cellIS - the IS listing cells to process, or NULL
• t - the current time
• X_tShift - the time-derivative shift used to combine dynamic and static Jacobian contributions
• locX - the local solution vector
• locX_t - the local time-derivative vector, or NULL
• ctx - the application context (unused; kept for API symmetry)

Output Parameters:

• Jac - the assembled Jacobian matrix
• JacP - the assembled matrix from which the preconditioner is constructed

Level: developer

See also: DM, DMPLEX, PetscFormKey, DMPlexComputeJacobianByKey(), DMPlexComputeInterpolatorGeneral()

External Links

• PETSc Manual: DMPlex/DMPlexComputeJacobianByKeyGeneral

DMPlexComputeJacobianHybridByKey(petsclib::PetscLibType, dm::AbstractPetscDM, key::Vector{PetscFormKey}, cellIS::AbstractIS, t::PetscReal, X_tShift::PetscReal, locX::AbstractPetscVec, locX_t::AbstractPetscVec, Jac::AbstractPetscMat, JacP::AbstractPetscMat, ctx::Ptr{Cvoid})

Compute the local Jacobian over hybrid cells for terms matching the input key

Collective

Input Parameters:

• dm - The output DM
• key - The PetscFormKey array (left cell, right cell, cohesive cell) indicating what should be integrated
• cellIS - The IS give a set of cells to integrate over
• t - The time
• X_tShift - The multiplier for the Jacobian with respect to X_t
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• ctx - An optional application context, passed to the pointwise functions

Output Parameters:

• Jac - The local Jacobian
• JacP - The local Jacobian preconditioner

Level: developer

See also: DMPlexComputeResidualByKey(), DMPlexComputeJacobianByKey(), DMPlexComputeResidualHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeJacobianHybridByKey

DMPlexComputeL2DiffLocal(petsclib::PetscLibType, dm::AbstractPetscDM, time::PetscReal, noname::Ptr{Cvoid})

This function computes the L2 difference between a function u and an FEM interpolant solution uh.

Collective

Input Parameters:

• dm - The DM
• time - The time
• funcs - The functions to evaluate for each field component
• ctxs - Optional array of contexts to pass to each function, or NULL.
• localX - The coefficient vector u_h, a local vector

Output Parameter:

• diff - The diff ||u - uh||2

Level: developer

See also: DM, DMPLEX, DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()

External Links

• PETSc Manual: DMPlex/DMPlexComputeL2DiffLocal

DMPlexComputeL2DiffVec(petsclib::PetscLibType, dm::AbstractPetscDM, time::PetscReal, noname::Ptr{Cvoid})

This function computes the cellwise L2 difference between a function u and an FEM interpolant solution uh, and stores it in a Vec.

Collective

Input Parameters:

• dm - The DM
• time - The time
• funcs - The functions to evaluate for each field component: NULL means that component does not contribute to error calculation
• ctxs - Optional array of contexts to pass to each function, or NULL.
• X - The coefficient vector u_h

Output Parameter:

• D - A Vec which holds the difference ||u - uh||2 for each cell

Level: developer

See also: DM, DMPLEX, DMProjectFunction(), DMComputeL2Diff(), DMPlexComputeL2FieldDiff(), DMComputeL2GradientDiff()

External Links

• PETSc Manual: DMPlex/DMPlexComputeL2DiffVec

DMPlexComputeL2FluxDiffVec(petsclib::PetscLibType, u::AbstractPetscVec, f::PetscInt, mu::AbstractPetscVec, mf::PetscInt, eFlux::AbstractPetscVec)

This function computes the integral of the difference between the gradient of field fin u and field mf in mu

Collective

Input Parameters:

• u - The global Vec containing the primal solution
• f - The field number for the potential
• mu - The global Vec containing the mixed solution
• mf - The field number for the flux

Output Parameter:

• eFlux - A global Vec which holds ||\nabla uf - \mu{mf}||

Level: advanced

See also: DM, DMPLEX, DMPlexComputeL2FluxDiffVecLocal(), DMProjectFunction(), DMComputeL2Diff(), DMPlexComputeL2FieldDiff(), DMComputeL2GradientDiff()

External Links

• PETSc Manual: DMPlex/DMPlexComputeL2FluxDiffVec

DMPlexComputeL2FluxDiffVecLocal(petsclib::PetscLibType, lu::AbstractPetscVec, f::PetscInt, lmu::AbstractPetscVec, mf::PetscInt, eFlux::AbstractPetscVec)

This function computes the integral of the difference between the gradient of field fin u and field mf in mu

Collective

Input Parameters:

• lu - The local Vec containing the primal solution
• f - The field number for the potential
• lmu - The local Vec containing the mixed solution
• mf - The field number for the flux

Output Parameter:

• eFlux - A global Vec which holds ||\nabla uf - \mu{mf}||

Level: advanced

See also: DM, DMPLEX, DMPlexComputeL2FluxDiffVec(), DMProjectFunction(), DMComputeL2Diff(), DMPlexComputeL2FieldDiff(), DMComputeL2GradientDiff()

External Links

• PETSc Manual: DMPlex/DMPlexComputeL2FluxDiffVecLocal

DMPlexComputeMassMatrixGeneral(petsclib::PetscLibType, dmc::AbstractPetscDM, dmf::AbstractPetscDM, mass::AbstractPetscMat, ctx::Ptr{Cvoid})

Form the local portion of the mass matrix from the coarse DM to a non-nested fine DM.

Input Parameters:

• dmf - The fine mesh
• dmc - The coarse mesh
• ctx - The application context

Output Parameter:

• mass - The mass matrix

Level: developer

See also: DM, DMPLEX, DMPlexComputeMassMatrixNested(), DMPlexComputeInterpolatorNested(), DMPlexComputeInterpolatorGeneral()

External Links

• PETSc Manual: DMPlex/DMPlexComputeMassMatrixGeneral

DMPlexComputeMassMatrixNested(petsclib::PetscLibType, dmc::AbstractPetscDM, dmf::AbstractPetscDM, mass::AbstractPetscMat, ctx::Ptr{Cvoid})

Form the local portion of the mass matrix from a coarse DM to a nested fine DM.

Collective

Input Parameters:

• dmc - the coarse mesh
• dmf - the fine mesh
• ctx - the application context

Output Parameter:

• mass - the mass matrix

Level: developer

See also: DM, DMPLEX, DMPlexComputeMassMatrixGeneral(), DMPlexComputeInterpolatorNested()

External Links

• PETSc Manual: DMPlex/DMPlexComputeMassMatrixNested

DMPlexComputeMoments(petsclib::PetscLibType, dm::AbstractPetscDM, u::AbstractPetscVec, moments::Vector{PetscReal})

Compute the first three moments for a field

Noncollective

Input Parameters:

• dm - the DMPLEX
• u - the field

Output Parameter:

• moments - the field moments

Level: intermediate

See also: DM, DMPLEX, DMSwarmComputeMoments()

External Links

• PETSc Manual: DMPlex/DMPlexComputeMoments

OrthQual::PetscVec,OrthQualLabel::DMLabel = DMPlexComputeOrthogonalQuality(petsclib::PetscLibType, dm::AbstractPetscDM, fv::PetscFV, atol::PetscReal)

Compute cell-wise orthogonal quality mesh statistic. Optionally tags all cells with orthogonal quality below given tolerance.

Collective

Input Parameters:

• dm - The DMPLEX object
• fv - Optional PetscFV object for pre-computed cell/face centroid information
• atol - [0, 1] Absolute tolerance for tagging cells.

Output Parameters:

• OrthQual - Vec containing orthogonal quality per cell
• OrthQualLabel - DMLabel tagging cells below atol with DM_ADAPT_REFINE

Options Database Keys:

• -dm_plex_orthogonal_quality_label_view - view OrthQualLabel if label is requested. Currently only PETSCVIEWERASCII is supported.
• -dm_plex_orthogonal_quality_vec_view - view OrthQual vector.

Level: intermediate

See also: DM, DMPLEX, DMPlexCheckCellShape(), DMCreateLabel(), PetscFV, DMLabel, Vec

External Links

• PETSc Manual: DMPlex/DMPlexComputeOrthogonalQuality

DMPlexComputeProjection2Dto1D(petsclib::PetscLibType, coords::Vector{PetscScalar}, R::Vector{PetscReal})

Rewrite coordinates to be the 1D projection of the 2D coordinates

Not Collective

Input/Output Parameter:

• coords - The coordinates of a segment, on output the new y-coordinate, and 0 for x, an array of size 4, last two entries are unchanged

Output Parameter:

• R - The rotation which accomplishes the projection, array of size 4

Level: developer

See also: DMPLEX, DMPlexComputeProjection3Dto1D(), DMPlexComputeProjection3Dto2D()

External Links

• PETSc Manual: DMPlex/DMPlexComputeProjection2Dto1D

DMPlexComputeProjection3Dto1D(petsclib::PetscLibType, coords::Vector{PetscScalar}, R::Vector{PetscReal})

Rewrite coordinates to be the 1D projection of the 3D coordinates

Not Collective

Input/Output Parameter:

• coords - The coordinates of a segment; on output, the new y-coordinate, and 0 for x and z, an array of size 6, the other entries are unchanged

Output Parameter:

• R - The rotation which accomplishes the projection, an array of size 9

Level: developer

See also: DMPLEX, DMPlexComputeProjection2Dto1D(), DMPlexComputeProjection3Dto2D()

External Links

• PETSc Manual: DMPlex/DMPlexComputeProjection3Dto1D

DMPlexComputeProjection3Dto2D(petsclib::PetscLibType, coordSize::PetscInt, coords::Vector{PetscScalar}, R::Vector{PetscReal})

Rewrite coordinates of 3 or more coplanar 3D points to a common 2D basis for the plane. The normal is defined by positive orientation of the first 3 points.

Not Collective

Input Parameter:

• coordSize - Length of coordinate array (3x number of points); must be at least 9 (3 points)

Input/Output Parameter:

• coords - The interlaced coordinates of each coplanar 3D point; on output the first

2*coordSize/3 entries contain interlaced 2D points, with the rest undefined

Output Parameter:

• R - 3x3 row-major rotation matrix whose columns are the tangent basis [t1, t2, n]. Multiplying by R^T transforms from original frame to tangent frame.

Level: developer

See also: DMPLEX, DMPlexComputeProjection2Dto1D(), DMPlexComputeProjection3Dto1D()

External Links

• PETSc Manual: DMPlex/DMPlexComputeProjection3Dto2D

DMPlexComputeResidualByKey(petsclib::PetscLibType, dm::AbstractPetscDM, key::PetscFormKey, cellIS::AbstractIS, time::PetscReal, locX::AbstractPetscVec, locX_t::AbstractPetscVec, t::PetscReal, locF::AbstractPetscVec, ctx::Ptr{Cvoid})

Compute the local residual for terms matching the input key

Collective

Input Parameters:

• dm - The output DM
• key - The PetscFormKey indicating what should be integrated
• cellIS - The IS giving a set of cells to integrate over
• time - The time, or PETSC_MIN_REAL to include implicit terms in a time-independent problems
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• t - The time
• ctx - An optional application context, passed to the pointwise functions

Output Parameter:

• locF - The local residual

Level: developer

See also: DMPlexComputeJacobianByKey(), DMPlexComputeResidualHybridByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeResidualByKey

DMPlexComputeResidualHybridByKey(petsclib::PetscLibType, dm::AbstractPetscDM, key::Vector{PetscFormKey}, cellIS::AbstractIS, time::PetscReal, locX::AbstractPetscVec, locX_t::AbstractPetscVec, t::PetscReal, locF::AbstractPetscVec, ctx::Ptr{Cvoid})

Compute the local residual over hybrid cells for terms matching the input key

Collective

Input Parameters:

• dm - The output DM
• key - The PetscFormKey array (left cell, right cell, cohesive cell) indicating what should be integrated
• cellIS - The IS give a set of cells to integrate over
• time - The time, or PETSC_MIN_REAL to include implicit terms in a time-independent problems
• locX - The local solution
• locX_t - The time derivative of the local solution, or NULL for time-independent problems
• t - The time
• ctx - An optional application context, passed to the pointwise functions

Output Parameter:

• locF - The local residual

Level: developer

See also: DMPlexComputeResidualByKey(), DMPlexComputeJacobianByKey(), DMPlexComputeJacobianHybridByKey(), PetscFormKey

External Links

• PETSc Manual: DMPlex/DMPlexComputeResidualHybridByKey

dmSplit::PetscDM = DMPlexConstructCohesiveCells(petsclib::PetscLibType, dm::AbstractPetscDM, label::DMLabel, splitLabel::DMLabel)

Construct cohesive cells which split the face along an internal interface

Collective

Input Parameters:

• dm - The original DM
• label - The DMLabel specifying the boundary faces (this could be auto-generated)

Output Parameters:

• splitLabel - The DMLabel containing the split points, or NULL if no output is desired
• dmSplit - The new DM

Level: developer

See also: DM, DMPLEX, DMCreate(), DMPlexLabelCohesiveComplete()

External Links

• PETSc Manual: DMPlex/DMPlexConstructCohesiveCells

numGhostCells::PetscInt,dmGhosted::PetscDM = DMPlexConstructGhostCells(petsclib::PetscLibType, dm::AbstractPetscDM, labelName::String)

Construct ghost cells which connect to every boundary face

Collective

Input Parameters:

• dm - The original DM
• labelName - The label specifying the boundary faces, or "Face Sets" if this is NULL

Output Parameters:

• numGhostCells - The number of ghost cells added to the DM
• dmGhosted - The new DM

Level: developer

See also: DM, DMPLEX, DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexConstructGhostCells

DMPlexCoordinatesLoad(petsclib::PetscLibType, dm::AbstractPetscDM, viewer::PetscViewer, globalToLocalPointSF::PetscSF)

Loads coordinates into a DMPLEX

Collective

Input Parameters:

• dm - The DM into which the coordinates are loaded
• viewer - The PetscViewer for the saved coordinates
• globalToLocalPointSF - The PetscSF returned by DMPlexTopologyLoad() when loading dm from viewer

Level: advanced

See also: DM, DMPLEX, DMLoad(), DMPlexTopologyLoad(), DMPlexLabelsLoad(), DMView(), PetscViewerHDF5Open(), PetscViewerPushFormat(), PetscSF, PetscViewer

External Links

• PETSc Manual: DMPlex/DMPlexCoordinatesLoad

DMPlexCoordinatesToReference(petsclib::PetscLibType, dm::AbstractPetscDM, cell::PetscInt, numPoints::PetscInt, realCoords::Vector{PetscReal}, refCoords::Vector{PetscReal})

Pull coordinates back from the mesh to the reference element using a single element map.

Not Collective

Input Parameters:

• dm - The mesh, with coordinate maps defined either by a PetscDS for the coordinate DM (see DMGetCoordinateDM()) or

implicitly by the coordinates of the corner vertices of the cell: as an affine map for simplicial elements, or as a multilinear map for tensor-product elements

• cell - the cell whose map is used.
• numPoints - the number of points to locate
• realCoords - (numPoints x coordinate dimension) array of coordinates (see DMGetCoordinateDim())

Output Parameter:

• refCoords - (numPoints x dimension) array of reference coordinates (see DMGetDimension())

Level: intermediate

See also: DMPLEX, DMPlexReferenceToCoordinates()

External Links

• PETSc Manual: DMPlex/DMPlexCoordinatesToReference

DMPlexCoordinatesView(petsclib::PetscLibType, dm::AbstractPetscDM, viewer::PetscViewer)

Saves DMPLEX coordinates into a file

Collective

Input Parameters:

• dm - The DM whose coordinates are to be saved
• viewer - The PetscViewer for saving

Level: advanced

See also: DM, DMPLEX, DMView(), DMPlexTopologyView(), DMPlexLabelsView(), DMPlexCoordinatesLoad(), PetscViewer

External Links

• PETSc Manual: DMPlex/DMPlexCoordinatesView

DMPlexCopyCoordinates(petsclib::PetscLibType, dmA::AbstractPetscDM, dmB::AbstractPetscDM)

Copy coordinates from one mesh to another with the same vertices

Collective

Input Parameter:

• dmA - The DMPLEX object with initial coordinates

Output Parameter:

• dmB - The DMPLEX object with copied coordinates

Level: intermediate

See also: DMPLEX, DMCopyLabels(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection()

External Links

• PETSc Manual: DMPlex/DMPlexCopyCoordinates

mesh::PetscDM = DMPlexCreate(petsclib::PetscLibType, comm::MPI_Comm)

Creates a DMPLEX object, which encapsulates an unstructured mesh, or CW complex, which can be expressed using a Hasse Diagram.

Collective

Input Parameter:

• comm - The communicator for the DMPLEX object

Output Parameter:

• mesh - The DMPLEX object

Level: beginner

See also: DM, DMPLEX, DMType, DMCreate(), DMSetType()

External Links

• PETSc Manual: DMPlex/DMPlexCreate

dm::PetscDM = DMPlexCreateBallMesh(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, R::PetscReal)

Creates a simplex mesh on the d-dimensional ball, B^d.

Collective

Input Parameters:

• comm - The communicator for the DM object
• dim - The dimension
• R - The radius

Output Parameter:

• dm - The DM object

Options Database Key:

• bd_dm_refine - This will refine the surface mesh preserving the sphere geometry

Level: beginner

See also: DM, DMPLEX, DMPlexCreateSphereMesh(), DMPlexCreateBoxMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateBallMesh

DMPlexCreateBasisRotation(petsclib::PetscLibType, dm::AbstractPetscDM, alpha::PetscReal, beta::PetscReal, gamma::PetscReal)

Create an internal transformation from the global basis, used to specify boundary conditions and global solutions, to a local basis, appropriate for discretization integrals and assembly.

Input Parameters:

• dm - The DM
• alpha - The first Euler angle, and in 2D the only one
• beta - The second Euler angle
• gamma - The third Euler angle

Level: developer

See also: DM, DMPLEX, DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis()

External Links

• PETSc Manual: DMPlex/DMPlexCreateBasisRotation

dm::PetscDM = DMPlexCreateBoxMesh(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, simplex::PetscBool, faces::Vector{PetscInt}, lower::Vector{PetscReal}, upper::Vector{PetscReal}, periodicity::Vector{DMBoundaryType}, interpolate::PetscBool, localizationHeight::PetscInt, sparseLocalize::PetscBool)

Creates a mesh on the tensor product of unit intervals (box) using simplices or tensor cells (hexahedra).

Collective

Input Parameters:

• comm - The communicator for the DM object
• dim - The spatial dimension
• simplex - PETSC_TRUE for simplices, PETSC_FALSE for tensor cells
• faces - Number of faces per dimension, or NULL for (1,) in 1D and (2, 2) in 2D and (1, 1, 1) in 3D
• lower - The lower left corner, or NULL for (0, 0, 0)
• upper - The upper right corner, or NULL for (1, 1, 1)
• periodicity - The boundary type for the X,Y,Z direction, or NULL for DM_BOUNDARY_NONE
• interpolate - Flag to create intermediate mesh pieces (edges, faces)
• localizationHeight - Flag to localize edges and faces in addition to cells; only significant for periodic meshes
• sparseLocalize - Flag to localize coordinates only for cells near the periodic boundary; only significant for periodic meshes

Output Parameter:

• dm - The DM object

Level: beginner

See also: DM, DMPLEX, DMSetFromOptions(), DMPlexCreateFromFile(), DMPlexCreateHexCylinderMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateBoxMesh

dm::PetscDM = DMPlexCreateBoxSurfaceMesh(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, faces::Vector{PetscInt}, lower::Vector{PetscReal}, upper::Vector{PetscReal}, interpolate::PetscBool)

Creates a mesh on the surface of the tensor product of unit intervals (box) using tensor cells (hexahedra).

Collective

Input Parameters:

• comm - The communicator for the DM object
• dim - The spatial dimension of the box, so the resulting mesh is has dimension dim-1
• faces - Number of faces per dimension, or NULL for (1,) in 1D and (2, 2) in 2D and (1, 1, 1) in 3D
• lower - The lower left corner, or NULL for (0, 0, 0)
• upper - The upper right corner, or NULL for (1, 1, 1)
• interpolate - Flag to create intermediate mesh pieces (edges, faces)

Output Parameter:

• dm - The DM object

Level: beginner

See also: DM, DMPLEX, DMSetFromOptions(), DMPlexCreateBoxMesh(), DMPlexCreateFromFile(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateBoxSurfaceMesh

dm::PetscDM = DMPlexCreateCGNS(petsclib::PetscLibType, comm::MPI_Comm, cgid::PetscInt, interpolate::PetscBool)

Create a DMPLEX mesh from a CGNS file ID.

Collective

Input Parameters:

• comm - The MPI communicator
• cgid - The CG id associated with a file and obtained using cg_open
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, DMPLEX, DMPlexCreate(), DMPlexCreateExodus()

External Links

• PETSc Manual: DMPlex/DMPlexCreateCGNS

dm::PetscDM = DMPlexCreateCGNSFromFile(petsclib::PetscLibType, comm::MPI_Comm, filename::String, interpolate::PetscBool)

Create a DMPLEX mesh from a CGNS file.

Collective

Input Parameters:

• comm - The MPI communicator
• filename - The name of the CGNS file
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, DMPLEX, DMPlexCreate(), DMPlexCreateCGNS(), DMPlexCreateExodus()

External Links

• PETSc Manual: DMPlex/DMPlexCreateCGNSFromFile

globalCellNumbers::IS = DMPlexCreateCellNumbering(petsclib::PetscLibType, dm::AbstractPetscDM, includeAll::PetscBool)

Get a global cell numbering for all cells on this process

Input Parameters:

• dm - The DMPLEX object
• includeAll - Whether to include all cells, or just the simplex and box cells

Output Parameter:

• globalCellNumbers - Global cell numbers for all cells on this process

Level: developer

See also: DM, DMPLEX, DMPlexGetCellNumbering(), DMPlexGetVertexNumbering()

External Links

• PETSc Manual: DMPlex/DMPlexCreateCellNumbering

DMPlexCreateClosureIndex(petsclib::PetscLibType, dm::AbstractPetscDM, section::PetscSection)

Calculate an index for the given PetscSection for the closure operation on the DM

Not Collective

Input Parameters:

• dm - The DM
• section - The section describing the layout in the local vector, or NULL to use the default section

Level: intermediate

See also: DM, DMPLEX, PetscSection, DMPlexVecGetClosure(), DMPlexVecRestoreClosure(), DMPlexVecSetClosure(), DMPlexMatSetClosure()

External Links

• PETSc Manual: DMPlex/DMPlexCreateClosureIndex

fpointIS::IS = DMPlexCreateCoarsePointIS(petsclib::PetscLibType, dm::AbstractPetscDM)

Creates an IS covering the coarse DM chart with the fine points as data

Collective

Input Parameter:

• dm - The coarse DM

Output Parameter:

• fpointIS - The IS of all the fine points which exist in the original coarse mesh

Level: developer

See also: DM, DMPLEX, IS, DMRefine(), DMPlexSetRefinementUniform(), DMPlexGetSubpointIS()

External Links

• PETSc Manual: DMPlex/DMPlexCreateCoarsePointIS

subdm::PetscDM = DMPlexCreateCohesiveSubmesh(petsclib::PetscLibType, dm::AbstractPetscDM, hasLagrange::PetscBool, label::String, value::PetscInt)

Extract from a mesh with cohesive cells the hypersurface defined by one face of the cells. Optionally, a label can be given to restrict the cells.

Input Parameters:

• dm - The original mesh
• hasLagrange - The mesh has Lagrange unknowns in the cohesive cells
• label - A label name, or NULL
• value - A label value

Output Parameter:

• subdm - The surface mesh

Level: developer

See also: DM, DMPLEX, DMPlexGetSubpointMap(), DMPlexCreateSubmesh()

External Links

• PETSc Manual: DMPlex/DMPlexCreateCohesiveSubmesh

coloring::ISColoring = DMPlexCreateColoring(petsclib::PetscLibType, dm::AbstractPetscDM, depth::PetscInt, distance::PetscInt)

Gets coloring of the connectivity graph of the DMPlex points at a given depth.

Collective

Input Parameters:

• dm - the DMPlex object
• depth - the dimension of the entities in the connectivity graph.
• distance - the distance of the coloring (either 1 or 2).

Output Parameter:

• coloring - the coloring

Level: developer

See also: DMPlex, ISColoring, MatColoring, DMCreateColoring()

External Links

• PETSc Manual: DMPlex/DMPlexCreateColoring

DMPlexCreateCoordinateSpace(petsclib::PetscLibType, dm::AbstractPetscDM, degree::PetscInt, localized::PetscBool, project::PetscBool)

Creates a finite element space for the coordinates

Collective

Input Parameters:

• dm - The DMPLEX
• degree - The degree of the finite element or PETSC_DECIDE
• localized - Flag to create a localized (DG) coordinate space
• project - Flag to project current coordinates into the space

Level: advanced

See also: DM, DMPLEX, PetscPointFn, PetscFECreateLagrange(), DMGetCoordinateDM(), DMPlexSetCoordinateMap()

External Links

• PETSc Manual: DMPlex/DMPlexCreateCoordinateSpace

ref::PetscDM = DMPlexCreateDefaultReferenceTree(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, simplex::PetscBool)

create a reference tree for isotropic hierarchical mesh refinement.

Collective

Input Parameters:

• comm - the MPI communicator
• dim - the spatial dimension
• simplex - Flag for simplex, otherwise use a tensor-product cell

Output Parameter:

• ref - the reference tree DMPLEX object

Level: intermediate

See also: DMPlexSetReferenceTree(), DMPlexGetReferenceTree()

External Links

• PETSc Manual: DMPlex/DMPlexCreateDefaultReferenceTree

newdm::PetscDM = DMPlexCreateDoublet(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, simplex::PetscBool, interpolate::PetscBool, refinementLimit::PetscReal)

Creates a mesh of two cells of the specified type, optionally with later refinement.

Collective

Input Parameters:

• comm - The communicator for the DM object
• dim - The spatial dimension
• simplex - Flag for simplicial cells, otherwise they are tensor product cells
• interpolate - Flag to create intermediate mesh pieces (edges, faces)
• refinementLimit - A nonzero number indicates the largest admissible volume for a refined cell

Output Parameter:

• newdm - The DM object

Level: beginner

See also: DM, DMPLEX, DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateDoublet

globalEdgeNumbers::IS = DMPlexCreateEdgeNumbering(petsclib::PetscLibType, dm::AbstractPetscDM)

Create a global numbering for edges.

Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• globalEdgeNumbers - Global numbers for all edges on this process

Level: developer

See also: DM, DMPLEX, DMPlexGetCellNumbering(), DMPlexGetVertexNumbering(), DMPlexCreatePointNumbering()

External Links

• PETSc Manual: DMPlex/DMPlexCreateEdgeNumbering

dm::PetscDM = DMPlexCreateEphemeral(petsclib::PetscLibType, tr::DMPlexTransform, prefix::String)

This takes a DMPlexTransform and a base DMPlex and produces an ephemeral DM, meaning one that is created on the fly in response to queries.

Input Parameters:

• tr - The DMPlexTransform
• prefix - An options prefix, or NULL

Output Parameter:

• dm - The DM

Level: beginner

See also: DMPlexCreateFromFile, DMPlexCreateFromDAG(), DMPlexCreateFromCellListPetsc(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateEphemeral

dm::PetscDM = DMPlexCreateExodus(petsclib::PetscLibType, comm::MPI_Comm, exoid::PetscExodusIIInt, interpolate::PetscBool)

Create a DMPLEX mesh from an ExodusII file ID.

Collective

Input Parameters:

• comm - The MPI communicator
• exoid - The ExodusII id associated with a exodus file and obtained using ex_open
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, PETSCVIEWEREXODUSII, DMPLEX, DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateExodus

dm::PetscDM = DMPlexCreateExodusFromFile(petsclib::PetscLibType, comm::MPI_Comm, filename::String, interpolate::PetscBool)

Create a DMPLEX mesh from an ExodusII file.

Collective

Input Parameters:

• comm - The MPI communicator
• filename - The name of the ExodusII file
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, PETSCVIEWEREXODUSII, DMPLEX, DMCreate(), DMPlexCreateExodus()

External Links

• PETSc Manual: DMPlex/DMPlexCreateExodusFromFile

dm::PetscDM = DMPlexCreateFluent(petsclib::PetscLibType, comm::MPI_Comm, viewer::PetscViewer, interpolate::PetscBool)

Create a DMPLEX mesh from a Fluent mesh file http://aerojet.engr.ucdavis.edu/fluenthelp/html/ug/node1490.htm.

Collective

Input Parameters:

• comm - The MPI communicator
• viewer - The PetscViewer associated with a Fluent mesh file
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, DMPLEX, DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateFluent

dm::PetscDM = DMPlexCreateFluentFromFile(petsclib::PetscLibType, comm::MPI_Comm, filename::String, interpolate::PetscBool)

Create a DMPLEX mesh from a Fluent mesh file

Collective

Input Parameters:

• comm - The MPI communicator
• filename - Name of the Fluent mesh file
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, DMPLEX, DMPlexCreateFromFile(), DMPlexCreateFluent(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateFluentFromFile

vertexSF::PetscSF,verticesAdj::Ptr{PetscInt},dm::PetscDM = DMPlexCreateFromCellListParallelPetsc(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, numCells::PetscInt, numVertices::PetscInt, NVertices::PetscInt, numCorners::PetscInt, interpolate::PetscBool, cells::Vector{PetscInt}, spaceDim::PetscInt, vertexCoords::Vector{PetscReal})

Create distributed DMPLEX from a list of vertices for each cell (common mesh generator output) where all cells have the same celltype

Collective

Input Parameters:

• comm - The communicator
• dim - The topological dimension of the mesh
• numCells - The number of cells owned by this process
• numVertices - The number of vertices owned by this process, or PETSC_DECIDE
• NVertices - The global number of vertices, or PETSC_DECIDE
• numCorners - The number of vertices for each cell
• interpolate - Flag indicating that intermediate mesh entities (faces, edges) should be created automatically
• cells - An array of numCells*numCorners numbers, the global vertex numbers for each cell
• spaceDim - The spatial dimension used for coordinates
• vertexCoords - An array of numVertices*spaceDim numbers, the coordinates of each vertex

Output Parameters:

• dm - The DM
• vertexSF - (Optional) PetscSF describing complete vertex ownership
• verticesAdj - (Optional) vertex adjacency array, must be freed by user

Level: intermediate

See also: DM, DMPLEX, DMPlexCreateFromCellListPetsc(), DMPlexBuildFromCellListParallel(), DMPlexBuildCoordinatesFromCellListParallel(), DMPlexCreateFromDAG(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateFromCellListParallelPetsc

dm::PetscDM = DMPlexCreateFromCellListPetsc(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, numCells::PetscInt, numVertices::PetscInt, numCorners::PetscInt, interpolate::PetscBool, cells::Vector{PetscInt}, spaceDim::PetscInt, vertexCoords::Vector{PetscReal})

Create DMPLEX from a list of vertices for each cell (common mesh generator output), but only process 0 takes in the input

Collective

Input Parameters:

• comm - The communicator
• dim - The topological dimension of the mesh
• numCells - The number of cells, only on process 0
• numVertices - The number of vertices owned by this process, or PETSC_DECIDE, only on process 0
• numCorners - The number of vertices for each cell, only on process 0
• interpolate - Flag indicating that intermediate mesh entities (faces, edges) should be created automatically
• cells - An array of numCells \times numCorners numbers, the vertices for each cell, only on process 0
• spaceDim - The spatial dimension used for coordinates
• vertexCoords - An array of numVertices \times spaceDim numbers, the coordinates of each vertex, only on process 0

Output Parameter:

• dm - The DM, which only has points on process 0

Level: intermediate

See also: DM, DMPLEX, DMPlexCreateFromCellListParallelPetsc(), DMPlexBuildFromCellList(), DMPlexBuildCoordinatesFromCellList(), DMPlexCreateFromDAG(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateFromCellListPetsc

vertexSF::PetscSF,verticesAdj::Ptr{PetscInt},dm::PetscDM = DMPlexCreateFromCellSectionParallel(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, numCells::PetscInt, numVertices::PetscInt, NVertices::PetscInt, cellSection::PetscSection, interpolate::PetscBool, cells::Vector{PetscInt}, spaceDim::PetscInt, vertexCoords::Vector{PetscReal})

Create distributed DMPLEX from a list of vertices for each cell (common mesh generator output) and supports multiple celltypes

Collective

Input Parameters:

• comm - The communicator
• dim - The topological dimension of the mesh
• numCells - The number of cells owned by this process
• numVertices - The number of vertices owned by this process, or PETSC_DECIDE
• NVertices - The global number of vertices, or PETSC_DECIDE
• cellSection - The PetscSection giving the number of vertices for each cell (layout of cells)
• interpolate - Flag indicating that intermediate mesh entities (faces, edges) should be created automatically
• cells - An array of the global vertex numbers for each cell
• spaceDim - The spatial dimension used for coordinates
• vertexCoords - An array of numVertices*spaceDim numbers, the coordinates of each vertex

Output Parameters:

• dm - The DM
• vertexSF - (Optional) PetscSF describing complete vertex ownership
• verticesAdj - (Optional) vertex adjacency array, must be freed by user

Level: intermediate

See also: DM, DMPLEX, DMPlexCreateFromCellListPetsc(), DMPlexBuildFromCellListParallel(), DMPlexBuildCoordinatesFromCellListParallel(), DMPlexCreateFromDAG(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateFromCellSectionParallel

DMPlexCreateFromDAG(petsclib::PetscLibType, dm::AbstractPetscDM, depth::PetscInt, numPoints::Vector{PetscInt}, coneSize::Vector{PetscInt}, cones::Vector{PetscInt}, coneOrientations::Vector{PetscInt}, vertexCoords::Vector{PetscScalar})

This takes as input the adjacency-list representation of the Directed Acyclic Graph (Hasse Diagram) encoding a mesh, and produces a DM

Input Parameters:

• dm - The empty DM object, usually from DMCreate() and DMSetDimension()
• depth - The depth of the DAG
• numPoints - Array of size depth + 1 containing the number of points at each depth
• coneSize - The cone size of each point
• cones - The concatenation of the cone points for each point, the cone list must be oriented correctly for each point
• coneOrientations - The orientation of each cone point
• vertexCoords - An array of numPoints[0] \times spacedim numbers representing the coordinates of each vertex, with spacedim the value set via DMSetCoordinateDim()

Output Parameter:

• dm - The DM

Level: advanced

See also: DM, DMPLEX, DMPlexCreateFromCellListPetsc(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateFromDAG

dm::PetscDM = DMPlexCreateFromFile(petsclib::PetscLibType, comm::MPI_Comm, filename::String, plexname::String, interpolate::PetscBool)

This takes a filename and produces a DM

Collective

Input Parameters:

• comm - The communicator
• filename - A file name
• plexname - The object name of the resulting DM, also used for intra-datafile lookup by some formats
• interpolate - Flag to create intermediate mesh pieces (edges, faces)

Output Parameter:

• dm - The DM

Options Database Key:

• -dm_plex_create_from_hdf5_xdmf - use the PETSC_VIEWER_HDF5_XDMF format for reading HDF5

Use -dm_plex_create_ prefix to pass options to the internal PetscViewer, e.g. -dm_plex_create_viewer_hdf5_collective

Level: beginner

See also: DM, DMPLEX, DMPlexCreateFromDAG(), DMPlexCreateFromCellListPetsc(), DMPlexCreate(), PetscObjectSetName(), DMView(), DMLoad()

External Links

• PETSc Manual: DMPlex/DMPlexCreateFromFile

dm::PetscDM = DMPlexCreateGeomFromFile(petsclib::PetscLibType, comm::MPI_Comm, filename::String, islite::PetscBool)

Create a DMPLEX mesh from an EGADS, IGES, or STEP file.

Collective

Input Parameters:

• comm - The MPI communicator
• filename - The name of the EGADS, IGES, or STEP file
• islite - Flag for EGADSlite support

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, DMPLEX, DMCreate(), DMPlexCreateEGADS(), DMPlexCreateEGADSliteFromFile()

External Links

• PETSc Manual: DMPlex/DMPlexCreateGeomFromFile

sfNatural::PetscSF = DMPlexCreateGlobalToNaturalSF(petsclib::PetscLibType, dm::AbstractPetscDM, section::PetscSection, sfMigration::PetscSF)

Creates the PetscSF for mapping Global Vec to the Natural Vec

Input Parameters:

• dm - The redistributed DM
• section - The local PetscSection describing the Vec before the mesh was distributed, or NULL if not available
• sfMigration - The PetscSF used to distribute the mesh, or NULL if it cannot be computed

Output Parameter:

• sfNatural - PetscSF for mapping the Vec in PETSc ordering to the canonical ordering

Level: intermediate

See also: DM, DMPLEX, PetscSF, PetscSection, DMPlexDistribute(), DMPlexDistributeField()

External Links

• PETSc Manual: DMPlex/DMPlexCreateGlobalToNaturalSF

dm::PetscDM = DMPlexCreateGmsh(petsclib::PetscLibType, comm::MPI_Comm, viewer::PetscViewer, interpolate::PetscBool)

Create a DMPLEX mesh from a Gmsh file viewer

Collective

Input Parameters:

• comm - The MPI communicator
• viewer - The PetscViewer associated with a Gmsh file
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Options Database Keys:

• -dm_plex_gmsh_hybrid - Force triangular prisms to use tensor order
• -dm_plex_gmsh_periodic - Read Gmsh periodic section and construct a periodic Plex
• -dm_plex_gmsh_highorder - Generate high-order coordinates
• -dm_plex_gmsh_project - Project high-order coordinates to a different space, use the prefix dmplexgmshproject to define the space
• -dm_plex_gmsh_use_generic - Generate generic labels, i.e. Cell Sets, Face Sets, etc.
• -dm_plex_gmsh_use_regions - Generate labels with region names
• -dm_plex_gmsh_mark_vertices - Add vertices to generated labels
• -dm_plex_gmsh_mark_vertices_strict - Add vertices included in a region to generated labels
• -dm_plex_gmsh_multiple_tags - Allow multiple tags for default labels
• -dm_plex_gmsh_spacedim d - Embedding space dimension, if different from topological dimension

Level: beginner

See also: DM, DMPLEX, DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateGmsh

dm::PetscDM = DMPlexCreateGmshFromFile(petsclib::PetscLibType, comm::MPI_Comm, filename::String, interpolate::PetscBool)

Create a DMPLEX mesh from a Gmsh file

Input Parameters:

• comm - The MPI communicator
• filename - Name of the Gmsh file
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DM object representing the mesh

Level: beginner

See also: DM, DMPLEX, DMPlexCreateFromFile(), DMPlexCreateGmsh(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateGmshFromFile

dm::PetscDM = DMPlexCreateHexCylinderMesh(petsclib::PetscLibType, comm::MPI_Comm, periodicZ::DMBoundaryType, Nr::PetscInt)

Creates a mesh on the tensor product of the unit interval with the circle (cylinder) using hexahedra.

Collective

Input Parameters:

• comm - The communicator for the DM object
• periodicZ - The boundary type for the Z direction
• Nr - The number of refinements to carry out

Output Parameter:

• dm - The DM object

Level: beginner

See also: DM, DMPLEX, DMPlexCreateBoxMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateHexCylinderMesh

hybridLabel::DMLabel,splitLabel::DMLabel,dmInterface::PetscDM,dmHybrid::PetscDM = DMPlexCreateHybridMesh(petsclib::PetscLibType, dm::AbstractPetscDM, label::DMLabel, bdlabel::DMLabel, bdvalue::PetscInt)

Create a mesh with hybrid cells along an internal interface

Collective

Input Parameters:

• dm - The original DM
• label - The label specifying the interface vertices
• bdlabel - The optional label specifying the interface boundary vertices
• bdvalue - Value of optional label specifying the interface boundary vertices

Output Parameters:

• hybridLabel - The label fully marking the interface, or NULL if no output is desired
• splitLabel - The label containing the split points, or NULL if no output is desired
• dmInterface - The new interface DM, or NULL
• dmHybrid - The new DM with cohesive cells

Level: developer

See also: DM, DMPLEX, DMPlexConstructCohesiveCells(), DMPlexLabelCohesiveComplete(), DMPlexGetSubpointMap(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateHybridMesh

dm::PetscDM = DMPlexCreateHypercubicMesh(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, edges::Vector{PetscInt}, lower::Vector{PetscReal}, upper::Vector{PetscReal}, overlap::PetscInt)

Creates a periodic mesh on the tensor product of unit intervals using only vertices and edges.

Collective

Input Parameters:

• comm - The communicator for the DM object
• dim - The spatial dimension
• edges - Number of edges per dimension, or NULL for (1,) in 1D and (2, 2) in 2D and (1, 1, 1) in 3D
• lower - The lower left corner, or NULL for (0, 0, 0)
• upper - The upper right corner, or NULL for (1, 1, 1)
• overlap - The number of vertices in each direction to include in the overlap (default is 1)

Output Parameter:

• dm - The DM object

Level: beginner

See also: DMSetFromOptions(), DMPlexCreateFromFile(), DMPlexCreateHexCylinderMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateHypercubicMesh

val::PetscVec = DMPlexCreateLabelField(petsclib::PetscLibType, dm::AbstractPetscDM, label::DMLabel)

Create a field whose value is the label value for that point

Input Parameters:

• dm - The DMPLEX
• label - The DMLabel

Output Parameter:

• val - The label value field

Options Database Key:

• -dm_label_view - Adds the label value field into the DM output from -dm_view using the same viewer

Level: intermediate

See also: DM, DMPLEX, DMView()

External Links

• PETSc Manual: DMPlex/DMPlexCreateLabelField

nv::PetscVec = DMPlexCreateNaturalVector(petsclib::PetscLibType, dm::AbstractPetscDM)

Provide a Vec capable of holding the natural ordering and distribution.

Collective

Input Parameter:

• dm - The distributed DMPLEX

Output Parameter:

• nv - The natural Vec

Level: intermediate

See also: DM, DMPLEX, Vec, DMPlexDistribute(), DMPlexNaturalToGlobalBegin(), DMPlexGlobalToNaturalBegin()

External Links

• PETSc Manual: DMPlex/DMPlexCreateNaturalVector

numVertices::PetscInt,offsets::Ptr{PetscInt},adjacency::Ptr{PetscInt} = DMPlexCreateNeighborCSR(petsclib::PetscLibType, dm::AbstractPetscDM, cellHeight::PetscInt)

Create a mesh graph (cell-cell adjacency) in parallel CSR format.

Collective

Input Parameters:

• dm - The DMPLEX
• cellHeight - The height of mesh points to treat as cells (default should be 0)

Output Parameters:

• numVertices - The number of local vertices in the graph, or cells in the mesh.
• offsets - The offset to the adjacency list for each cell
• adjacency - The adjacency list for all cells

Level: advanced

See also: DM, DMPLEX, DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateNeighborCSR

ovLabel::DMLabel = DMPlexCreateOverlapLabel(petsclib::PetscLibType, dm::AbstractPetscDM, levels::PetscInt, rootSection::PetscSection, rootrank::AbstractIS, leafSection::PetscSection, leafrank::AbstractIS)

Compute a label indicating what overlap points should be sent to new processes

Collective

Input Parameters:

• dm - The DM
• levels - Number of overlap levels
• rootSection - The number of leaves for a given root point
• rootrank - The rank of each edge into the root point
• leafSection - The number of processes sharing a given leaf point
• leafrank - The rank of each process sharing a leaf point

Output Parameter:

• ovLabel - DMLabel containing remote overlap contributions as point/rank pairings

Level: developer

See also: DMPLEX, DMPlexCreateOverlapLabelFromLabels(), DMPlexGetAdjacency(), DMPlexDistributeOwnership(), DMPlexDistribute()

External Links

• PETSc Manual: DMPlex/DMPlexCreateOverlapLabel

ovLabel::DMLabel = DMPlexCreateOverlapLabelFromLabels(petsclib::PetscLibType, dm::AbstractPetscDM, numLabels::PetscInt, label::Vector{DMLabel}, value::Vector{PetscInt}, numExLabels::PetscInt, exLabel::Vector{DMLabel}, exValue::Vector{PetscInt}, rootSection::PetscSection, rootrank::AbstractIS, leafSection::PetscSection, leafrank::AbstractIS)

Compute a label indicating what overlap points should be sent to new processes

Collective

Input Parameters:

• dm - The DM
• numLabels - The number of labels to draw candidate points from
• label - An array of labels containing candidate points
• value - An array of label values marking the candidate points
• numExLabels - The number of labels to use for exclusion
• exLabel - An array of labels indicating points to be excluded, or NULL
• exValue - An array of label values to be excluded, or NULL
• rootSection - The number of leaves for a given root point
• rootrank - The rank of each edge into the root point
• leafSection - The number of processes sharing a given leaf point
• leafrank - The rank of each process sharing a leaf point

Output Parameter:

• ovLabel - DMLabel containing remote overlap contributions as point/rank pairings

Level: developer

See also: DMPLEX, DMPlexCreateOverlapLabel(), DMPlexGetAdjacency(), DMPlexDistributeOwnership(), DMPlexDistribute()

External Links

• PETSc Manual: DMPlex/DMPlexCreateOverlapLabelFromLabels

migrationSF::PetscSF = DMPlexCreateOverlapMigrationSF(petsclib::PetscLibType, dm::AbstractPetscDM, overlapSF::PetscSF)

Create a PetscSF describing the new mesh distribution to make the overlap described by the input PetscSF

Collective

Input Parameters:

• dm - The DM
• overlapSF - The PetscSF mapping ghost points in overlap to owner points on other processes

Output Parameter:

• migrationSF - A PetscSF that maps original points in old locations to points in new locations

Level: developer

See also: DMPLEX, DMPlexCreateOverlapLabel(), DMPlexDistributeOverlap(), DMPlexDistribute()

External Links

• PETSc Manual: DMPlex/DMPlexCreateOverlapMigrationSF

dm::PetscDM = DMPlexCreatePLYFromFile(petsclib::PetscLibType, comm::MPI_Comm, filename::String, interpolate::PetscBool)

Create a DMPLEX mesh from a PLY https://en.wikipedia.org/wiki/PLY_(file_format) file.

Input Parameters:

• comm - The MPI communicator
• filename - Name of the .ply file
• interpolate - Create faces and edges in the mesh

Output Parameter:

• dm - The DMPLEX object representing the mesh

Level: beginner

See also: DMPlexCreateFromFile(), DMPlexCreateGmsh(), DMPlexCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreatePLYFromFile

numVertices::PetscInt,offsets::Ptr{PetscInt},adjacency::Ptr{PetscInt},globalNumbering::IS = DMPlexCreatePartitionerGraph(petsclib::PetscLibType, dm::AbstractPetscDM, height::PetscInt)

Create a CSR graph of point connections for the partitioner

Collective

Input Parameters:

• dm - The mesh DM
• height - Height of the strata from which to construct the graph

Output Parameters:

• numVertices - Number of vertices in the graph
• offsets - Point offsets in the graph
• adjacency - Point connectivity in the graph
• globalNumbering - A map from the local cell numbering to the global numbering used in "adjacency". Negative indicates that the cell is a duplicate from another process.

Options Database Key:

• -dm_plex_csr_alg (mat|graph|overlap) - Choose the algorithm for computing the CSR graph

Level: developer

See also: DM, DMPLEX, DMPlexCSRAlgorithm, PetscPartitionerGetType(), PetscPartitionerCreate(), DMSetAdjacency()

External Links

• PETSc Manual: DMPlex/DMPlexCreatePartitionerGraph

globalPointNumbers::IS = DMPlexCreatePointNumbering(petsclib::PetscLibType, dm::AbstractPetscDM)

Create a global numbering for all points.

Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• globalPointNumbers - Global numbers for all points on this process

Level: developer

See also: DM, DMPLEX, DMPlexGetCellNumbering()

External Links

• PETSc Manual: DMPlex/DMPlexCreatePointNumbering

pointSF::PetscSF = DMPlexCreatePointSF(petsclib::PetscLibType, dm::AbstractPetscDM, migrationSF::PetscSF, ownership::PetscBool)

Build a point PetscSF from an PetscSF describing a point migration

Input Parameters:

• dm - The source DMPLEX object
• migrationSF - The star forest that describes the parallel point remapping
• ownership - Flag causing a vote to determine point ownership

Output Parameter:

• pointSF - The star forest describing the point overlap in the remapped DM

Level: developer

See also: DMPLEX, PetscSF, DM, DMPlexDistribute(), DMPlexDistributeOverlap()

External Links

• PETSc Manual: DMPlex/DMPlexCreatePointSF

processRanks::IS,sfProcess::PetscSF = DMPlexCreateProcessSF(petsclib::PetscLibType, dm::AbstractPetscDM, sfPoint::PetscSF)

Create an PetscSF which just has process connectivity

Collective

Input Parameters:

• dm - The DM
• sfPoint - The PetscSF which encodes point connectivity

Output Parameters:

• processRanks - A list of process neighbors, or NULL
• sfProcess - An PetscSF encoding the process connectivity, or NULL

Level: developer

See also: DM, DMPLEX, PetscSF, PetscSFCreate(), DMPlexCreateTwoSidedProcessSF()

External Links

• PETSc Manual: DMPlex/DMPlexCreateProcessSF

ranks::PetscVec = DMPlexCreateRankField(petsclib::PetscLibType, dm::AbstractPetscDM)

Create a cell field whose value is the rank of the owner

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• ranks - The rank field

Options Database Key:

• -dm_partition_view - Adds the rank field into the DM output from -dm_view using the same viewer

Level: intermediate

See also: DM, DMPLEX, DMView()

External Links

• PETSc Manual: DMPlex/DMPlexCreateRankField

refdm::PetscDM = DMPlexCreateReferenceCell(petsclib::PetscLibType, comm::MPI_Comm, ct::DMPolytopeType)

Create a DMPLEX with the appropriate FEM reference cell

Collective

Input Parameters:

• comm - The communicator
• ct - The cell type of the reference cell

Output Parameter:

• refdm - The reference cell

Level: intermediate

See also: DM, DMPLEX, DMPlexCreateBoxMesh()

External Links

• PETSc Manual: DMPlex/DMPlexCreateReferenceCell

sp::MatNullSpace = DMPlexCreateRigidBodies(petsclib::PetscLibType, dm::AbstractPetscDM, nb::PetscInt, label::DMLabel, nids::Vector{PetscInt}, ids::Vector{PetscInt})

For the default global section, create rigid body modes by function space interpolation

Collective

Input Parameters:

• dm - the DM
• nb - The number of bodies
• label - The DMLabel marking each domain
• nids - The number of ids per body
• ids - An array of the label ids in sequence for each domain

Output Parameter:

• sp - the null space

Level: advanced

See also: DM, DMPLEX, MatNullSpaceCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateRigidBodies

sp::MatNullSpace = DMPlexCreateRigidBody(petsclib::PetscLibType, dm::AbstractPetscDM, field::PetscInt)

For the default global section, create rigid body modes by function space interpolation

Collective

Input Parameters:

• dm - the DM
• field - The field number for the rigid body space, or 0 for the default

Output Parameter:

• sp - the null space

Level: advanced

See also: DM, DMPLEX, MatNullSpaceCreate(), PCGAMG

External Links

• PETSc Manual: DMPlex/DMPlexCreateRigidBody

section::PetscSection = DMPlexCreateSection(petsclib::PetscLibType, dm::AbstractPetscDM, label::Vector{DMLabel}, numComp::Vector{PetscInt}, numDof::Vector{PetscInt}, numBC::PetscInt, bcField::Vector{PetscInt}, bcComps::Vector{<:AbstractIS}, bcPoints::Vector{<:AbstractIS}, perm::AbstractIS)

Create a PetscSection based upon the dof layout specification provided.

Not Collective

Input Parameters:

• dm - The DMPLEX object
• label - An array of DMLabel of length numFields indicating the mesh support of each field, or NULL for the whole mesh
• numComp - An array of size numFields that holds the number of components for each field
• numDof - An array of size numFields \time (dim+1) which holds the number of dof for each field on a mesh piece of dimension d
• numBC - The number of boundary conditions
• bcField - An array of size numBC giving the field number for each boundary condition
• bcComps - [Optional] An array of size numBC of IS holding the field components to which each boundary condition applies
• bcPoints - An array of size numBC of IS holding the DMPLEX points to which each boundary condition applies
• perm - Optional permutation of the chart, or NULL

Output Parameter:

• section - The PetscSection object

Level: developer

See also: DM, DMPLEX, DMPlexCreate(), PetscSectionCreate(), PetscSectionSetPermutation()

External Links

• PETSc Manual: DMPlex/DMPlexCreateSection

dm::PetscDM = DMPlexCreateSphereMesh(petsclib::PetscLibType, comm::MPI_Comm, dim::PetscInt, simplex::PetscBool, R::PetscReal)

Creates a mesh on the d-dimensional sphere, S^d.

Collective

Input Parameters:

• comm - The communicator for the DM object
• dim - The dimension
• simplex - Use simplices, or tensor product cells
• R - The radius

Output Parameter:

• dm - The DM object

Level: beginner

See also: DM, DMPLEX, DMPlexCreateBallMesh(), DMPlexCreateBoxMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateSphereMesh

subdm::PetscDM = DMPlexCreateSubmesh(petsclib::PetscLibType, dm::AbstractPetscDM, vertexLabel::DMLabel, value::PetscInt, markedFaces::PetscBool)

Extract a hypersurface from the mesh using vertices defined by a label

Input Parameters:

• dm - The original mesh
• vertexLabel - The DMLabel marking points contained in the surface
• value - The label value to use
• markedFaces - PETSC_TRUE if surface faces are marked in addition to vertices, PETSC_FALSE if only vertices are marked

Output Parameter:

• subdm - The surface mesh

Level: developer

See also: DM, DMPLEX, DMPlexGetSubpointMap(), DMGetLabel(), DMLabelSetValue()

External Links

• PETSc Manual: DMPlex/DMPlexCreateSubmesh

dm::PetscDM = DMPlexCreateTPSMesh(petsclib::PetscLibType, comm::MPI_Comm, tpstype::DMPlexTPSType, extent::Vector{PetscInt}, periodic::Vector{DMBoundaryType}, tps_distribute::PetscBool, refinements::PetscInt, layers::PetscInt, thickness::PetscReal)

Create a distributed, interpolated mesh of a triply-periodic surface

Collective

Input Parameters:

• comm - The communicator for the DM object
• tpstype - Type of triply-periodic surface
• extent - Array of length 3 containing number of periods in each direction
• periodic - array of length 3 with periodicity, or NULL for non-periodic
• tps_distribute - Distribute 2D manifold mesh prior to refinement and extrusion (more scalable)
• refinements - Number of factor-of-2 refinements of 2D manifold mesh
• layers - Number of cell layers extruded in normal direction
• thickness - Thickness in normal direction

Output Parameter:

• dm - The DM object

Level: beginner

See also: DM, DMPLEX, DMPlexCreateSphereMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateTPSMesh

processRanks::IS,sfProcess::PetscSF = DMPlexCreateTwoSidedProcessSF(petsclib::PetscLibType, dm::AbstractPetscDM, sfPoint::PetscSF, rootRankSection::PetscSection, rootRanks::AbstractIS, leafRankSection::PetscSection, leafRanks::AbstractIS)

Create an PetscSF which just has process connectivity

Collective

Input Parameters:

• dm - The DM
• sfPoint - The PetscSF which encodes point connectivity
• rootRankSection - to be documented
• rootRanks - to be documented
• leafRankSection - to be documented
• leafRanks - to be documented

Output Parameters:

• processRanks - A list of process neighbors, or NULL
• sfProcess - An PetscSF encoding the two-sided process connectivity, or NULL

Level: developer

See also: DMPLEX, PetscSFCreate(), DMPlexCreateProcessSF()

External Links

• PETSc Manual: DMPlex/DMPlexCreateTwoSidedProcessSF

dm::PetscDM = DMPlexCreateWedgeBoxMesh(petsclib::PetscLibType, comm::MPI_Comm, faces::Vector{PetscInt}, lower::Vector{PetscReal}, upper::Vector{PetscReal}, periodicity::Vector{DMBoundaryType}, orderHeight::PetscBool, interpolate::PetscBool)

Creates a 3-D mesh tessellating the (x,y) plane and extruding in the third direction using wedge cells.

Collective

Input Parameters:

• comm - The communicator for the DM object
• faces - Number of faces per dimension, or NULL for (1, 1, 1)
• lower - The lower left corner, or NULL for (0, 0, 0)
• upper - The upper right corner, or NULL for (1, 1, 1)
• periodicity - The boundary type for the X,Y,Z direction, or NULL for DM_BOUNDARY_NONE
• orderHeight - If PETSC_TRUE, orders the extruded cells in the height first. Otherwise, orders the cell on the layers first
• interpolate - Flag to create intermediate mesh pieces (edges, faces)

Output Parameter:

• dm - The DM object

Level: beginner

See also: DM, DMPLEX, DMPlexCreateHexCylinderMesh(), DMPlexCreateWedgeCylinderMesh(), DMExtrude(), DMPlexCreateBoxMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateWedgeBoxMesh

dm::PetscDM = DMPlexCreateWedgeCylinderMesh(petsclib::PetscLibType, comm::MPI_Comm, n::PetscInt, interpolate::PetscBool)

Creates a mesh on the tensor product of the unit interval with the circle (cylinder) using wedges.

Collective

Input Parameters:

• comm - The communicator for the DM object
• n - The number of wedges around the origin
• interpolate - Create edges and faces

Output Parameter:

• dm - The DM object

Level: beginner

See also: DM, DMPLEX, DMPlexCreateHexCylinderMesh(), DMPlexCreateBoxMesh(), DMSetType(), DMCreate()

External Links

• PETSc Manual: DMPlex/DMPlexCreateWedgeCylinderMesh

sf::PetscSF,dmParallel::PetscDM = DMPlexDistribute(petsclib::PetscLibType, dm::AbstractPetscDM, overlap::PetscInt)

Distributes the mesh and any associated sections.

Collective

Input Parameters:

• dm - The original DMPLEX object
• overlap - The overlap of partitions, 0 is the default

Output Parameters:

• sf - The PetscSF used for point distribution, or NULL if not needed
• dmParallel - The distributed DMPLEX object

Level: intermediate

See also: DMPLEX, DM, DMPlexCreate(), DMSetAdjacency(), DMPlexGetOverlap()

External Links

• PETSc Manual: DMPlex/DMPlexDistribute

DMPlexDistributeField(petsclib::PetscLibType, dm::AbstractPetscDM, pointSF::PetscSF, originalSection::PetscSection, originalVec::AbstractPetscVec, newSection::PetscSection, newVec::AbstractPetscVec)

Distribute field data to match a given PetscSF, usually the PetscSF from mesh distribution

Collective

Input Parameters:

• dm - The DMPLEX object
• pointSF - The PetscSF describing the communication pattern
• originalSection - The PetscSection for existing data layout
• originalVec - The existing data in a local vector

Output Parameters:

• newSection - The PetscSF describing the new data layout
• newVec - The new data in a local vector

Level: developer

See also: DMPLEX, DMPlexDistribute(), DMPlexDistributeFieldIS(), DMPlexDistributeData(), PetscSectionMigrateData()

External Links

• PETSc Manual: DMPlex/DMPlexDistributeField

newIS::IS = DMPlexDistributeFieldIS(petsclib::PetscLibType, dm::AbstractPetscDM, pointSF::PetscSF, originalSection::PetscSection, originalIS::AbstractIS, newSection::PetscSection)

Distribute field data to match a given PetscSF, usually the PetscSF from mesh distribution

Collective

Input Parameters:

• dm - The DMPLEX object
• pointSF - The PetscSF describing the communication pattern
• originalSection - The PetscSection for existing data layout
• originalIS - The existing data

Output Parameters:

• newSection - The PetscSF describing the new data layout
• newIS - The new data

Level: developer

See also: DMPLEX, DMPlexDistribute(), DMPlexDistributeField(), DMPlexDistributeData(), PetscSectionMigrateData()

External Links

• PETSc Manual: DMPlex/DMPlexDistributeFieldIS

dist::PetscBool = DMPlexDistributeGetDefault(petsclib::PetscLibType, dm::AbstractPetscDM)

Get flag indicating whether the DM should be distributed by default

Not Collective

Input Parameter:

• dm - The DM

Output Parameter:

• dist - Flag for distribution

Level: intermediate

See also: DMPLEX, DM, DMPlexDistributeSetDefault(), DMPlexDistribute()

External Links

• PETSc Manual: DMPlex/DMPlexDistributeGetDefault

sf::PetscSF,dmOverlap::PetscDM = DMPlexDistributeOverlap(petsclib::PetscLibType, dm::AbstractPetscDM, overlap::PetscInt)

Add partition overlap to a distributed non-overlapping DM.

Collective

Input Parameters:

• dm - The non-overlapping distributed DMPLEX object
• overlap - The overlap of partitions (the same on all ranks)

Output Parameters:

• sf - The PetscSF used for point distribution, or pass NULL if not needed
• dmOverlap - The overlapping distributed DMPLEX object

Options Database Keys:

• -dm_plex_overlap_labels name1,name2,... - List of overlap label names
• -dm_plex_overlap_values int1,int2,... - List of overlap label values
• -dm_plex_overlap_exclude_label label - Label used to exclude points from overlap
• -dm_plex_overlap_exclude_value value - Label value used to exclude points from overlap

Level: advanced

See also: DMPLEX, PetscSF, DM, DMPlexCreate(), DMSetAdjacency(), DMPlexDistribute(), DMPlexCreateOverlapLabel(), DMPlexGetOverlap()

External Links

• PETSc Manual: DMPlex/DMPlexDistributeOverlap

rootrank::IS,leafrank::IS = DMPlexDistributeOwnership(petsclib::PetscLibType, dm::AbstractPetscDM, rootSection::PetscSection, leafSection::PetscSection)

Compute owner information for shared points. This basically gets two-sided for an SF.

Collective

Input Parameter:

• dm - The DM

Output Parameters:

• rootSection - The number of leaves for a given root point
• rootrank - The rank of each edge into the root point
• leafSection - The number of processes sharing a given leaf point
• leafrank - The rank of each process sharing a leaf point

Level: developer

See also: DMPLEX, DMPlexCreateOverlapLabel(), DMPlexDistribute(), DMPlexDistributeOverlap()

External Links

• PETSc Manual: DMPlex/DMPlexDistributeOwnership

DMPlexDistributeSetDefault(petsclib::PetscLibType, dm::AbstractPetscDM, dist::PetscBool)

Set flag indicating whether the DM should be distributed by default

Logically Collective

Input Parameters:

• dm - The DM
• dist - Flag for distribution

Level: intermediate

See also: DMPLEX, DMPlexDistributeGetDefault(), DMPlexDistribute()

External Links

• PETSc Manual: DMPlex/DMPlexDistributeSetDefault

name::String = DMPlexDistributionGetName(petsclib::PetscLibType, dm::AbstractPetscDM)

Retrieve the name of the specific parallel distribution

Input Parameter:

• dm - The DM

Output Parameter:

• name - The name of the specific parallel distribution

Level: developer

See also: DMPLEX, DMPlexDistributionSetName(), DMPlexTopologyView(), DMPlexTopologyLoad()

External Links

• PETSc Manual: DMPlex/DMPlexDistributionGetName

DMPlexDistributionSetName(petsclib::PetscLibType, dm::AbstractPetscDM, name::String)

Set the name of the specific parallel distribution

Input Parameters:

• dm - The DM
• name - The name of the specific parallel distribution

Level: developer

See also: DMPLEX, DMPlexDistributionGetName(), DMPlexTopologyView(), DMPlexTopologyLoad()

External Links

• PETSc Manual: DMPlex/DMPlexDistributionSetName

equal::PetscBool = DMPlexEqual(petsclib::PetscLibType, dmA::AbstractPetscDM, dmB::AbstractPetscDM)

Determine if two DM have the same topology

Not Collective

Input Parameters:

• dmA - A DMPLEX object
• dmB - A DMPLEX object

Output Parameter:

• equal - PETSC_TRUE if the topologies are identical

Level: intermediate

See also: DM, DMPLEX, DMPlexGetCone()

External Links

• PETSc Manual: DMPlex/DMPlexEqual

edm::PetscDM = DMPlexExtrude(petsclib::PetscLibType, dm::AbstractPetscDM, layers::PetscInt, thickness::PetscReal, tensor::PetscBool, symmetric::PetscBool, periodic::PetscBool, normal::Vector{PetscReal}, thicknesses::Vector{PetscReal}, activeLabel::DMLabel)

Extrude a volumetric mesh from the input surface mesh

Input Parameters:

• dm - The surface mesh
• layers - The number of extruded layers
• thickness - The total thickness of the extruded layers, or PETSC_DETERMINE
• tensor - Flag to create tensor product cells
• symmetric - Flag to extrude symmetrically about the surface
• periodic - Flag to extrude periodically
• normal - Surface normal vector, or NULL
• thicknesses - Thickness of each layer, or NULL
• activeLabel - DMLabel to extrude from, or NULL to extrude entire mesh

Output Parameter:

• edm - The volumetric mesh

Options Database Keys:

• -dm_plex_transform_extrude_thickness t - The total thickness of extruded layers
• -dm_plex_transform_extrude_use_tensor (true|false) - Use tensor cells when extruding
• -dm_plex_transform_extrude_symmetric (true|false) - Extrude layers symmetrically about the surface
• -dm_plex_transform_extrude_periodic (true|false) - Extrude layers periodically
• -dm_plex_transform_extrude_normal n0,...,nd - Specify the extrusion direction
• -dm_plex_transform_extrude_thicknesses t0,...,tl - Specify thickness of each layer

Level: intermediate

See also: DM, DMPLEX, DMExtrude(), DMPlexTransform, DMPlexTransformExtrudeSetThickness(), DMPlexTransformExtrudeSetTensor()

External Links

• PETSc Manual: DMPlex/DMPlexExtrude

ownershipTransferSF::PetscSF,subdm::PetscDM = DMPlexFilter(petsclib::PetscLibType, dm::AbstractPetscDM, cellLabel::DMLabel, value::PetscInt, ignoreLabelHalo::PetscBool, sanitizeSubmesh::PetscBool, comm::MPI_Comm)

Extract a subset of mesh cells defined by a label as a separate mesh

Input Parameters:

• dm - The original mesh
• cellLabel - The DMLabel marking cells contained in the new mesh
• value - The label value to use
• ignoreLabelHalo - The flag indicating if labeled points that are in the halo are ignored
• sanitizeSubmesh - The flag indicating if a subpoint is forced to be owned by a rank that owns a subcell that contains that point in its closure
• comm - The communicator you want the mesh on (currently supports only a sequential communicator or the same communicator of the original mesh)

Output Parameters:

• ownershipTransferSF - The PetscSF representing the ownership transfers between parent local meshes due to submeshing.
• subdm - The new mesh

Level: developer

See also: DM, DMPLEX, DMPlexGetSubpointMap(), DMGetLabel(), DMLabelSetValue(), DMPlexCreateSubmesh()

External Links

• PETSc Manual: DMPlex/DMPlexFilter

points::IS = DMPlexFindVertices(petsclib::PetscLibType, dm::AbstractPetscDM, coordinates::AbstractPetscVec, eps::PetscReal)

Try to find DAG points based on their coordinates.

Not Collective (provided DMGetCoordinatesLocalSetUp() has been already called)

Input Parameters:

• dm - The DMPLEX object
• coordinates - The Vec of coordinates of the sought points
• eps - The tolerance or PETSC_DEFAULT

Output Parameter:

• points - The IS of found DAG points or -1

Level: intermediate

See also: DMPLEX, DMPlexCreate(), DMGetCoordinatesLocal()

External Links

• PETSc Manual: DMPlex/DMPlexFindVertices

DMPlexFreeGeomObject(petsclib::PetscLibType, dm::AbstractPetscDM, geomObj::PetscGeom)

Frees PetscGeom Objects

Not collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• geomObj - PetscGeom object

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexFreeGeomObject

mesh::PetscDM = DMPlexGenerate(petsclib::PetscLibType, boundary::AbstractPetscDM, name::String, interpolate::PetscBool)

Generates a mesh.

Not Collective

Input Parameters:

• boundary - The DMPLEX boundary object
• name - The mesh generation package name
• interpolate - Flag to create intermediate mesh elements

Output Parameter:

• mesh - The DMPLEX object

Options Database Keys:

• -dm_plex_generate name - package to generate mesh, for example, triangle, ctetgen or tetgen
• -dm_generator name - package to generate mesh, for example, triangle, ctetgen or tetgen

Level: intermediate

See also: DM, DMPLEX, DMPlexCreate(), DMRefine()

External Links

• PETSc Manual: DMPlex/DMPlexGenerate

DMPlexGeomDataAndGrads(petsclib::PetscLibType, dm::AbstractPetscDM, fullGeomGrad::PetscBool)

Exposes Control Points and Control Point Weights defining the underlying geometry allowing user manipulation of the geometry.

Collective

Input Parameters:

• dm - The DM object representing the mesh with PetscContainer containing an EGADS geometry model
• fullGeomGrad - PetscBool flag. Determines how the Surface Area and Volume Gradients wrt to Control Points and Control Point Weights are calculated.

PETSCFALSE :: Surface Area Gradient wrt Control Points and Control Point Weights are calculated using the change in the local FACE changes (not the entire body). Volume Gradients are not calculated. Faster computations. PETSCTRUE :: Surface Area Gradietn wrt to Control Points and Control Point Weights are calculated using the change observed in the entire solid body. Volume Gradients are calculated. Slower computation due to the need to generate a new solid body geometry for every Control Point and Control Point Weight change.

Output Parameter:

• dm - The updated DM object representing the mesh with PetscContainers containing the Control Point, Control Point Weight and Gradient Data.

Level: intermediate

See also: DMPLEX, DMCreate(), DMPlexCreateGeom(), DMPlexModifyEGADSGeomModel()

External Links

• PETSc Manual: DMPlex/DMPlexGeomDataAndGrads

point::PetscInt = DMPlexGetActivePoint(petsclib::PetscLibType, dm::AbstractPetscDM)

Get the point on which projection is currently working

Not Collective

Input Parameter:

• dm - the DM

Output Parameter:

• point - The mesh point involved in the current projection

Level: developer

See also: DM, DMPLEX, DMPlexSetActivePoint()

External Links

• PETSc Manual: DMPlex/DMPlexGetActivePoint

adjSize::PetscInt,adj::Vector{PetscInt} = DMPlexGetAdjacency(petsclib::PetscLibType, dm::AbstractPetscDM, p::PetscInt)

Return all points adjacent to the given point

Input Parameters:

• dm - The DM object
• p - The point

Input/Output Parameters:

• adjSize - The maximum size of adj if it is non-NULL, or PETSC_DETERMINE;

on output the number of adjacent points

• adj - Either NULL so that the array is allocated, or an existing array with size adjSize;

on output contains the adjacent points

Level: advanced

See also: DMPLEX, DMSetAdjacency(), DMPlexDistribute(), DMCreateMatrix(), DMPlexPreallocateOperator()

External Links

• PETSc Manual: DMPlex/DMPlexGetAdjacency

useAnchors::PetscBool = DMPlexGetAdjacencyUseAnchors(petsclib::PetscLibType, dm::AbstractPetscDM)

Query whether adjacency in the mesh uses the point-to-point constraints.

Input Parameter:

• dm - The DM object

Output Parameter:

• useAnchors - Flag to use the closure. If PETSC_TRUE, then constrained points are omitted from DMPlexGetAdjacency(), and their anchor points appear in their place.

Level: intermediate

See also: DMPLEX, DMPlexSetAdjacencyUseAnchors(), DMSetAdjacency(), DMGetAdjacency(), DMPlexDistribute(), DMPlexPreallocateOperator(), DMPlexSetAnchors()

External Links

• PETSc Manual: DMPlex/DMPlexGetAdjacencyUseAnchors

DMPlexGetAdjacencyUser(petsclib::PetscLibType, dm::AbstractPetscDM, noname::Ptr{Cvoid})

get the user-defined adjacency callback

Input Parameter:

• dm - The DM object

Output Parameters:

• user - The callback
• ctx - context for callback evaluation

Level: advanced

See also: DMPLEX, DMSetAdjacency(), DMPlexDistribute(), DMPlexPreallocateOperator(), DMPlexGetAdjacency(), DMPlexSetAdjacencyUser()

External Links

• PETSc Manual: DMPlex/DMPlexGetAdjacencyUser

anchorSection::PetscSection,anchorIS::IS = DMPlexGetAnchors(petsclib::PetscLibType, dm::AbstractPetscDM)

Get the layout of the anchor (point-to-point) constraints. Typically, the user will not have to call DMPlexGetAnchors() directly: if there are anchors, then DMPlexGetAnchors() is called during DMGetDefaultConstraints().

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameters:

• anchorSection - If not NULL, set to the section describing which points anchor the constrained points.
• anchorIS - If not NULL, set to the list of anchors indexed by anchorSection

Level: intermediate

See also: DM, DMPLEX, DMPlexSetAnchors(), DMGetDefaultConstraints(), DMSetDefaultConstraints(), IS, PetscSection

External Links

• PETSc Manual: DMPlex/DMPlexGetAnchors

isDG::PetscBool,Nc::PetscInt,array::Vector{PetscScalar},coords::Vector{PetscScalar} = DMPlexGetCellCoordinates(petsclib::PetscLibType, dm::AbstractPetscDM, cell::PetscInt)

Get coordinates for a cell, taking into account periodicity

Not Collective

Input Parameters:

• dm - The DMPLEX
• cell - The cell number

Output Parameters:

• isDG - Using cellwise coordinates
• Nc - The number of coordinates
• array - The coordinate array
• coords - The cell coordinates

Level: developer

See also: DMPLEX, DMPlexRestoreCellCoordinates(), DMGetCoordinatesLocal(), DMGetCellCoordinatesLocal()

External Links

• PETSc Manual: DMPlex/DMPlexGetCellCoordinates

u::Ptr{PetscScalar},u_t::Ptr{PetscScalar},a::Ptr{PetscScalar} = DMPlexGetCellFields(petsclib::PetscLibType, dm::AbstractPetscDM, cellIS::AbstractIS, locX::AbstractPetscVec, locX_t::AbstractPetscVec, locA::AbstractPetscVec)

Retrieve the field values values for a chunk of cells

Input Parameters:

• dm - The DM
• cellIS - The cells to include
• locX - A local vector with the solution fields
• locX_t - A local vector with solution field time derivatives, or NULL
• locA - A local vector with auxiliary fields, or NULL

Output Parameters:

• u - The field coefficients
• u_t - The fields derivative coefficients
• a - The auxiliary field coefficients

Level: developer

See also: DM, DMPLEX, DMPlexGetFaceFields()

External Links

• PETSc Manual: DMPlex/DMPlexGetCellFields

globalCellNumbers::IS = DMPlexGetCellNumbering(petsclib::PetscLibType, dm::AbstractPetscDM)

Get a global cell numbering for all cells on this process

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• globalCellNumbers - Global cell numbers for all cells on this process

Level: developer

See also: DM, DMPLEX, DMPlexCreateCellNumbering(), DMPlexGetVertexNumbering()

External Links

• PETSc Manual: DMPlex/DMPlexGetCellNumbering

celltype::DMPolytopeType = DMPlexGetCellType(petsclib::PetscLibType, dm::AbstractPetscDM, cell::PetscInt)

Get the polytope type of a given cell

Not Collective

Input Parameters:

• dm - The DMPLEX object
• cell - The cell

Output Parameter:

• celltype - The polytope type of the cell

Level: intermediate

See also: DM, DMPLEX, DMPolytopeType, DMPlexGetCellTypeLabel(), DMPlexGetDepthLabel(), DMPlexGetDepth()

External Links

• PETSc Manual: DMPlex/DMPlexGetCellType

celltypeLabel::DMLabel = DMPlexGetCellTypeLabel(petsclib::PetscLibType, dm::AbstractPetscDM)

Get the DMLabel recording the polytope type of each cell

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• celltypeLabel - The DMLabel recording cell polytope type

Level: developer

See also: DM, DMPLEX, DMPlexGetCellType(), DMPlexGetDepthLabel(), DMCreateLabel()

External Links

• PETSc Manual: DMPlex/DMPlexGetCellTypeLabel

start::PetscInt,end_::PetscInt = DMPlexGetCellTypeStratum(petsclib::PetscLibType, dm::AbstractPetscDM, ct::DMPolytopeType)

Get the range of cells of a given celltype

Input Parameters:

• dm - The DMPLEX object
• ct - The DMPolytopeType of the cell

Output Parameters:

• start - The first cell of this type, or NULL
• end - The upper bound on this celltype, or NULL

Level: advanced

See also: DM, DMPLEX, DMPlexConstructGhostCells(), DMPlexGetDepthStratum(), DMPlexGetHeightStratum()

External Links

• PETSc Manual: DMPlex/DMPlexGetCellTypeStratum

pStart::PetscInt,pEnd::PetscInt = DMPlexGetChart(petsclib::PetscLibType, dm::AbstractPetscDM)

Return the interval for all mesh points [pStart, pEnd)

Not Collective

Input Parameter:

• dm - The DMPLEX

Output Parameters:

• pStart - The first mesh point
• pEnd - The upper bound for mesh points

Level: beginner

See also: DM, DMPLEX, DMPlexCreate(), DMPlexSetChart()

External Links

• PETSc Manual: DMPlex/DMPlexGetChart

numIndices::PetscInt,indices::Vector{PetscInt},outOffsets::Vector{PetscInt} = DMPlexGetClosureIndices(petsclib::PetscLibType, dm::AbstractPetscDM, section::PetscSection, idxSection::PetscSection, point::PetscInt, useClPerm::PetscBool, values::Union{Ptr, AbstractArray{PetscScalar}})

Gets the global dof indices associated with the closure of the given point within the provided sections.

Not collective

Input Parameters:

• dm - The DM
• section - The PetscSection describing the points (a local section)
• idxSection - The PetscSection from which to obtain indices (may be local or global)
• point - The point defining the closure
• useClPerm - Use the closure point permutation if available

Output Parameters:

• numIndices - The number of dof indices in the closure of point with the input sections
• indices - The dof indices
• outOffsets - Array, of length the number of fields plus 1, to write the field offsets into, or NULL
• values - The input values, which may be modified if sign flips are induced by the point symmetries, or NULL

Level: advanced

See also: DM, DMPLEX, DMPlexRestoreClosureIndices(), DMPlexVecGetClosure(), DMPlexMatSetClosure(), DMGetLocalSection(), PetscSection, DMGetGlobalSection()

External Links

• PETSc Manual: DMPlex/DMPlexGetClosureIndices

numPoints::PetscInt,points::Ptr{PetscInt},clSec::PetscSection,clPoints::IS,clp::Ptr{PetscInt} = DMPlexGetCompressedClosure(petsclib::PetscLibType, dm::AbstractPetscDM, section::PetscSection, point::PetscInt, ornt::PetscInt)

Return the transitive closure of a point, restricted to points with dof in the given section

Not Collective

Input Parameters:

• dm - The DMPLEX
• section - The PetscSection used to filter closure points
• point - The mesh point
• ornt - The orientation of point; when zero the cached closure index (if any) is used directly

Output Parameters:

• numPoints - Number of closure points that participate in section
• points - Array of (point, orientation) pairs; either the cached closure or a work array from DMPlexGetTransitiveClosure_Internal()
• clSec - The section describing the closure index, or NULL if none is cached
• clPoints - The IS holding the closure indices, or NULL if none is cached
• clp - Raw pointer into the closure-index IS when it is used, or NULL otherwise

Level: developer

See also: DM, DMPLEX, PetscSection, DMPlexRestoreCompressedClosure(), DMPlexGetTransitiveClosure(), PetscSectionGetClosureIndex()

External Links

• PETSc Manual: DMPlex/DMPlexGetCompressedClosure

cone::Vector{PetscInt} = DMPlexGetCone(petsclib::PetscLibType, dm::AbstractPetscDM, p::PetscInt)

Return the points on the in-edges for this point in the DAG

Not Collective

Input Parameters:

• dm - The DMPLEX
• p - The point, which must lie in the chart set with DMPlexSetChart()

Output Parameter:

• cone - An array of points which are on the in-edges for point p, the length of cone is the result of DMPlexGetConeSize()

Level: beginner

See also: DM, DMPLEX, DMPlexGetConeSize(), DMPlexSetCone(), DMPlexGetConeTuple(), DMPlexSetChart(), DMPlexRestoreCone()

External Links

• PETSc Manual: DMPlex/DMPlexGetCone

coneOrientation::Vector{PetscInt} = DMPlexGetConeOrientation(petsclib::PetscLibType, dm::AbstractPetscDM, p::PetscInt)

Return the orientations on the in-edges for this point in the DAG

Not Collective

Input Parameters:

• dm - The DMPLEX
• p - The point, which must lie in the chart set with DMPlexSetChart()

Output Parameter:

• coneOrientation - An array of orientations which are on the in-edges for point p. An orientation is an

integer giving the prescription for cone traversal. Its length is given by the result of DMPlexSetConeSize()

Level: beginner

See also: DM, DMPLEX, DMPlexSetConeSize(), DMPolytopeTypeComposeOrientation(), DMPolytopeTypeComposeOrientationInv(), DMPlexCreate(), DMPlexGetCone(), DMPlexSetCone(), DMPlexSetChart()

External Links

• PETSc Manual: DMPlex/DMPlexGetConeOrientation

coneOrientations::Ptr{PetscInt} = DMPlexGetConeOrientations(petsclib::PetscLibType, dm::AbstractPetscDM)

Return cone orientation data

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• coneOrientations - The array of cone orientations for all points

Level: developer

See also: DM, DMPLEX, DMPlexGetConeSection(), DMPlexGetConeOrientation(), PetscSection

External Links

• PETSc Manual: DMPlex/DMPlexGetConeOrientations

depth::PetscInt,expandedPoints::Ptr{CIS},sections::Ptr{PetscSection} = DMPlexGetConeRecursive(petsclib::PetscLibType, dm::AbstractPetscDM, points::AbstractIS)

Expand each given point into its cone points and do that recursively until we end up just with vertices (DAG points of depth 0, i.e., without cones).

Not Collective

Input Parameters:

• dm - The DMPLEX
• points - The IS of points, which must lie in the chart set with DMPlexSetChart()

Output Parameters:

• depth - (optional) Size of the output arrays, equal to DMPLEX depth, returned by DMPlexGetDepth()
• expandedPoints - (optional) An array of index sets with recursively expanded cones
• sections - (optional) An array of sections which describe mappings from points to their cone points

Level: advanced

See also: DM, DMPLEX, DMPlexCreate(), DMPlexGetCone(), DMPlexGetConeTuple(), DMPlexRestoreConeRecursive(), DMPlexGetConeRecursiveVertices(), DMPlexGetDepth(), PetscSection, IS

External Links

• PETSc Manual: DMPlex/DMPlexGetConeRecursive

expandedPoints::IS = DMPlexGetConeRecursiveVertices(petsclib::PetscLibType, dm::AbstractPetscDM, points::AbstractIS)

Expand each given point into its cone points and do that recursively until we end up just with vertices.

Not Collective

Input Parameters:

• dm - The DMPLEX
• points - The IS of points, which must lie in the chart set with DMPlexSetChart()

Output Parameter:

• expandedPoints - An IS containing the of vertices recursively expanded from input points

Level: advanced

See also: DM, DMPLEX, DMPlexCreate(), DMPlexGetCone(), DMPlexGetConeTuple(), DMPlexGetConeRecursive(), DMPlexRestoreConeRecursive(), DMPlexGetDepth(), IS

External Links

• PETSc Manual: DMPlex/DMPlexGetConeRecursiveVertices

section::PetscSection = DMPlexGetConeSection(petsclib::PetscLibType, dm::AbstractPetscDM)

Return a section which describes the layout of cone data

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• section - The PetscSection object

Level: developer

See also: DM, DMPLEX, DMPlexGetSupportSection(), DMPlexGetCones(), DMPlexGetConeOrientations(), PetscSection

External Links

• PETSc Manual: DMPlex/DMPlexGetConeSection

size::PetscInt = DMPlexGetConeSize(petsclib::PetscLibType, dm::AbstractPetscDM, p::PetscInt)

Return the number of in-edges for this point in the DAG

Not Collective

Input Parameters:

• dm - The DMPLEX
• p - The point, which must lie in the chart set with DMPlexSetChart()

Output Parameter:

• size - The cone size for point p

Level: beginner

See also: DM, DMPLEX, DMPlexCreate(), DMPlexSetConeSize(), DMPlexSetChart()

External Links

• PETSc Manual: DMPlex/DMPlexGetConeSize

pConesSection::PetscSection,pCones::IS = DMPlexGetConeTuple(petsclib::PetscLibType, dm::AbstractPetscDM, p::AbstractIS)

Return the points on the in-edges of several points in the DAG

Not Collective

Input Parameters:

• dm - The DMPLEX
• p - The IS of points, which must lie in the chart set with DMPlexSetChart()

Output Parameters:

• pConesSection - PetscSection describing the layout of pCones
• pCones - An IS containing the points which are on the in-edges for the point set p

Level: intermediate

See also: DM, DMPLEX, DMPlexCreate(), DMPlexGetCone(), DMPlexGetConeRecursive(), DMPlexSetChart(), PetscSection, IS

External Links

• PETSc Manual: DMPlex/DMPlexGetConeTuple

cones::Ptr{PetscInt} = DMPlexGetCones(petsclib::PetscLibType, dm::AbstractPetscDM)

Return cone data

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• cones - The cone for each point

Level: developer

See also: DM, DMPLEX, DMPlexGetConeSection()

External Links

• PETSc Manual: DMPlex/DMPlexGetCones

coordFunc::Ptr{Cvoid} = DMPlexGetCoordinateMap(petsclib::PetscLibType, dm::AbstractPetscDM)

Returns the function used to map coordinates of newly generated mesh points

Not Collective

Input Parameter:

• dm - the DMPLEX

Output Parameter:

• coordFunc - the mapping function

Level: developer

See also: DMPLEX, DMGetCoordinates(), DMPlexSetCoordinateMap(), PetscPointFn

External Links

• PETSc Manual: DMPlex/DMPlexGetCoordinateMap

cellgeom::PetscVec,facegeom::PetscVec,gradDM::PetscDM = DMPlexGetDataFVM(petsclib::PetscLibType, dm::AbstractPetscDM, fv::PetscFV)

Retrieve precomputed cell geometry

Collective

Input Parameters:

• dm - The DM
• fv - The PetscFV

Output Parameters:

• cellgeom - The cell geometry
• facegeom - The face geometry
• gradDM - The gradient matrices

Level: developer

See also: DMPLEX, DMPlexComputeGeometryFVM()

External Links

• PETSc Manual: DMPlex/DMPlexGetDataFVM

depth::PetscInt = DMPlexGetDepth(petsclib::PetscLibType, dm::AbstractPetscDM)

Get the depth of the DAG representing this mesh

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• depth - The number of strata (breadth first levels) in the DAG

Level: developer

See also: DM, DMPLEX, DMPlexGetDepthLabel(), DMPlexGetDepthStratum(), DMPlexGetPointDepth(), DMPlexSymmetrize()

External Links

• PETSc Manual: DMPlex/DMPlexGetDepth

depthLabel::DMLabel = DMPlexGetDepthLabel(petsclib::PetscLibType, dm::AbstractPetscDM)

Get the DMLabel recording the depth of each point

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• depthLabel - The DMLabel recording point depth

Level: developer

See also: DM, DMPLEX, DMPlexGetDepth(), DMPlexGetHeightStratum(), DMPlexGetDepthStratum(), DMPlexGetPointDepth()

External Links

• PETSc Manual: DMPlex/DMPlexGetDepthLabel

start::PetscInt,end_::PetscInt = DMPlexGetDepthStratum(petsclib::PetscLibType, dm::AbstractPetscDM, depth::PetscInt)

Get the bounds [start, end) for all points at a certain depth.

Not Collective

Input Parameters:

• dm - The DMPLEX object
• depth - The requested depth

Output Parameters:

• start - The first point at this depth
• end - One beyond the last point at this depth

Level: developer

See also: DM, DMPLEX, DMPlexGetHeightStratum(), DMPlexGetCellTypeStratum(), DMPlexGetDepth(), DMPlexGetDepthLabel(), DMPlexGetPointDepth(), DMPlexSymmetrize(), DMPlexInterpolate()

External Links

• PETSc Manual: DMPlex/DMPlexGetDepthStratum

gsize::PetscInt = DMPlexGetDepthStratumGlobalSize(petsclib::PetscLibType, dm::AbstractPetscDM, depth::PetscInt)

Get the global size for a given depth stratum

Input Parameters:

• dm - The DMPLEX object
• depth - The depth for the given point stratum

Output Parameter:

• gsize - The global number of points in the stratum

Level: advanced

See also: DM, DMPLEX, DMPlexGetCellNumbering(), DMPlexGetVertexNumbering(), DMPlexGetDepthStratum(), DMPlexGetHeightStratum()

External Links

• PETSc Manual: DMPlex/DMPlexGetDepthStratumGlobalSize

Nface::PetscInt,uL::Ptr{PetscScalar},uR::Ptr{PetscScalar} = DMPlexGetFaceFields(petsclib::PetscLibType, dm::AbstractPetscDM, fStart::PetscInt, fEnd::PetscInt, locX::AbstractPetscVec, locX_t::AbstractPetscVec, faceGeometry::AbstractPetscVec, cellGeometry::AbstractPetscVec, locGrad::AbstractPetscVec)

Retrieve the field values values for a chunk of faces

Input Parameters:

• dm - The DM
• fStart - The first face to include
• fEnd - The first face to exclude
• locX - A local vector with the solution fields
• locX_t - A local vector with solution field time derivatives, or NULL
• faceGeometry - A local vector with face geometry
• cellGeometry - A local vector with cell geometry
• locGrad - A local vector with field gradients, or NULL

Output Parameters:

• Nface - The number of faces with field values
• uL - The field values at the left side of the face
• uR - The field values at the right side of the face

Level: developer

See also: DM, DMPLEX, DMPlexGetCellFields()

External Links

• PETSc Manual: DMPlex/DMPlexGetFaceFields

Nface::PetscInt,fgeom::Vector{PetscFVFaceGeom},vol::Vector{PetscReal} = DMPlexGetFaceGeometry(petsclib::PetscLibType, dm::AbstractPetscDM, fStart::PetscInt, fEnd::PetscInt, faceGeometry::AbstractPetscVec, cellGeometry::AbstractPetscVec)

Retrieve the geometric values for a chunk of faces

Input Parameters:

• dm - The DM
• fStart - The first face to include
• fEnd - The first face to exclude
• faceGeometry - A local vector with face geometry
• cellGeometry - A local vector with cell geometry

Output Parameters:

• Nface - The number of faces with field values
• fgeom - The face centroid and normals
• vol - The cell volumes

Level: developer

See also: DM, DMPLEX, DMPlexGetCellFields()

External Links

• PETSc Manual: DMPlex/DMPlexGetFaceGeometry

numCoveredPoints::PetscInt,coveredPoints::Vector{PetscInt} = DMPlexGetFullJoin(petsclib::PetscLibType, dm::AbstractPetscDM, numPoints::PetscInt, points::Vector{PetscInt})

Get an array for the join of the set of points

Not Collective

Input Parameters:

• dm - The DMPLEX object
• numPoints - The number of input points for the join
• points - The input points, its length is numPoints

Output Parameters:

• numCoveredPoints - The number of points in the join
• coveredPoints - The points in the join, its length is numCoveredPoints

Level: intermediate

See also: DM, DMPLEX, DMPlexGetJoin(), DMPlexRestoreJoin(), DMPlexGetMeet()

External Links

• PETSc Manual: DMPlex/DMPlexGetFullJoin

numCoveredPoints::PetscInt,coveredPoints::Vector{PetscInt} = DMPlexGetFullMeet(petsclib::PetscLibType, dm::AbstractPetscDM, numPoints::PetscInt, points::Vector{PetscInt})

Get an array for the meet of the set of points

Not Collective

Input Parameters:

• dm - The DMPLEX object
• numPoints - The number of input points for the meet
• points - The input points, of length numPoints

Output Parameters:

• numCoveredPoints - The number of points in the meet
• coveredPoints - The points in the meet, of length numCoveredPoints

Level: intermediate

See also: DM, DMPLEX, DMPlexGetMeet(), DMPlexRestoreMeet(), DMPlexGetJoin()

External Links

• PETSc Manual: DMPlex/DMPlexGetFullMeet

sf::PetscSF,gatherMesh::PetscDM = DMPlexGetGatherDM(petsclib::PetscLibType, dm::AbstractPetscDM)

Get a copy of the DMPLEX that gathers all points on the root process of the original's communicator.

Collective

Input Parameter:

• dm - the original DMPLEX object

Output Parameters:

• sf - the PetscSF used for point distribution (optional)
• gatherMesh - the gathered DM object, or NULL

Level: intermediate

See also: DMPLEX, DM, PetscSF, DMPlexDistribute(), DMPlexGetRedundantDM()

External Links

• PETSc Manual: DMPlex/DMPlexGetGatherDM

volume::PetscScalar,surfArea::PetscScalar,centerOfGravity::Ptr{PetscScalar},COGsize::PetscInt,inertiaMatrixCOG::Ptr{PetscScalar},IMCOGsize::PetscInt = DMPlexGetGeomBodyMassProperties(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom)

Returns the Volume, Surface Area, Center of Gravity, and Inertia about the Body's Center of Gravity

Not collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom BODY object

Output Parameters:

• volume - Volume of the CAD Body attached to the DM Plex
• surfArea - Surface Area of the CAD Body attached to the DM Plex
• centerOfGravity - Array with the Center of Gravity coordinates of the CAD Body attached to the DM Plex [x, y, z]
• COGszie - Size of centerOfGravity[] Array
• inertiaMatrixCOG - Array containing the Inertia about the Body's Center of Gravity [Ixx, Ixy, Ixz, Iyx, Iyy, Iyz, Izx, Izy, Izz]
• IMCOGsize - Size of inertiaMatrixCOG[] Array

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomBodyMassProperties

cpHashTable::PetscHMapI,cpCoordDataLength::PetscInt,cpCoordData::Ptr{PetscScalar},maxNumEquiv::PetscInt,cpEquiv::PetscMat,wHashTable::PetscHMapI,wDataLength::PetscInt,wData::Ptr{PetscScalar} = DMPlexGetGeomCntrlPntAndWeightData(petsclib::PetscLibType, dm::AbstractPetscDM)

Gets Control Point and Associated Weight Data for the Geometry attached to the DMPlex

Not collective

Input Parameter:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object

Output Parameters:

• cpHashTable - Hash Table containing the relationship between FACE ID and Control Point IDs.
• cpCoordDataLength - Length of cpCoordData Array.
• cpCoordData - Array holding the Geometry Control Point Coordinate Data.
• maxNumEquiv - Maximum Number of Equivalent Control Points (Control Points with the same coordinates but different IDs).
• cpEquiv - Matrix with a size(Number of Control Points, Number or Control Points) which stores a value of 1.0 in locations where Control Points with different IDS (row or column) have the same coordinates
• wHashTable - Hash Table containing the relationship between FACE ID and Control Point Weight.
• wDataLength - Length of wData Array.
• wData - Array holding the Weight for an associated Geometry Control Point.

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomCntrlPntAndWeightData

numCntrlPnts::PetscInt,cntrlPntFaceMap::Ptr{PetscInt},cntrlPntWeightFaceMap::Ptr{PetscInt},cntrlPntEdgeMap::Ptr{PetscInt},cntrlPntWeightEdgeMap::Ptr{PetscInt},cntrlPntVertexMap::Ptr{PetscInt},cntrlPntWeightVertexMap::Ptr{PetscInt} = DMPlexGetGeomCntrlPntMaps(petsclib::PetscLibType, dm::AbstractPetscDM)

Gets arrays which maps Control Point IDs to their associated Geometry FACE, EDGE, and VERTEX.

Not collective

Input Parameter:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object

Output Parameters:

• numCntrlPnts - Number of Control Points defining the Geometry attached to the DMPlex
• cntrlPntFaceMap - Array containing the FACE ID for the Control Point. Array index corresponds to Control Point ID.
• cntrlPntWeightFaceMap - Array containing the FACE ID for the Control Point Weight. Array index corresponds to Control Point ID.
• cntrlPntEdgeMap - Array containing the EDGE ID for the Control Point. Array index corresponds to Control Point ID.
• cntrlPntWeightEdgeMap - Array containing the EDGE ID for the Control Point Weight. Array index corresponds to Control Point ID.
• cntrlPntVertexMap - Array containing the VERTEX ID for the Control Point. Array index corresponds to Control Point ID.
• cntrlPntWeightVertexMap - Array containing the VERTEX ID for the Control Point Weight. Array index corresponds to Control Point ID.

Level: intermediate

See also: DMPlexGeomDataAndGrads()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomCntrlPntMaps

numCntrlPnts::PetscInt = DMPlexGetGeomFaceNumOfControlPoints(petsclib::PetscLibType, dm::AbstractPetscDM, face::PetscGeom)

Returns the total number of Control Points (and associated Weights) defining a FACE of a Geometry

Not collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• face - PetscGeom FACE object

Output Parameter:

• numCntrlPnts - Number of Control Points (and Weights) defining the FACE

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomFaceNumOfControlPoints

cpSurfGradHashTable::PetscHMapI,cpSurfGrad::PetscMat,cpArraySize::PetscInt,gradSACP::Ptr{PetscScalar},gradVolCP::Ptr{PetscScalar},wArraySize::PetscInt,gradSAW::Ptr{PetscScalar},gradVolW::Ptr{PetscScalar} = DMPlexGetGeomGradData(petsclib::PetscLibType, dm::AbstractPetscDM)

Gets Point, Surface and Volume Gradients with respect to changes in Control Points and their associated Weights for the Geometry attached to the DMPlex .

Not collective

Input Parameter:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object

Output Parameters:

• cpSurfGradHashTable - Hash Table Relating the Control Point ID to the the Row in the cpSurfGrad Matrix
• cpSurfGrad - Matrix containing the Surface Gradient with respect to the Control Point Data. Data is ranged where the Row corresponds to Control Point ID and the Columns are associated with the Geometric FACE.
• cpArraySize - The size of arrays gradSACP and gradVolCP and is equal to 3 * total number of Control Points in the Geometry
• gradSACP - Array containing the Surface Area Gradient with respect to Control Point Data. Data is arranged by Control Point ID * 3 where 3 is for the coordinate dimension.
• gradVolCP - Array containing the Volume Gradient with respect to Control Point Data. Data is arranged by Control Point ID * 3 where 3 is for the coordinate dimension.
• wArraySize - The size of arrayws gradSAW and gradVolW and is equal to the total number of Control Points in the Geometry.
• gradSAW - Array containing the Surface Area Gradient with respect to Control Point Weight. Data is arranged by Control Point ID.
• gradVolW - Array containing the Volume Gradient with respect to Control Point Weight. Data is arranged by Control Point ID.

See also: DMPlexGeomDataAndGrads()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomGradData

id::PetscInt = DMPlexGetGeomID(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom, topoObj::PetscGeom)

Returns ID number of the entity in the geometric (CAD) model

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom body object containing the lower level entity the ID number is being requested.
• topoObj - PetscGeom SHELL, FACE, LOOP, EDGE, or NODE object for which ID number is being requested.

Output Parameter:

• id - ID number of the entity

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomID

bodies::Ptr{PetscGeom},numBodies::PetscInt = DMPlexGetGeomModelBodies(petsclib::PetscLibType, dm::AbstractPetscDM)

Returns an array of PetscGeom BODY objects attached to the referenced geometric model entity as well as the number of BODYs.

Collective

Input Parameter:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object

Output Parameters:

• bodies - Array of PetscGeom BODY objects referenced by the geometric model.
• numBodies - Number of BODYs referenced by the geometric model. Also the size of **bodies array.

Level: intermediate

See also: DMPlexGetGeomModelBodyShells(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelBodies

edges::Ptr{PetscGeom},numEdges::PetscInt = DMPlexGetGeomModelBodyEdges(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom)

Returns an array of PetscGeom EDGE objects attached to the referenced BODY geometric entity as well as the number of EDGEs.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom body object of interest.

Output Parameters:

• edges - Array of PetscGeom EDGE objects referenced by the PetscGeom BODY object
• numEdges - Number of EDGEs referenced by the PetscGeom BODY object. Also the size of **edges array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelBodyEdges

faces::Ptr{PetscGeom},numFaces::PetscInt = DMPlexGetGeomModelBodyFaces(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom)

Returns an array of PetscGeom FACE objects attached to the referenced BODY geometric entity as well as the number of FACEs.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom BODY object containing the FACE objects of interest.

Output Parameters:

• faces - Array of PetscGeom FACE objects referenced by the PetscGeom BODY object
• numFaces - Number of FACEs referenced by the PetscGeom BODY object. Also the size of **faces array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelBodyFaces

loops::Ptr{PetscGeom},numLoops::PetscInt = DMPlexGetGeomModelBodyLoops(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom)

Returns an array of PetscGeom Loop objects attached to the referenced BODY geometric entity as well as the number of LOOPs.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom BODY object containing the LOOP objects of interest.

Output Parameters:

• loops - Array of PetscGeom FACE objects referenced by the PetscGeom SHELL object
• numLoops - Number of LOOPs referenced by the PetscGeom BODY object. Also the size of **loops array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelBodyLoops

nodes::Ptr{PetscGeom},numNodes::PetscInt = DMPlexGetGeomModelBodyNodes(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom)

Returns an array of PetscGeom NODE objects attached to the referenced BODY geometric entity as well as the number of NODES.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom body object of interest.

Output Parameters:

• nodes - Array of PetscGeom NODE objects referenced by the PetscGeom BODY object
• numNodes - Number of NODEs referenced by the PetscGeom BODY object. Also the size of **nodes array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelBodyNodes

shells::Ptr{PetscGeom},numShells::PetscInt = DMPlexGetGeomModelBodyShells(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom)

Returns an array of PetscGeom SHELL objects attached to the referenced BODY geometric entity as well as the number of SHELLs.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom BODY object containing the SHELL objects of interest.

Output Parameters:

• shells - Array of PetscGeom SHELL objects referenced by the PetscGeom BODY object
• numShells - Number of SHELLs referenced by the PetscGeom BODY object. Also the size of **shells array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelBodyShells

nodes::Ptr{PetscGeom},numNodes::PetscInt = DMPlexGetGeomModelEdgeNodes(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom, edge::PetscGeom)

Returns an array of PetscGeom NODE objects attached to the referenced EDGE geometric entity as well as the number of NODES.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom body object containing the EDGE object of interest.
• edge - PetscGeom EDGE object with NODEs of interest.

Output Parameters:

• nodes - Array of PetscGeom NODE objects referenced by the PetscGeom EDGE object
• numNodes - Number of Nodes referenced by the PetscGeom EDGE object. Also the size of **nodes array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelEdgeNodes

edges::Ptr{PetscGeom},numEdges::PetscInt = DMPlexGetGeomModelFaceEdges(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom, face::PetscGeom)

Returns an array of PetscGeom EDGE objects attached to the referenced FACE geometric entity as well as the number of EDGEs.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom Body object containing the EDGE objects of interest.
• face - PetscGeom FACE object with EDGEs of interest.

Output Parameters:

• edges - Array of PetscGeom EDGE objects referenced by the PetscGeom FACE object
• numEdges - Number of EDGEs referenced by the PetscGeom FACE object. Also the size of **edges array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelFaceEdges

loops::Ptr{PetscGeom},numLoops::PetscInt = DMPlexGetGeomModelFaceLoops(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom, face::PetscGeom)

Returns an array of PetscGeom LOOP objects attached to the referenced FACE geometric entity as well as the number of LOOPs.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom BODY object containing the LOOP objects of interest.
• face - PetscGeom FACE object with LOOPs of interest.

Output Parameters:

• loops - Array of PetscGeom LOOP objects referenced by the PetscGeom FACE object
• numLoops - Number of LOOPs referenced by the PetscGeom FACE object. Also the size of **loops array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelFaceLoops

faces::Ptr{PetscGeom},numFaces::PetscInt = DMPlexGetGeomModelShellFaces(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom, shell::PetscGeom)

Returns an array of PetscGeom FACE objects attached to the referenced SHELL geometric entity as well as the number of FACEs.

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom BODY object containing the FACE objects of interest.
• shell - PetscGeom SHELL object with FACEs of interest.

Output Parameters:

• faces - Array of PetscGeom FACE objects referenced by the PetscGeom SHELL object
• numFaces - Number of FACEs referenced by the PetscGeom SHELL object. Also the size of **faces array.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelShellFaces

DMPlexGetGeomModelTUV(petsclib::PetscLibType, dm::AbstractPetscDM)

Gets the [t] (EDGES) and [u, v] (FACES) geometry parameters of DM points that are associated geometry relationships. Requires a DM with an EGADS model attached.

Collective

Input Parameter:

• dm - The DM object representing the mesh with PetscContainer containing an EGADS geometry model

Level: intermediate

See also: DMPLEX, DMCreate(), DMPlexCreateGeom(), DMPlexGeomDataAndGrads()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomModelTUV

geomObj::PetscGeom = DMPlexGetGeomObject(petsclib::PetscLibType, dm::AbstractPetscDM, body::PetscGeom, geomType::PetscInt, geomID::PetscInt)

Returns Geometry Object using the objects ID in the geometric (CAD) model

Collective

Input Parameters:

• dm - The DMPlex object with an attached PetscContainer storing a CAD Geometry object
• body - PetscGeom body object containing the lower level entity the referenced by the ID.
• geomType - Keyword SHELL, FACE, LOOP, EDGE, or NODE of the geometry type for which ID number is being requested.
• geomID - ID number of the geometry entity being requested.

Output Parameter:

• geomObj - Geometry Object referenced by the ID number requested.

Level: intermediate

See also: DMPlexGetGeomModelBodies(), DMPlexGetGeomModelTUV(), DMPlexInflateToGeomModelUseTUV(), DMPlexInflateToGeomModelUseXYZ()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeomObject

facegeom::PetscVec,cellgeom::PetscVec,minRadius::PetscReal = DMPlexGetGeometryFVM(petsclib::PetscLibType, dm::AbstractPetscDM)

Return precomputed geometric data

Collective

Input Parameter:

• dm - The DM

Output Parameters:

• facegeom - The values precomputed from face geometry
• cellgeom - The values precomputed from cell geometry
• minRadius - The minimum radius over the mesh of an inscribed sphere in a cell, or NULL if not needed

Level: developer

See also: DM, DMPLEX, DMTSSetRHSFunctionLocal()

External Links

• PETSc Manual: DMPlex/DMPlexGetGeometryFVM

dmGrad::PetscDM = DMPlexGetGradientDM(petsclib::PetscLibType, dm::AbstractPetscDM, fv::PetscFV)

Return gradient data layout

Collective

Input Parameters:

• dm - The DM
• fv - The PetscFV

Output Parameter:

• dmGrad - The layout for gradient values

Level: developer

See also: DM, DMPLEX, DMPlexGetGeometryFVM()

External Links

• PETSc Manual: DMPlex/DMPlexGetGradientDM

start::PetscInt,end_::PetscInt = DMPlexGetHeightStratum(petsclib::PetscLibType, dm::AbstractPetscDM, height::PetscInt)

Get the bounds [start, end) for all points at a certain height.

Not Collective

Input Parameters:

• dm - The DMPLEX object
• height - The requested height

Output Parameters:

• start - The first point at this height
• end - One beyond the last point at this height

Level: developer

See also: DM, DMPLEX, DMPlexGetDepthStratum(), DMPlexGetCellTypeStratum(), DMPlexGetDepth(), DMPlexGetPointHeight()

External Links

• PETSc Manual: DMPlex/DMPlexGetHeightStratum

preferTensor::PetscBool = DMPlexGetInterpolatePreferTensor(petsclib::PetscLibType, dm::AbstractPetscDM)

Get the flag to prefer tensor order when interpolating a cell

Not Collective

Input Parameter:

• dm - The DMPLEX object

Output Parameter:

• preferTensor - Flag to prefer tensor order

Level: intermediate

See also: DMPlexSetInterpolatePreferTensor(), DMPLEX, DMPlexInterpolate(), DMPlexIsInterpolatedCollective()

External Links

• PETSc Manual: DMPlex/DMPlexGetInterpolatePreferTensor

num_face_sfs::PetscInt,face_sfs::Ptr{PetscSF} = DMPlexGetIsoperiodicFaceSF(petsclib::PetscLibType, dm::AbstractPetscDM)

Obtain periodicity for a mesh

Logically Collective

Input Parameter:

• dm - The DMPLEX for which to obtain periodic relation

Output Parameters:

• num_face_sfs - Number of PetscSFs in the array
• face_sfs - Array of PetscSF in which roots are (owned) donor faces and leaves are faces that must be matched to a (possibly remote) donor face.

Level: advanced

See also: DMPLEX, DMGetGlobalSection(), DMPlexSetIsoperiodicFaceSF()

External Links

• PETSc Manual: DMPlex/DMPlexGetIsoperiodicFaceSF

numCoveredPoints::PetscInt,coveredPoints::Vector{PetscInt} = DMPlexGetJoin(petsclib::PetscLibType, dm::AbstractPetscDM, numPoints::PetscInt, points::Vector{PetscInt})

Get an array for the join of the set of points

Not Collective

Input Parameters:

• dm - The DMPLEX object
• numPoints - The number of input points for the join
• points - The input points

Output Parameters:

• numCoveredPoints - The number of points in the join
• coveredPoints - The points in the join

Level: intermediate

See also: DM, DMPLEX, DMPlexRestoreJoin(), DMPlexGetMeet()

External Links

• PETSc Manual: DMPlex/DMPlexGetJoin

num_cells::PetscInt,cell_size::PetscInt,num_comp::PetscInt,l_size::PetscInt,offsets::Vector{PetscInt} = DMPlexGetLocalOffsets(petsclib::PetscLibType, dm::AbstractPetscDM, domain_label::DMLabel, label_value::PetscInt, height::PetscInt, dm_field::PetscInt)

Allocate and populate array of local offsets for each cell closure.

Not collective

Input Parameters:

• dm - The DMPLEX object
• domain_label - label for DMPLEX domain, or NULL for whole domain
• label_value - Stratum value
• height - Height of target cells in DMPLEX topology
• dm_field - Index of DMPLEX field

Output Parameters:

• num_cells - Number of local cells
• cell_size - Size of each cell, given by cellsize * numcomp = num_dof
• num_comp - Number of components per dof
• l_size - Size of local vector
• offsets - Allocated offsets array for cells

Level: developer

See also: DMPlexGetLocalOffsetsSupport(), DM, DMPLEX, DMLabel, DMPlexGetClosureIndices(), DMPlexSetClosurePermutationTensor(), DMPlexGetCeedRestriction()

External Links

• PETSc Manual: DMPlex/DMPlexGetLocalOffsets

num_faces::PetscInt,num_comp::PetscInt,l_size::PetscInt,offsetsNeg::Ptr{PetscInt},offsetsPos::Ptr{PetscInt} = DMPlexGetLocalOffsetsSupport(petsclib::PetscLibType, dm::AbstractPetscDM, domain_label::DMLabel, label_value::PetscInt)

Allocate and populate arrays of local offsets for each face support.

Not collective

Input Parameters:

• dm - The DMPLEX object
• domain_label - label for DMPLEX domain, or NULL for whole domain
• label_value - Stratum value

Output Parameters:

• num_faces - Number of local, non-boundary faces
• num_comp - Number of components per dof
• l_size - Size of local vector
• offsetsNeg - Allocated offsets array for cells on the inward normal side of each face
• offsetsPos - Allocated offsets array for cells on the outward normal side of each face

Level: developer

See also: DMPlexGetLocalOffsets(), DM, DMPLEX, DMLabel, DMPlexGetClosureIndices(), DMPlexSetClosurePermutationTensor(), DMPlexGetCeedRestriction()

External Links

• PETSc Manual: DMPlex/DMPlexGetLocalOffsetsSupport

height::PetscInt = DMPlexGetMaxProjectionHeight(petsclib::PetscLibType, dm::AbstractPetscDM)

Get the maximum height (w.r.t. DAG) of mesh points used to evaluate dual bases in DMPlexProjectXXXLocal() functions.

Input Parameter:

• dm - the DMPLEX object

Output Parameter:

• height - the maximum projection height

Level: intermediate

See also: DM, DMPLEX, DMPlexSetMaxProjectionHeight(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal()

External Links

• PETSc Manual: DMPlex/DMPlexGetMaxProjectionHeight