Rename CutoffsFamily to CutoffsPseudoPotentialFamily
#82
Conversation
This file contains 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
The `CutoffsFamily` was introduced in order to properly test the `RecommendedCutoffsMixin`. It was even given an entry point but this was just a requirement for the tests to work and it was never intended to actually be used in production. However, there now seems an actual usecase for this class as a substitute for the `SsspFamily` and `PseudoDojoFamily` who also have the mixin and allow recommended cutoffs to be defined but they come with strict rules and only official sets of pseudopotentials are supported. If one wants to create a custom pseudopotential family but still want to use the recommended cutoff functionality, the `PseudoPotentialFamily` base class doesn't suffice but the `CutoffsFamily` does. Now that we actually consider the class to be used for production, a more aptly named class name is required to properly reflect its intended usage.
sphuber
force-pushed
the
fix/rename-cutoffs-family
branch
from
feb4044 to
04e9bc9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
CutoffsFamilywas introduced in order to properly test theRecommendedCutoffsMixin. It was even given an entry point but this wasjust a requirement for the tests to work and it was never intended to
actually be used in production. However, there now seems an actual
usecase for this class as a substitute for the
SsspFamilyandPseudoDojoFamilywho also have the mixin and allow recommended cutoffsto be defined but they come with strict rules and only official sets of
pseudopotentials are supported.
If one wants to create a custom pseudopotential family but still want to
use the recommended cutoff functionality, the
PseudoPotentialFamilybase class doesn't suffice but the
CutoffsFamilydoes. Now that weactually consider the class to be used for production, a more aptly
named class name is required to properly reflect its intended usage.