Slightly relax the constraint satisfy condition of get_primitive_structure() - #3285
Merged
Conversation
…traint condition has been adjusted to a more flexible criterion. Instead of requiring an exact match, the evaluation now utilizes np.isclose() for comparison, which should still be strict enough with the default atol and rtol values.
…n the Structure class. The first test focuses on evaluating the method with a constrain_latt parameter, while the second ensures the consistency of the primitive structure when two very similar constraints are used.
…traint perturbations test_primitive_with_similar_constraints()
janosh
approved these changes
Aug 31, 2023
janosh
left a comment
Member
There was a problem hiding this comment.
Looks good, thanks @fyalcin! 👍
I added the test file you linked in https://matsci.org/t/41663 but forgot to upload and improved the tests slightly.
janosh
enabled auto-merge (squash)
August 31, 2023 12:49
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
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.
Summary
Context here. I finally took some time to figure out why this was happening and it turned out to be the check that compares the lattice parameters of the primitive structures found against the constraints. The equivalency check in the current implementation is too strict to account for small changes in the constraints, which is why I went with
np.isclose()with its defaultatolandrtolparameters which should still be strict enough.I also include two unit tests, one for a general
get_primitive_structure()call withconstrain_lattwhich was missing, and #another to ensure two very similar constraints result in the same primitive structure.