magnetostatics: require 'prefactor' for DipolarP3M (bug-sweep #55)#5378
Draft
RudolfWeeber wants to merge 1 commit into
Draft
magnetostatics: require 'prefactor' for DipolarP3M (bug-sweep #55)#5378RudolfWeeber wants to merge 1 commit into
RudolfWeeber wants to merge 1 commit into
Conversation
DipolarP3M.required_keys() returned only {"accuracy"}, so omitting the
prefactor silently passed the Python required-keys check. default_params()
then injected prefactor=0.0, the base float type check accepted it, and the
value reached the core, which threw the misleading
ValueError "Parameter 'prefactor' must be > 0" instead of the clean,
documented RuntimeError "Parameter 'prefactor' is missing".
Add 'prefactor' to DipolarP3M.required_keys() so the missing-key contract is
enforced at the Python layer before the placeholder default is applied. This
mirrors the established convention of electrostatics P3M
(required_keys() -> {"prefactor", "accuracy"}) and the sibling
DipolarDirectSum (required_keys() -> {"prefactor"}).
Extend test_exceptions_p3m in testsuite/python/dipolar_interface.py to assert
that constructing DipolarP3M without a prefactor raises the clean
RuntimeError "Parameter 'prefactor' is missing".
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DipolarP3M.required_keys() returned only {"accuracy"}, so omitting the
prefactor silently passed the Python required-keys check. default_params()
then injected prefactor=0.0, the base float type check accepted it, and the
value reached the core, which threw the misleading
ValueError "Parameter 'prefactor' must be > 0" instead of the clean,
documented RuntimeError "Parameter 'prefactor' is missing".
Add 'prefactor' to DipolarP3M.required_keys() so the missing-key contract is
enforced at the Python layer before the placeholder default is applied. This
mirrors the established convention of electrostatics P3M
(required_keys() -> {"prefactor", "accuracy"}) and the sibling
DipolarDirectSum (required_keys() -> {"prefactor"}).
Extend test_exceptions_p3m in testsuite/python/dipolar_interface.py to assert
that constructing DipolarP3M without a prefactor raises the clean
RuntimeError "Parameter 'prefactor' is missing".
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
🤖 Generated with Claude Code