Vec

Provides the vector operations required for setting up and solving large-scale linear and nonlinear problems. Includes easy-to-use parallel scatter and gather operations, as well as special-purpose code for handling ghost points for regular data structures.

Mat

A large suite of data structures and code for the manipulation of parallel sparse matrices. Includes several different parallel matrix data structures, each appropriate for a different class of problems.

PC

A collection of sequential and parallel preconditioners, including (sequential) ILU(k), LU, and (both sequential and parallel) block Jacobi, overlapping additive Schwarz methods.

KSP

Parallel implementations of many popular Krylov subspace iterative methods, including GMRES, CG, CGS, Bi-CG-Stab, two variants of TFQMR, CR, and LSQR. All are coded so that they are immediately usable with any preconditioners and any matrix data structures, including matrix-free methods.

SNES

Data-structure-neutral implementations of Newton-like methods for nonlinear systems. Includes both line search and trust region techniques with a single interface. Employs by default the above data structures and linear solvers. Users can set custom monitoring routines, convergence criteria, etc.

TS

Code for the time evolution of solutions of PDEs. In addition, provides pseudo-transient continuation techniques for computing steady-state solutions.

petsc4py.get_config()

Return a dictionary with information about PETSc.

petsc4py.get_include()

Return the directory in the package that contains header files.

Extension modules that need to compile against petsc4py should use this function to locate the appropriate include directory.

Example

Using Python distutils or NumPy distutils:

import petsc4py
Extension('extension_name', ...


          include_dirs=[..., petsc4py.get_include()])

petsc4py.init(args=None, arch=None, comm=None)

Initialize PETSc.

Notes

This function should be called only once, typically at the very beginning of the bootstrap script of an application.

petsc4py.typing.Scalar = float | complex

Scalar type.

Scalars can be either float <https://docs.python.org/3/library/functions.html#float> or complex <https://docs.python.org/3/library/functions.html#complex> (but not both) depending on how PETSc was configured (./configure --with-scalar-type=real|complex).

petsc4py.typing.ArrayBool

Array of bool <https://docs.python.org/3/library/functions.html#bool>.

