petsc4py.PETSc.Partitioner
- class petsc4py.PETSc.Partitioner
Bases:
Object
A graph partitioner.
Enumerations
Methods Summary
create
([comm])Create an empty partitioner object.
destroy
()Destroy the partitioner object.
getType
()Return the partitioner type.
reset
()Reset data structures of the partitioner.
Set parameters in the partitioner from the options database.
setShellPartition
(numProcs[, sizes, points])Set a custom partition for a mesh.
setType
(part_type)Build a particular type of the partitioner.
setUp
()Construct data structures for the partitioner.
view
([viewer])View the partitioner.
Methods Documentation
- create(comm=None)
Create an empty partitioner object.
Collective.
The type can be set with
setType
.- Parameters:
comm (Comm | None) – MPI communicator, defaults to
Sys.getDefaultComm
.- Return type:
See also
setType
,petsc.PetscPartitionerCreate
- destroy()
Destroy the partitioner object.
Collective.
See also
petsc.PetscPartitionerDestroy
Source code at petsc4py/PETSc/Partitioner.pyx:42
- Return type:
- getType()
Return the partitioner type.
Not collective.
See also
setType
,petsc.PetscPartitionerGetType
Source code at petsc4py/PETSc/Partitioner.pyx:97
- Return type:
- reset()
Reset data structures of the partitioner.
Collective.
See also
petsc.PetscPartitionerReset
Source code at petsc4py/PETSc/Partitioner.pyx:135
- Return type:
- setFromOptions()
Set parameters in the partitioner from the options database.
Collective.
See also
Working with PETSc options (TODO),
petsc.PetscPartitionerSetFromOptions
Source code at petsc4py/PETSc/Partitioner.pyx:111
- Return type:
- setShellPartition(numProcs, sizes=None, points=None)
Set a custom partition for a mesh.
Collective.
- Parameters:
- Return type:
See also
petsc.PetscPartitionerShellSetPartition
- setType(part_type)
Build a particular type of the partitioner.
Collective.
See also
getType
,petsc.PetscPartitionerSetType
- setUp()
Construct data structures for the partitioner.
Collective.
See also
petsc.PetscPartitionerSetUp
Source code at petsc4py/PETSc/Partitioner.pyx:123
- Return type: