Skip to main content
`Ctrl`+`K`

# petsc4py.PETSc

Portable, Extensible Toolkit for Scientific Computation.

Basic constants:

`DECIDE`

  Use a default value for an `int` or `float` parameter.

`DEFAULT`

  Use a default value chosen by PETSc.

`DETERMINE`

  Compute a default value for an `int` or `float` parameter. For tolerances this uses the default value from when the object’s type was set.

`CURRENT`

  Do not change the current value that is set.

`UNLIMITED`

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

More constants:

`INFINITY`

  Very large real value.

`NINFINITY`

  Very large negative real value.

`PINFINITY`

  Very large positive real value, same as `INFINITY`.

Classes

`AO` | Application ordering object.
`CellDM` | CellDM object.
`Comm` | Communicator object.
`DM` | An object describing a computational grid or mesh.
`DMComposite` | A DM object that is used to manage data for a collection of DMs.
`DMDA` | A DM object that is used to manage data for a structured grid.
`DMInterpolation` | Interpolation on a mesh.
`DMLabel` | An object representing a subset of mesh entities from a `DM`.
`DMPlex` | Encapsulate an unstructured mesh.
`DMPlexTransform` | Mesh transformations.
`DMPlexTransformType` | Transformation types.
`DMShell` | A shell DM object, used to manage user-defined problem data.
`DMStag` | A DM object representing a "staggered grid" or a structured cell complex.
`DMSwarm` | A `DM` object used to represent arrays of data (fields) of arbitrary type.
`DS` | Discrete System object.
`Device` | The device object.
`DeviceContext` | DeviceContext object.
`DualSpace` | Dual space to a linear space.
`FE` | A PETSc object that manages a finite element space.
`IS` | A collection of indices.
`InsertMode` | Insertion mode.
`KSP` | Abstract PETSc object that manages all Krylov methods.
`KSPDMActive` | Argument to KSPSetDMActive().
`LGMap` | Mapping from a local to a global ordering.
`Log` | Logging support.
`LogClass` | Logging support.
`LogEvent` | Logging support.
`LogStage` | Logging support for different stages.
`Mat` | Matrix object.
`MatPartitioning` | Object for managing the partitioning of a matrix or graph.
`NormType` | Norm type.
`NullSpace` | Nullspace object.
`Object` | Base class wrapping a PETSc object.
`Options` | The options database object.
`PC` | Preconditioners.
`Partitioner` | A graph partitioner.
`Quad` | Quadrature rule for integration.
`Random` | The random number generator object.
`Regressor` | Regression solver.
`RegressorLinearType` | Linear regressor type.
`SF` | Star Forest object for communication.
`SNES` | Nonlinear equations solver.
`SNESLineSearch` | Linesearch object used by SNES solvers.
`Scatter` | Scatter object.
`ScatterMode` | Scatter mode.
`Section` | Mapping from integers in a range to unstructured set of integers.
`Space` | Function space object.
`Sys` | System utilities.
`TAO` | Optimization solver.
`TAOLineSearch` | TAO Line Search.
`TAOTerm` | TAO Term.
`TS` | ODE integrator.
`Vec` | A vector object.
`Viewer` | Viewer object.
`ViewerHDF5` | Viewer object for HDF5 file formats.

Exceptions

`Error` | PETSc Error.

Functions

`garbage_cleanup`([comm]) | Clean up unused PETSc objects.
`garbage_view`([comm]) | Print summary of the garbage PETSc objects.

Attributes

`DECIDE` | Constant `DECIDE` of type `int`
`DEFAULT` | Constant `DEFAULT` of type `int`
`DETERMINE` | Constant `DETERMINE` of type `int`
`CURRENT` | Constant `CURRENT` of type `int`
`UNLIMITED` | Constant `UNLIMITED` of type `int`
`INFINITY` | Object `INFINITY` of type `float`
`NINFINITY` | Object `NINFINITY` of type `float`
`PINFINITY` | Object `PINFINITY` of type `float`
`COMM_NULL` | Object `COMM_NULL` of type `Comm`
`COMM_SELF` | Object `COMM_SELF` of type `Comm`
`COMM_WORLD` | Object `COMM_WORLD` of type `Comm`