Skip to content

Fix up QBX refinement mode changes #314

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
inducer merged 1 commit into from
Apr 1, 2026
+13 −12
Merged

Fix up QBX refinement mode changes #314

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
2 changes: 1 addition & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
["py:class", r"optype.*"],
["py:class", r"onp.*"],
# sphinx >= 9.0 errors
["py:class", r"_not_provided"],
["py:class", r"NOT_PROVIDED"],
["py:class", r"Callable\[.*"],
]

Expand Down
4 changes: 0 additions & 4 deletions pytential/qbx/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,6 @@
.. autoclass:: NonFFTExpansionFactory

.. autodata:: FMMBackend

.. autoclass:: QBXRefinementMode

.. autoclass:: QBXRefinementNeededError
"""


Expand Down
19 changes: 12 additions & 7 deletions pytential/qbx/refinement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,20 +127,25 @@ class QBXRefinementMode(Enum):
Executing global QBX without refinement is unlikely to give
accurate results.

.. attribute:: COMPLAIN
.. attribute:: ERROR_ON_REFINEMENT

Do not perform any refinement, but raise a
:class:`QBXRefinementNeededError` if stage-1 or stage-2 refinement
would be required to satisfy the QBX refinement criteria.

.. note::

Refinement resulting from
``force_stage2_uniform_refinement_rounds`` is still carried out.
"""

REFINE = auto()
NO_REFINEMENT = auto()
COMPLAIN = auto()
ERROR_ON_REFINEMENT = auto()


class QBXRefinementNeededError(RuntimeError):
"""Raised when :attr:`QBXRefinementMode.COMPLAIN` is in effect and
"""Raised when :attr:`QBXRefinementMode.ERROR_ON_REFINEMENT` is in effect and
refinement would be needed to satisfy the QBX refinement criteria.
"""

Expand Down Expand Up @@ -767,10 +772,10 @@ def _refine_qbx_stage1(lpot_source, density_discr,
if iter_violated_criteria:
violated_criteria.append(" and ".join(iter_violated_criteria))

if lpot_source.refinement_mode == QBXRefinementMode.COMPLAIN:
if lpot_source.refinement_mode == QBXRefinementMode.ERROR_ON_REFINEMENT:
raise QBXRefinementNeededError(
"Stage-1 QBX refinement is needed but refinement mode is "
f"'{QBXRefinementMode.COMPLAIN.name}'. "
f"'{QBXRefinementMode.ERROR_ON_REFINEMENT.name}'. "
"Criteria requiring refinement: "
+ ", ".join(iter_violated_criteria))

Expand Down Expand Up @@ -846,10 +851,10 @@ def _refine_qbx_stage2(lpot_source, stage1_density_discr,
if iter_violated_criteria:
violated_criteria.append(" and ".join(iter_violated_criteria))

if lpot_source.refinement_mode == QBXRefinementMode.COMPLAIN:
if lpot_source.refinement_mode == QBXRefinementMode.ERROR_ON_REFINEMENT:
raise QBXRefinementNeededError(
"Stage-2 QBX refinement is needed but refinement mode is "
f"'{QBXRefinementMode.COMPLAIN.name}'. "
f"'{QBXRefinementMode.ERROR_ON_REFINEMENT.name}'. "
"Criteria requiring refinement: "
+ ", ".join(iter_violated_criteria))

Expand Down
Loading