petsc4py.PETSc.DMPlexTransform

class petsc4py.PETSc.DMPlexTransform

Bases: Object

Mesh transformations.

Methods Summary

apply(dm)	Apply a mesh transformation.
create([comm])	Create a mesh transformation.
createSplitCellLabel(dm)	Return a label for cells whose source cell was split.
destroy()	Destroy a mesh transformation.
getActive()	Return the label marking the points to transform.
getSourcePoint(pNew)	Return the source point of a point of the transformed mesh.
getType()	Return the transformation type name.
setActive(label)	Set the label marking the points to transform.
setDM(dm)	Set the DM for the transformation.
setFromOptions()	Configure the transformation from the options database.
setType(tr_type)	Set the transformation type.
setUp()	Setup a mesh transformation.
view([viewer])	View the mesh transformation.

Methods Documentation

apply(dm)

Apply a mesh transformation.

Collective.

Source code at petsc4py/PETSc/DMPlex.pyx:3852

Parameters:

dm (DM)

Return type:

DM

create(comm=None)

Create a mesh transformation.

Collective.

See also

DMPlexTransformCreate

Source code at petsc4py/PETSc/DMPlex.pyx:3863

Parameters:

comm (Comm | None)

Return type:

Self

createSplitCellLabel(dm)

Return a label for cells whose source cell was split.

Not collective.

Parameters:

dm (DM) – The transformed mesh this transformation produced.

Return type:

DMLabel

Notes

This can include cells not flagged for refinement because the transform can split cells to restore conformity.

See also

DMPlex.getTransform, DMPlexTransformCreateSplitCellLabel

Source code at petsc4py/PETSc/DMPlex.pyx:3908

destroy()

Destroy a mesh transformation.

Collective.

See also

DMPlexTransformDestroy

Source code at petsc4py/PETSc/DMPlex.pyx:3959

Return type:

Self

getActive()

Return the label marking the points to transform.

Not collective.

See also

setActive, DMPlexTransformGetActive

Source code at petsc4py/PETSc/DMPlex.pyx:3932

Return type:

DMLabel

getSourcePoint(pNew)

Return the source point of a point of the transformed mesh.

Not collective.

Parameters:

pNew (int) – The point in the transformed mesh.

Returns:

• p (int) – The point of the original mesh that produced pNew.

• r (int) – The replica number of pNew, that is, it is the rth point of the polytope type of pNew produced by p.

Return type:

tuple[int, int]

See also

DMPlexTransformGetTargetPoint, DMPlexTransformGetSourcePoint

Source code at petsc4py/PETSc/DMPlex.pyx:3880

getType()

Return the transformation type name.

Not collective.

See also

DMPlexTransformGetType

Source code at petsc4py/PETSc/DMPlex.pyx:3972

Return type:

str

setActive(label)

Set the label marking the points to transform.

Logically collective.

See also

getActive, DMPlexTransformSetActive

Source code at petsc4py/PETSc/DMPlex.pyx:3947

Parameters:

label (DMLabel)

Return type:

None

setDM(dm)

Set the DM for the transformation.

Logically collective.

Source code at petsc4py/PETSc/DMPlex.pyx:4010

Parameters:

dm (DM)

Return type:

None

setFromOptions()

Configure the transformation from the options database.

Collective.

See also

Working with PETSc options, DMPlexTransformSetFromOptions

Source code at petsc4py/PETSc/DMPlex.pyx:4019

Return type:

None

setType(tr_type)

Set the transformation type.

Collective.

See also

DMPlexTransformSetType

Source code at petsc4py/PETSc/DMPlex.pyx:3996

Parameters:

tr_type (DMPlexTransformType | str)

Return type:

None

setUp()

Setup a mesh transformation.

Collective.

Source code at petsc4py/PETSc/DMPlex.pyx:3986

Return type:

Self

view(viewer=None)

View the mesh transformation.

Collective.

Parameters:

viewer (Viewer | None) – A Viewer instance or None for the default viewer.

Return type:

None

See also

Viewer, DMPlexTransformView

Source code at petsc4py/PETSc/DMPlex.pyx:4031