Skip to content

Doc build fix - do not refer to PETSc in function signatures #236

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
merged 1 commit into from
Nov 2, 2025
Merged

Doc build fix - do not refer to PETSc in function signatures #236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 6 additions & 9 deletions pyadjoint/optimization/tao_solver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,7 @@ def __init__(self, x, *, comm=None):
raise RuntimeError("petsctools not available")

x = Enlist(x)
if comm is None:
comm = PETSc.COMM_WORLD
if hasattr(comm, "tompi4py"):
comm = comm.tompi4py()
comm = valid_comm(comm)

vecs = tuple(x_i._ad_to_petsc() for x_i in x)
n = sum(vec.getLocalSize() for vec in vecs)
Expand Down Expand Up @@ -152,7 +149,7 @@ def valid_comm(comm):
comm: Optional[Any[petsc4py.PETSc.Comm,mpi4py.MPI.Comm]]

Returns:
mpi4py.MPI.Comm.COMM_WORLD if `comm is None`, otherwise `comm.tompi4py()`.
petsc4py.PETSc.COMM_WORLD if `comm is None`, otherwise `comm.tompi4py()`.
"""
if comm is None:
comm = PETSc.COMM_WORLD
Expand Down Expand Up @@ -202,7 +199,7 @@ def __init__(self, rf, *,
apply_riesz=False, appctx=None,
always_update_tape=False,
needs_functional_interface=False,
comm=PETSc.COMM_WORLD):
comm=None):
comm = valid_comm(comm)

self.rf = rf
Expand Down Expand Up @@ -307,7 +304,7 @@ class ReducedFunctionalHessianMat(ReducedFunctionalMatBase):
"""

def __init__(self, rf, *, apply_riesz=False, appctx=None,
always_update_tape=False, comm=PETSc.COMM_WORLD):
always_update_tape=False, comm=None):

super().__init__(rf, apply_riesz=apply_riesz, appctx=appctx,
needs_functional_interface=False,
Expand Down Expand Up @@ -350,7 +347,7 @@ class ReducedFunctionalAdjointMat(ReducedFunctionalMatBase):
"""

def __init__(self, rf, *, apply_riesz=False, appctx=None,
always_update_tape=False, comm=PETSc.COMM_WORLD):
always_update_tape=False, comm=None):

super().__init__(rf, apply_riesz=apply_riesz, appctx=appctx,
needs_functional_interface=True,
Expand Down Expand Up @@ -392,7 +389,7 @@ class ReducedFunctionalTLMMat(ReducedFunctionalMatBase):
comm (Optional[petsc4py.PETSc.Comm,mpi4py.MPI.Comm]): Communicator that the rf is defined over.
"""

def __init__(self, rf, *, appctx=None, always_update_tape=False, comm=PETSc.COMM_WORLD):
def __init__(self, rf, *, appctx=None, always_update_tape=False, comm=None):
super().__init__(rf, appctx=appctx, needs_functional_interface=True,
always_update_tape=always_update_tape, comm=comm)

Expand Down