Mixed fs limiter #459
Merged
Mixed fs limiter #459
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
tommbendall
requested changes
Nov 30, 2023
There was a problem hiding this comment.
Thanks Tim, this looks really good and very neatly implemented.
I think the choice of DG1 and DG1 equispaced for the different spaces in the test makes sense, and it's good to demonstrate that this will in theory work when the tracers are in different spaces.
I have two very very trivial suggestions about docstrings, then this will be good to go on
gusto/limiters.py
Outdated
|
|
||
|
|
||
| class MixedFSLimiter(object): | ||
| """An object to hold a dictionary that defines limiters for transported prognostic |
There was a problem hiding this comment.
Suggested change
| """An object to hold a dictionary that defines limiters for transported prognostic | |
| """ | |
| An object to hold a dictionary that defines limiters for transported prognostic |
When the docstrings go over more than one line, I think we should generally put the open quotation marks on their own line
gusto/limiters.py
Outdated
| def __init__(self, equation, sublimiters): | ||
| """ | ||
| Args: | ||
| equation (:class: 'PrognosticEquationSet'): the prognostic equation(s) |
There was a problem hiding this comment.
Suggested change
| equation (:class: 'PrognosticEquationSet'): the prognostic equation(s) | |
| equation (:class:`PrognosticEquationSet`): the prognostic equation(s) |
I think we need a back quotation here and not forward ones!
tommbendall
approved these changes
Dec 12, 2023
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.
This pull request adds the ability to apply individual limiters to specific prognostic variables. It does so through a MixedFSLimiter object in gusto/limiters.py which stores a dictionary with user defined sublimiters for certain prognostic variables. A test is of this new functionality is added to the integration-tests/transport/test_limiters.py file.