Skip to content

Provide set of converged reasons for each PETSc object type #12

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Provide set of converged reasons for each PETSc object type #12

Show file tree
Hide file tree
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
14 changes: 14 additions & 0 deletions petsctools/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@
is_set_from_options,
inserted_options,
)
from .reasons import ( # noqa: F401
PCReasons,
KSPReasons,
SNESReasons,
TAOReasons,
TAOLineSearchReasons,
TSReasons,
)
else:

def __getattr__(name):
Expand All @@ -49,6 +57,12 @@ def __getattr__(name):
"set_from_options",
"is_set_from_options",
"inserted_options",
"PCReasons",
"KSPReasons",
"SNESReasons",
"TAOReasons",
"TAOLineSearchReasons",
"TSReasons",
}
if name in petsc4py_attrs:
raise ImportError(
Expand Down
14 changes: 14 additions & 0 deletions petsctools/reasons.py
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what this is supposed to be doing. Can this get some documentation?

Also is KSPReasons (for example) the best choice of name. I am unfamiliar with the code but would KSPConvergedReasons be better? (Just from looking at the petsc4py API we build on)

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
from petsc4py import PETSc


def _make_reasons(reasons):
return {getattr(reasons, r): r
for r in dir(reasons) if not r.startswith('_')}


PCReasons = _make_reasons(PETSc.PC.FailedReason())
KSPReasons = _make_reasons(PETSc.KSP.ConvergedReason())
SNESReasons = _make_reasons(PETSc.SNES.ConvergedReason())
TAOReasons = _make_reasons(PETSc.TAO.ConvergedReason())
TAOLineSearchReasons = _make_reasons(PETSc.TAOLineSearch.Reason())
TSReasons = _make_reasons(PETSc.TS.ConvergedReason())