-
Notifications
You must be signed in to change notification settings - Fork 92
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.
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
Unification of variable names throughout the code base #1369
Merged
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
…ations MAINT: Rename setup to model in convergence_analysis.py
…utorials MAINT: Name unification (#1336) in tutorials.
TST: Renaming instances of porepy models to 'model' in tests/models/
MAINT: Rename boundary_grid to bg in porepy/examples
Name unification tutorials
…ations MAINT: Rename intf_map to interface_map
TST: Name unification in tests part 1
MAINT: Rename "bounds" and "sides" to "domain_sides" in porepy/examples
* TST: Name unification in tests part 2 * TST: Name unification in tests
Also some changes in the associated test
Also some changes in the corresponding test
domains -> subdomains, g -> grids etc.
Covered various use of domain_boundary_sides, and boundary_grid -> bg
Covers boundary_grid -> bg, sides -> domain_sides
…_models Name unification applications models
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
IvarStefansson
approved these changes
Mar 2, 2025
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 attempts to unify variable names used in the code base and tests to ease future maintenance. The following conventions are introduced:
model
EquationSystem
should be calledequation_system
subdomains
. When iterating over the list, the iteration variable will normally besd
interfaces
. When iterating over the list, the iteration variable will normally beintf
bg
domain_boundary_sides
should be calleddomain_sides
For most of these, there are exceptions that are somewhat vaguely defined (hence not written down here). Still, we will try to enforce these rules in future code reviews.
Types of changes
What types of changes does this PR introduce to PorePy?
Put an
x
in the boxes that apply.Checklist
Put an
x
in the boxes that apply or explain briefly why the box is not relevant.pytest
was run with the--run-skipped
flag.