MAINT: Refactor of domain boundary sides#766
Merged
Conversation
Contributor
IvarStefansson
left a comment
There was a problem hiding this comment.
Nice! Wouldn't a named tuple be a much better solution for bounding boxes as well?
Contributor
Author
|
Yes. That was my immediate thought as well. Should I create an issue for that? |
Contributor
Yes, please. Or, if you have the time, have a look and just implement it if it's relatively easy (if overhead of creating issue is substantial relative to overall effort). |
IvarStefansson
approved these changes
Nov 11, 2022
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.
Proposed changes
This PR proposes a refactor of
domain_boundary_sides()without changing its functionality. First, the output type was converted from a regular tuple to a namedtuple. This facilitates accessing the boundary sides as attributes (without having to check/remember its position in the returned tuple). The second change is related to the way the boundary sides are picked. Now, the distance between the face-centers and the box sides are computed such that it matches a given tolerance.P.D.: A cool feature of named tuples is that they also behave as regular tuples. Another cool feature is that they can be transformed into dictionaries.
Types of changes
What types of changes does this PR introduce to PorePy?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply or explain briefly why the box is not relevant.