alias of ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>[tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Any <https://docs.python.org/3/library/typing.html#typing.Any>, ...], dtype <https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype>[bool <https://docs.python.org/3/library/functions.html#bool>]]

petsc4py.typing.ArrayInt

Array of int <https://docs.python.org/3/library/functions.html#int>.

alias of ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>[tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Any <https://docs.python.org/3/library/typing.html#typing.Any>, ...], dtype <https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype>[int <https://docs.python.org/3/library/functions.html#int>]]

petsc4py.typing.ArrayReal

Array of float <https://docs.python.org/3/library/functions.html#float>.

alias of ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>[tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Any <https://docs.python.org/3/library/typing.html#typing.Any>, ...], dtype <https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype>[float <https://docs.python.org/3/library/functions.html#float>]]

petsc4py.typing.ArrayComplex

Array of complex <https://docs.python.org/3/library/functions.html#complex>.

alias of ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>[tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Any <https://docs.python.org/3/library/typing.html#typing.Any>, ...], dtype <https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype>[complex <https://docs.python.org/3/library/functions.html#complex>]]

petsc4py.typing.ArrayScalar

Array of Scalar <#petsc4py.typing.Scalar> numbers.

alias of ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>[tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Any <https://docs.python.org/3/library/typing.html#typing.Any>, ...], dtype <https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype>[float <https://docs.python.org/3/library/functions.html#float> | complex <https://docs.python.org/3/library/functions.html#complex>]]

petsc4py.typing.DimsSpec

Dimensions specification.

N-tuples indicates N-dimensional grid sizes.

alias of tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[int <https://docs.python.org/3/library/functions.html#int>, ...]

petsc4py.typing.AccessModeSpec

Access mode specification.

alias of Literal <https://docs.python.org/3/library/typing.html#typing.Literal>['rw', 'r', 'w'] | None <https://docs.python.org/3/library/constants.html#None>

petsc4py.typing.InsertModeSpec = petsc4py.PETSc.InsertMode | bool | None

Insertion mode specification.

See also:

petsc4py.typing.ScatterModeSpec = petsc4py.PETSc.ScatterMode | bool | str | None

Scatter mode specification.

See also:

petsc4py.typing.LayoutSizeSpec = int | tuple[int, int]

int <https://docs.python.org/3/library/functions.html#int> or 2-tuple <https://docs.python.org/3/library/stdtypes.html#tuple> of int <https://docs.python.org/3/library/functions.html#int> describing the layout sizes.

A single int <https://docs.python.org/3/library/functions.html#int> indicates global size. A tuple <https://docs.python.org/3/library/stdtypes.html#tuple> of int <https://docs.python.org/3/library/functions.html#int> indicates (local_size, global_size).

See also:

petsc4py.typing.NormTypeSpec = petsc4py.PETSc.NormType | None

Norm type specification.

Possible values include:

See also:

petsc4py.typing.PetscOptionsHandlerFunction

Callback for processing extra options.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[Object <#petsc4py.PETSc.Object>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.MatAssemblySpec = petsc4py.PETSc.Mat.AssemblyType | bool | None

Matrix assembly specification.

See also:

petsc4py.typing.MatSizeSpec = int | tuple[int, int] | tuple[tuple[int, int], tuple[int, int]]

int <https://docs.python.org/3/library/functions.html#int> or (nested) tuple <https://docs.python.org/3/library/stdtypes.html#tuple> of int <https://docs.python.org/3/library/functions.html#int> describing the matrix sizes.

If int <https://docs.python.org/3/library/functions.html#int> then rows = columns. A single tuple <https://docs.python.org/3/library/stdtypes.html#tuple> of int <https://docs.python.org/3/library/functions.html#int> indicates (rows, columns). A nested tuple <https://docs.python.org/3/library/stdtypes.html#tuple> of int <https://docs.python.org/3/library/functions.html#int> indicates ((local_rows, rows), (local_columns, columns)).

See also:

petsc4py.typing.MatBlockSizeSpec = int | tuple[int, int]

The row and column block sizes.

If a single int <https://docs.python.org/3/library/functions.html#int> is provided then rows and columns share the same block size.

petsc4py.typing.CSRIndicesSpec

CSR indices format specification.

A 2-tuple carrying the (row_start, col_indices) information.

alias of tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[int <https://docs.python.org/3/library/functions.html#int>], Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[int <https://docs.python.org/3/library/functions.html#int>]]

petsc4py.typing.CSRSpec

CSR format specification.

A 3-tuple carrying the (row_start, col_indices, values) information.

alias of tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[int <https://docs.python.org/3/library/functions.html#int>], Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[int <https://docs.python.org/3/library/functions.html#int>], Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[float <https://docs.python.org/3/library/functions.html#float> | complex <https://docs.python.org/3/library/functions.html#complex>]]

petsc4py.typing.NNZSpec

Nonzero pattern specification.

A single int <https://docs.python.org/3/library/functions.html#int> corresponds to fixed number of non-zeros per row. A Sequence <https://docs.python.org/3/glossary.html#term-sequence> of int <https://docs.python.org/3/library/functions.html#int> indicates different non-zeros per row. If a 2-tuple <https://docs.python.org/3/library/stdtypes.html#tuple> is used, the elements of the tuple corresponds to the on-process and off-process parts of the matrix.

See also:

alias of int <https://docs.python.org/3/library/functions.html#int> | Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[int <https://docs.python.org/3/library/functions.html#int>] | tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[int <https://docs.python.org/3/library/functions.html#int>], Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>[int <https://docs.python.org/3/library/functions.html#int>]]

petsc4py.typing.MatNullFunction

PETSc.NullSpace <#petsc4py.PETSc.NullSpace> callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[NullSpace <#petsc4py.PETSc.NullSpace>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.DMCoarsenHookFunction

PETSc.DM <#petsc4py.PETSc.DM> coarsening hook callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[DM <#petsc4py.PETSc.DM>, DM <#petsc4py.PETSc.DM>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.DMRestrictHookFunction

PETSc.DM <#petsc4py.PETSc.DM> restriction hook callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[DM <#petsc4py.PETSc.DM>, Mat <#petsc4py.PETSc.Mat>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>, DM <#petsc4py.PETSc.DM>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.KSPRHSFunction

PETSc.KSP <#petsc4py.PETSc.KSP> right-hand side function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[KSP <#petsc4py.PETSc.KSP>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.KSPOperatorsFunction

PETSc.KSP <#petsc4py.PETSc.KSP> operators function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[KSP <#petsc4py.PETSc.KSP>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.KSPConvergenceTestFunction

PETSc.KSP <#petsc4py.PETSc.KSP> convergence test callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[KSP <#petsc4py.PETSc.KSP>, int <https://docs.python.org/3/library/functions.html#int>, float <https://docs.python.org/3/library/functions.html#float>], ConvergedReason <#petsc4py.PETSc.KSP.ConvergedReason>]

petsc4py.typing.KSPMonitorFunction

PETSc.KSP <#petsc4py.PETSc.KSP> monitor callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[KSP <#petsc4py.PETSc.KSP>, int <https://docs.python.org/3/library/functions.html#int>, float <https://docs.python.org/3/library/functions.html#float>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.KSPPreSolveFunction

PETSc.KSP <#petsc4py.PETSc.KSP> pre solve callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[KSP <#petsc4py.PETSc.KSP>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.KSPPostSolveFunction

PETSc.KSP <#petsc4py.PETSc.KSP> post solve callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[KSP <#petsc4py.PETSc.KSP>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESMonitorFunction

SNES <#petsc4py.PETSc.SNES> monitor callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, int <https://docs.python.org/3/library/functions.html#int>, float <https://docs.python.org/3/library/functions.html#float>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESObjFunction

SNES <#petsc4py.PETSc.SNES> objective function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESFunction

SNES <#petsc4py.PETSc.SNES> residual function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESJacobianFunction

SNES <#petsc4py.PETSc.SNES> Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESGuessFunction

SNES <#petsc4py.PETSc.SNES> initial guess callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESUpdateFunction

SNES <#petsc4py.PETSc.SNES> step update callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, int <https://docs.python.org/3/library/functions.html#int>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESLSPreFunction

SNES <#petsc4py.PETSc.SNES> linesearch pre-check update callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESNGSFunction

SNES <#petsc4py.PETSc.SNES> nonlinear Gauss-Seidel callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.SNESConvergedFunction

SNES <#petsc4py.PETSc.SNES> convergence test callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[SNES <#petsc4py.PETSc.SNES>, int <https://docs.python.org/3/library/functions.html#int>, tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[float <https://docs.python.org/3/library/functions.html#float>, float <https://docs.python.org/3/library/functions.html#float>, float <https://docs.python.org/3/library/functions.html#float>]], ConvergedReason <#petsc4py.PETSc.SNES.ConvergedReason>]

petsc4py.typing.TSRHSFunction

TS <#petsc4py.PETSc.TS> right-hand side function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSRHSJacobian

TS <#petsc4py.PETSc.TS> right-hand side Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSRHSJacobianP

TS <#petsc4py.PETSc.TS> right-hand side parameter Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSIFunction

TS <#petsc4py.PETSc.TS> implicit function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSIJacobian

TS <#petsc4py.PETSc.TS> implicit Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, float <https://docs.python.org/3/library/functions.html#float>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSIJacobianP

TS <#petsc4py.PETSc.TS> implicit parameter Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, float <https://docs.python.org/3/library/functions.html#float>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSI2Function

TS <#petsc4py.PETSc.TS> implicit 2nd order function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSI2Jacobian

TS <#petsc4py.PETSc.TS> implicit 2nd order Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, float <https://docs.python.org/3/library/functions.html#float>, float <https://docs.python.org/3/library/functions.html#float>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSI2JacobianP

TS <#petsc4py.PETSc.TS> implicit 2nd order parameter Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>, float <https://docs.python.org/3/library/functions.html#float>, float <https://docs.python.org/3/library/functions.html#float>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSMonitorFunction

TS <#petsc4py.PETSc.TS> monitor callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, int <https://docs.python.org/3/library/functions.html#int>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSPreStepFunction

TS <#petsc4py.PETSc.TS> pre-step callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSPostStepFunction

TS <#petsc4py.PETSc.TS> post-step callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSIndicatorFunction

TS <#petsc4py.PETSc.TS> event indicator callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>[tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Any <https://docs.python.org/3/library/typing.html#typing.Any>, ...], dtype <https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype>[float <https://docs.python.org/3/library/functions.html#float>]]], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TSPostEventFunction

TS <#petsc4py.PETSc.TS> post-event callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TS <#petsc4py.PETSc.TS>, ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray>[tuple <https://docs.python.org/3/library/stdtypes.html#tuple>[Any <https://docs.python.org/3/library/typing.html#typing.Any>, ...], dtype <https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype>[int <https://docs.python.org/3/library/functions.html#int>]], float <https://docs.python.org/3/library/functions.html#float>, Vec <#petsc4py.PETSc.Vec>, bool <https://docs.python.org/3/library/functions.html#bool>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOObjectiveFunction

TAO <#petsc4py.PETSc.TAO> objective function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>], float <https://docs.python.org/3/library/functions.html#float>]

petsc4py.typing.TAOGradientFunction

TAO <#petsc4py.PETSc.TAO> objective gradient callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOObjectiveGradientFunction

TAO <#petsc4py.PETSc.TAO> objective function and gradient callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], float <https://docs.python.org/3/library/functions.html#float>]

petsc4py.typing.TAOHessianFunction

TAO <#petsc4py.PETSc.TAO> objective Hessian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOUpdateFunction

TAO <#petsc4py.PETSc.TAO> update callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, int <https://docs.python.org/3/library/functions.html#int>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOMonitorFunction

TAO <#petsc4py.PETSc.TAO> monitor callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOConvergedFunction

TAO <#petsc4py.PETSc.TAO> convergence test callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOJacobianFunction

TAO <#petsc4py.PETSc.TAO> Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOResidualFunction

TAO <#petsc4py.PETSc.TAO> residual callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOJacobianResidualFunction

TAO <#petsc4py.PETSc.TAO> Jacobian residual callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOVariableBoundsFunction

TAO <#petsc4py.PETSc.TAO> variable bounds callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOConstraintsFunction

TAO <#petsc4py.PETSc.TAO> constraints callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOConstraintsJacobianFunction

TAO <#petsc4py.PETSc.TAO> constraints Jacobian callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAO <#petsc4py.PETSc.TAO>, Vec <#petsc4py.PETSc.Vec>, Mat <#petsc4py.PETSc.Mat>, Mat <#petsc4py.PETSc.Mat>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOLSObjectiveFunction

TAOLineSearch <#petsc4py.PETSc.TAOLineSearch> objective function callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAOLineSearch <#petsc4py.PETSc.TAOLineSearch>, Vec <#petsc4py.PETSc.Vec>], float <https://docs.python.org/3/library/functions.html#float>]

petsc4py.typing.TAOLSGradientFunction

TAOLineSearch <#petsc4py.PETSc.TAOLineSearch> objective gradient callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAOLineSearch <#petsc4py.PETSc.TAOLineSearch>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], None <https://docs.python.org/3/library/constants.html#None>]

petsc4py.typing.TAOLSObjectiveGradientFunction

TAOLineSearch <#petsc4py.PETSc.TAOLineSearch> objective function and gradient callback.

alias of Callable <https://docs.python.org/3/library/typing.html#typing.Callable>[[TAOLineSearch <#petsc4py.PETSc.TAOLineSearch>, Vec <#petsc4py.PETSc.Vec>, Vec <#petsc4py.PETSc.Vec>], float <https://docs.python.org/3/library/functions.html#float>]

DECIDE <#petsc4py.PETSc.DECIDE>

Use a default value for an int <https://docs.python.org/3/library/functions.html#int> or float <https://docs.python.org/3/library/functions.html#float> parameter.

DEFAULT <#petsc4py.PETSc.DEFAULT>

Use a default value chosen by PETSc.

DETERMINE <#petsc4py.PETSc.DETERMINE>

Compute a default value for an int <https://docs.python.org/3/library/functions.html#int> or float <https://docs.python.org/3/library/functions.html#float> parameter. For tolerances this uses the default value from when the object's type was set.

CURRENT <#petsc4py.PETSc.CURRENT>

Do not change the current value that is set.

UNLIMITED <#petsc4py.PETSc.UNLIMITED>

For a parameter that is a bound, such as the maximum number of iterations, do not bound the value.

INFINITY <#petsc4py.PETSc.INFINITY>

Very large real value.

NINFINITY <#petsc4py.PETSc.NINFINITY>

Very large negative real value.

PINFINITY <#petsc4py.PETSc.PINFINITY>

Very large positive real value, same as INFINITY <#petsc4py.PETSc.INFINITY>.

class petsc4py.PETSc.AO

Bases: Object <#petsc4py.PETSc.Object>

Application ordering object.

Enumerations

Type <#petsc4py.PETSc.AO.Type>

The application ordering types.

class petsc4py.PETSc.AO.Type

Bases: object <https://docs.python.org/3/library/functions.html#object>

The application ordering types.

Attributes Summary

ADVANCED	Object ADVANCED of type str <https://docs.python.org/3/library/stdtypes.html#str>
BASIC	Object BASIC of type str <https://docs.python.org/3/library/stdtypes.html#str>
MAPPING	Object MAPPING of type str <https://docs.python.org/3/library/stdtypes.html#str>
MEMORYSCALABLE	Object MEMORYSCALABLE of type str <https://docs.python.org/3/library/stdtypes.html#str>

Attributes Documentation

app2petsc(indices)

Map an application-defined ordering to the PETSc ordering.

Collective.

Any integers in indices that are negative are left unchanged. This allows one to convert, for example, neighbor lists that use negative entries to indicate nonexistent neighbors due to boundary conditions, etc.

Integers that are out of range are mapped to -1.

If IS is used, it cannot be of type stride or block.

See also:

Source code at petsc4py/PETSc/AO.pyx:214 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L214>

createBasic(app, petsc=None, comm=None)

Return a basic application ordering using two orderings.

Collective.

The arrays/indices app and petsc must contain all the integers 0 to len(app)-1 with no duplicates; that is there cannot be any "holes" in the indices. Use createMapping if you wish to have "holes" in the indices.

See also:

Source code at petsc4py/PETSc/AO.pyx:53 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L53>

createMapping(app, petsc=None, comm=None)

Return an application mapping using two orderings.

Collective.

The arrays app and petsc need NOT contain all the integers 0 to len(app)-1, that is there CAN be "holes" in the indices. Use createBasic if they do not have holes for better performance.

See also:

Source code at petsc4py/PETSc/AO.pyx:154 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L154>

createMemoryScalable(app, petsc=None, comm=None)

Return a memory scalable application ordering using two orderings.

Collective.

The arrays/indices app and petsc must contain all the integers 0 to len(app)-1 with no duplicates; that is there cannot be any "holes" in the indices. Use createMapping if you wish to have "holes" in the indices.

Comparing with createBasic, this routine trades memory with message communication.

See also:

Source code at petsc4py/PETSc/AO.pyx:102 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L102>

destroy()

Destroy the application ordering.

Collective.

See also:

Source code at petsc4py/PETSc/AO.pyx:40 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L40>

getType()

Return the application ordering type.

Not collective.

See also:

Source code at petsc4py/PETSc/AO.pyx:200 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L200>

petsc2app(indices)

Map a PETSc ordering to the application-defined ordering.

Collective.

Any integers in indices that are negative are left unchanged. This allows one to convert, for example, neighbor lists that use negative entries to indicate nonexistent neighbors due to boundary conditions, etc.

Integers that are out of range are mapped to -1.

If IS is used, it cannot be of type stride or block.

See also:

Source code at petsc4py/PETSc/AO.pyx:248 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L248>

view(viewer=None)

Display the application ordering.

Collective.

See also:

Source code at petsc4py/PETSc/AO.pyx:21 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/AO.pyx#L21>

class petsc4py.PETSc.CellDM

Bases: Object <#petsc4py.PETSc.Object>

CellDM object.

See also:

Methods Summary

Methods Documentation

class petsc4py.PETSc.Comm

Bases: object <https://docs.python.org/3/library/functions.html#object>

Communicator object.

Predefined instances:

See also:

Methods Summary

Attributes Summary

Methods Documentation

Attributes Documentation

class petsc4py.PETSc.DM

Bases: Object <#petsc4py.PETSc.Object>

An object describing a computational grid or mesh.

Enumerations

BoundaryType <#petsc4py.PETSc.DM.BoundaryType>	DM Boundary types.
PolytopeType <#petsc4py.PETSc.DM.PolytopeType>	The DM cell types.
ReorderDefaultFlag <#petsc4py.PETSc.DM.ReorderDefaultFlag>	The DM reordering default flags.
Type <#petsc4py.PETSc.DM.Type>	DM types.

class petsc4py.PETSc.DM.BoundaryType

Bases: object <https://docs.python.org/3/library/functions.html#object>

DM <#petsc4py.PETSc.DM> Boundary types.

Attributes Summary

GHOSTED	Constant GHOSTED of type int <https://docs.python.org/3/library/functions.html#int>
MIRROR	Constant MIRROR of type int <https://docs.python.org/3/library/functions.html#int>
NONE	Constant NONE of type int <https://docs.python.org/3/library/functions.html#int>
PERIODIC	Constant PERIODIC of type int <https://docs.python.org/3/library/functions.html#int>
TWIST	Constant TWIST of type int <https://docs.python.org/3/library/functions.html#int>

Attributes Documentation

class petsc4py.PETSc.DM.PolytopeType

Bases: object <https://docs.python.org/3/library/functions.html#object>

The DM <#petsc4py.PETSc.DM> cell types.

Attributes Summary

FV_GHOST	Constant FV_GHOST of type int <https://docs.python.org/3/library/functions.html#int>
HEXAHEDRON	Constant HEXAHEDRON of type int <https://docs.python.org/3/library/functions.html#int>
INTERIOR_GHOST	Constant INTERIOR_GHOST of type int <https://docs.python.org/3/library/functions.html#int>
POINT	Constant POINT of type int <https://docs.python.org/3/library/functions.html#int>
POINT_PRISM_TENSOR	Constant POINT_PRISM_TENSOR of type int <https://docs.python.org/3/library/functions.html#int>
PYRAMID	Constant PYRAMID of type int <https://docs.python.org/3/library/functions.html#int>
QUADRILATERAL	Constant QUADRILATERAL of type int <https://docs.python.org/3/library/functions.html#int>
QUAD_PRISM_TENSOR	Constant QUAD_PRISM_TENSOR of type int <https://docs.python.org/3/library/functions.html#int>
SEGMENT	Constant SEGMENT of type int <https://docs.python.org/3/library/functions.html#int>
SEG_PRISM_TENSOR	Constant SEG_PRISM_TENSOR of type int <https://docs.python.org/3/library/functions.html#int>
TETRAHEDRON	Constant TETRAHEDRON of type int <https://docs.python.org/3/library/functions.html#int>
TRIANGLE	Constant TRIANGLE of type int <https://docs.python.org/3/library/functions.html#int>
TRI_PRISM	Constant TRI_PRISM of type int <https://docs.python.org/3/library/functions.html#int>
TRI_PRISM_TENSOR	Constant TRI_PRISM_TENSOR of type int <https://docs.python.org/3/library/functions.html#int>
UNKNOWN	Constant UNKNOWN of type int <https://docs.python.org/3/library/functions.html#int>
UNKNOWN_CELL	Constant UNKNOWN_CELL of type int <https://docs.python.org/3/library/functions.html#int>
UNKNOWN_FACE	Constant UNKNOWN_FACE of type int <https://docs.python.org/3/library/functions.html#int>

Attributes Documentation

class petsc4py.PETSc.DM.ReorderDefaultFlag

Bases: object <https://docs.python.org/3/library/functions.html#object>

The DM <#petsc4py.PETSc.DM> reordering default flags.

Attributes Summary

FALSE	Constant FALSE of type int <https://docs.python.org/3/library/functions.html#int>
NOTSET	Constant NOTSET of type int <https://docs.python.org/3/library/functions.html#int>
TRUE	Constant TRUE of type int <https://docs.python.org/3/library/functions.html#int>

Attributes Documentation

class petsc4py.PETSc.DM.Type

Bases: object <https://docs.python.org/3/library/functions.html#object>

DM <#petsc4py.PETSc.DM> types.

Attributes Summary

COMPOSITE	Object COMPOSITE of type str <https://docs.python.org/3/library/stdtypes.html#str>
DA	Object DA of type str <https://docs.python.org/3/library/stdtypes.html#str>
FOREST	Object FOREST of type str <https://docs.python.org/3/library/stdtypes.html#str>
MOAB	Object MOAB of type str <https://docs.python.org/3/library/stdtypes.html#str>
NETWORK	Object NETWORK of type str <https://docs.python.org/3/library/stdtypes.html#str>
P4EST	Object P4EST of type str <https://docs.python.org/3/library/stdtypes.html#str>
P8EST	Object P8EST of type str <https://docs.python.org/3/library/stdtypes.html#str>
PATCH	Object PATCH of type str <https://docs.python.org/3/library/stdtypes.html#str>
PLEX	Object PLEX of type str <https://docs.python.org/3/library/stdtypes.html#str>
PRODUCT	Object PRODUCT of type str <https://docs.python.org/3/library/stdtypes.html#str>
REDUNDANT	Object REDUNDANT of type str <https://docs.python.org/3/library/stdtypes.html#str>
SHELL	Object SHELL of type str <https://docs.python.org/3/library/stdtypes.html#str>
SLICED	Object SLICED of type str <https://docs.python.org/3/library/stdtypes.html#str>
STAG	Object STAG of type str <https://docs.python.org/3/library/stdtypes.html#str>
SWARM	Object SWARM of type str <https://docs.python.org/3/library/stdtypes.html#str>

Attributes Documentation

adaptLabel(label)

Adapt a DM based on a DMLabel <#petsc4py.PETSc.DMLabel>.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1713 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1713>

adaptMetric(metric, bdLabel=None, rgLabel=None)

Return a mesh adapted to the specified metric field.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1736 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1736>

addCoarsenHook(coarsenhook, restricthook, args=None, kargs=None)

Add a callback to be executed when restricting to a coarser grid.

Logically collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2400 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2400>

addField(field, label=None)

Add a field to a DM object.

Logically collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:611 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L611>

appendOptionsPrefix(prefix)

Append to the prefix used for searching for options in the database.

Logically collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:298 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L298>

clearDS()

Remove all discrete systems from the DM.

Logically collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:691 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L691>

clearFields()

Remove all fields from the DM.

Logically collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:634 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L634>

clearLabelStratum(name, value)

Remove all points from a stratum.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2192 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2192>

clearLabelValue(name, point, value)

Remove a point from a DMLabel <#petsc4py.PETSc.DMLabel> with given value.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2078 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2078>

clone()

Return the cloned DM .

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:155 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L155>

coarsen(comm=None)

Return a coarsened DM object.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1587 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1587>

coarsenHierarchy(nlevels)

Coarsen this DM and return the coarsened DM hierarchy.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1638 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1638>

convert(dm_type)

Return a DM converted to another DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1540 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1540>

copyDS(dm, minDegree=None, maxDegree=None)

Copy the discrete systems for this DM into another DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:718 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L718>

copyDisc(dm)

Copy fields and discrete systems of a DM into another DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:751 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L751>

copyFields(dm, minDegree=None, maxDegree=None)

Copy the discretizations of this DM into another DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:646 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L646>

create(comm=None)

Return an empty DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:134 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L134>

createDS()

Create discrete systems.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:679 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L679>

createFieldDecomposition()

Return field splitting information.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2290 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2290>

createGlobalVec()

Return a global vector.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:798 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L798>

createInjection(dm)

Return the injection matrix into a finer DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1502 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1502>

createInterpolation(dm)

Return the interpolation matrix to a finer DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1481 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1481>

createLabel(name)

Create a label of the given name if it does not already exist.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1990 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1990>

createLocalVec()

Return a local vector.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:812 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L812>

createMassMatrix(dmf)

Return the mass matrix between this DM and the given DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1462 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1462>

createMat()

Return an empty matrix.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1448 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1448>

createRestriction(dm)

Return the restriction matrix between this DM and the given DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1521 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1521>

createSectionSF(localsec, globalsec)

Create the SF <#petsc4py.PETSc.SF> encoding the parallel DOF overlap for the DM.

Collective.

Notes

Encoding based on the Section <#petsc4py.PETSc.Section> describing the data layout.

See also:

Source code at petsc4py/PETSc/DM.pyx:1854 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1854>

createSubDM(fields)

Return IS <#petsc4py.PETSc.IS> and DM encapsulating a subproblem.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:446 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L446>

destroy()

Destroy the object.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:121 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L121>

getAppCtx()

Return the application context.

Source code at petsc4py/PETSc/DM.pyx:343 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L343>

getAuxiliaryVec(label=None, value=0, part=0)

Return an auxiliary vector for region.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:503 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L503>

getBasicAdjacency()

Return the flags for determining variable influence.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:370 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L370>

getBlockSize()

Return the inherent block size associated with a DM.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:770 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L770>

getBoundingBox()

Return the dimension of embedding space for coordinates values.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1311 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1311>

getCellCoordinateDM()

Return the cell coordinate DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1159 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1159>

getCellCoordinateSection()

Return the cell coordinate layout over the DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1194 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1194>

getCellCoordinates()

Return a global vector with the cellwise coordinates.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1226 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1226>

getCellCoordinatesLocal()

Return a local vector with the cellwise coordinates.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1258 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1258>

getCoarseDM()

Return the coarse DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1020 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1020>

getCoarsenLevel()

Return the number of coarsenings.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1697 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1697>

getCoordinateDM()

Return the coordinate DM.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1048 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1048>

getCoordinateDim()

Return the dimension of embedding space for coordinates values.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:238 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L238>

getCoordinateSection()

Return coordinate values layout over the mesh.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1063 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1063>

getCoordinates()

Return a global vector with the coordinates associated.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1095 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1095>

getCoordinatesLocal()

Return a local vector with the coordinates associated.

Collective the first time it is called.

See also:

Source code at petsc4py/PETSc/DM.pyx:1127 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1127>

getCoordinatesLocalized()

Check if the coordinates have been localized for cells.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1297 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1297>

getDS()

Return default DS <#petsc4py.PETSc.DS>.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:703 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L703>

getDimension()

Return the topological dimension of the DM.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:206 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L206>

getField(index)

Return the discretization object for a given DM field.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:586 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L586>

getFieldAdjacency(field)

Return the flags for determining variable influence.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:416 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L416>

getGlobalSection()

Return the Section <#petsc4py.PETSc.Section> encoding the global data layout for the DM.

Collective the first time it is called.

See also:

Source code at petsc4py/PETSc/DM.pyx:1830 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1830>

getGlobalVec(name=None)

Return a global vector.

Collective.

Notes

When done with the vector, it must be restored using restoreGlobalVec.

See also:

Source code at petsc4py/PETSc/DM.pyx:826 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L826>

getLGMap()

Return local mapping to global mapping.

Collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1003 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1003>

getLabel(name)

Return the label of a given name.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1772 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1772>

getLabelIdIS(name)

Return an IS <#petsc4py.PETSc.IS> of all values that the DMLabel <#petsc4py.PETSc.DMLabel> takes.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2123 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2123>

getLabelName(index)

Return the name of nth label.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1949 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1949>

getLabelOutput(name)

Return the output flag for a given label.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2236 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2236>

getLabelSize(name)

Return the number of values that the DMLabel <#petsc4py.PETSc.DMLabel> takes.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2102 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2102>

getLabelValue(name, point)

Return the value in DMLabel <#petsc4py.PETSc.DMLabel> for the given point.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2031 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2031>

getLocalBoundingBox()

Return the bounding box for the piece of the DM.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1328 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1328>

getLocalSection()

Return the Section <#petsc4py.PETSc.Section> encoding the local data layout for the DM.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1803 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1803>

getLocalVec(name=None)

Return a local vector.

Not collective.

Notes

When done with the vector, it must be restored using restoreLocalVec.

See also:

Source code at petsc4py/PETSc/DM.pyx:880 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L880>

getNumFields()

Return the number of fields in the DM.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:546 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L546>

getNumLabels()

Return the number of labels defined by on the DM.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1935 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1935>

getOptionsPrefix()

Return the prefix used for searching for options in the database.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:284 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L284>

getPeriodicity()

Set the description of mesh periodicity.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1362 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1362>

getPointSF()

Return the SF <#petsc4py.PETSc.SF> encoding the parallel DOF overlap for the DM.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1908 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1908>

getRefineLevel()

Return the refinement level.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1665 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1665>

getSectionSF()

Return the Section <#petsc4py.PETSc.Section> encoding the parallel DOF overlap.

Collective the first time it is called.

See also:

Source code at petsc4py/PETSc/DM.pyx:1877 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1877>

getStratumIS(name, value)

Return the points in a label stratum.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2168 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2168>

getStratumSize(name, value)

Return the number of points in a label stratum.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:2144 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L2144>

getType()

Return the DM type name.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:192 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L192>

globalToLocal(vg, vl, addv=None)

Update local vectors from global vector.

Neighborwise collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:934 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L934>

hasLabel(name)

Determine whether the DM has a label.

Not collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:1969 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1969>

load(viewer)

Return a DM stored in binary.

Collective.

Notes

When using Viewer.Type.HDF5 <#petsc4py.PETSc.Viewer.Type.HDF5> format, one can save multiple DMPlex <#petsc4py.PETSc.DMPlex> meshes in a single HDF5 files. This in turn requires one to name the DMPlex <#petsc4py.PETSc.DMPlex> object with Object.setName <#petsc4py.PETSc.Object.setName> before saving it with DM.view and before loading it with DM.load for identification of the mesh object.

See also:

Source code at petsc4py/PETSc/DM.pyx:95 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L95>

localToGlobal(vl, vg, addv=None)

Update global vectors from local vector.

Neighborwise collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:957 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L957>

localToLocal(vl, vlg, addv=None)

Map the values from a local vector to another local vector.

Neighborwise collective.

See also:

Source code at petsc4py/PETSc/DM.pyx:980 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L980>

localizeCoordinates()

Create local coordinates for cells having periodic faces.

Collective.

Notes

Used if the mesh is periodic.

See also:

Source code at petsc4py/PETSc/DM.pyx:1345 <https://gitlab.com/petsc/petsc/-/tree/release/src/binding/petsc4py/src/petsc4py/PETSc/DM.pyx#L1345>

refine(comm=None)

Return a refined DM object.

Collective.