Skip to content

Add more PETSc destruction notes to assembly functionality that creates PETSc.Mat/Vec objects #3524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhale merged 2 commits into from
Nov 21, 2024
Merged

Add more PETSc destruction notes to assembly functionality that creates PETSc.Mat/Vec objects #3524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
086fc6b
Add more PETSc destruction notes to assembly functionality that creat…
jorgensd Nov 20, 2024
deb009c
Ruff formatting
jorgensd Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion python/dolfinx/fem/petsc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ def fn(form):
def create_vector(L: Form) -> PETSc.Vec:
"""Create a PETSc vector that is compatible with a linear form.

Note:
Due to subtle issues in the interaction between petsc4py memory management
and the Python garbage collector, it is recommended that the method ``PETSc.Vec.destroy()``
is called on the returned object once the object is no longer required. Note that
``PETSc.Vec.destroy()`` is collective over the object's MPI communicator.

Args:
L: A linear form.

Expand Down Expand Up @@ -234,6 +240,12 @@ def assemble_vector(L: typing.Any, constants=None, coeffs=None) -> PETSc.Vec:
The returned vector is not finalised, i.e. ghost values are not
accumulated on the owning processes.

Note:
Due to subtle issues in the interaction between petsc4py memory management
and the Python garbage collector, it is recommended that the method ``PETSc.Vec.destroy()``
is called on the returned object once the object is no longer required. Note that
``PETSc.Vec.destroy()`` is collective over the object's MPI communicator.

Args:
L: A linear form.

Expand Down Expand Up @@ -273,6 +285,12 @@ def _assemble_vector_vec(b: PETSc.Vec, L: Form, constants=None, coeffs=None) ->
def assemble_vector_nest(L: typing.Any, constants=None, coeffs=None) -> PETSc.Vec:
"""Assemble linear forms into a new nested PETSc (``VecNest``) vector.

Note:
Due to subtle issues in the interaction between petsc4py memory management
and the Python garbage collector, it is recommended that the method ``PETSc.Vec.destroy()``
is called on the returned object once the object is no longer required. Note that
``PETSc.Vec.destroy()`` is collective over the object's MPI communicator.

The returned vector is not finalised, i.e. ghost values are not
accumulated on the owning processes.
"""
Expand Down Expand Up @@ -319,6 +337,12 @@ def assemble_vector_block(
) -> PETSc.Vec:
"""Assemble linear forms into a monolithic vector.

Note:
Due to subtle issues in the interaction between petsc4py memory management
and the Python garbage collector, it is recommended that the method ``PETSc.Vec.destroy()``
is called on the returned object once the object is no longer required. Note that
``PETSc.Vec.destroy()`` is collective over the object's MPI communicator.

The vector is not finalised, i.e. ghost values are not accumulated.
"""
maps = [
Expand Down Expand Up @@ -435,6 +459,12 @@ def assemble_matrix(
The returned matrix is not 'assembled', i.e. ghost contributions
have not been communicated.

Note:
Due to subtle issues in the interaction between petsc4py memory management
and the Python garbage collector, it is recommended that the method ``PETSc.Mat.destroy()``
is called on the returned object once the object is no longer required. Note that
``PETSc.Mat.destroy()`` is collective over the object's MPI communicator.

Args:
a: Bilinear form to assembled into a matrix.
bc: Dirichlet boundary conditions applied to the system.
Expand Down Expand Up @@ -489,6 +519,12 @@ def assemble_matrix_nest(
) -> PETSc.Mat:
"""Create a nested matrix and assemble bilinear forms into the matrix.

Note:
Due to subtle issues in the interaction between petsc4py memory management
and the Python garbage collector, it is recommended that the method ``PETSc.Mat.destroy()``
is called on the returned object once the object is no longer required. Note that
``PETSc.Mat.destroy()`` is collective over the object's MPI communicator.

Args:
a: Rectangular (list-of-lists) array for bilinear forms.
bcs: Dirichlet boundary conditions.
Expand Down Expand Up @@ -576,7 +612,15 @@ def assemble_matrix_block(
constants=None,
coeffs=None,
) -> PETSc.Mat: # type: ignore
"""Assemble bilinear forms into a blocked matrix."""
"""Assemble bilinear forms into a blocked matrix.

Note:
Due to subtle issues in the interaction between petsc4py memory management
and the Python garbage collector, it is recommended that the method ``PETSc.Mat.destroy()``
is called on the returned object once the object is no longer required. Note that
``PETSc.Mat.destroy()`` is collective over the object's MPI communicator.

"""
_a = [[None if form is None else form._cpp_object for form in arow] for arow in a]
A = _cpp.fem.petsc.create_matrix_block(_a)
return _assemble_matrix_block_mat(A, a, bcs, diagonal, constants, coeffs)
Expand Down