Adding support for grid.negate_depth() method #1778
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
This is useful when the depth needs to be flipped from positive to negative values. Note that this does _not_ change the direction of the vertical velocity; for that users need to add a fieldset.W.set_scaling_factor(-1.0)
VeckoTheGecko
approved these changes
Nov 27, 2024
There was a problem hiding this comment.
LGTM! Maybe we could add a simple docstring detailing some of the stuff that you have mentioned here about why it's useful? Also maybe specifying that the grid classes don't really support grid manipulation beyond this simple case (as that is beyond the scope of Parcels).
Co-authored-by: Vecko <[email protected]>
This reverts commit ce11d4c.
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 PR adds a
grid.negate_depth()method, which can be useful when the depth needs to be flipped from positive to negative values. This is the case for example in theVirtualShippackage:https://github.com/OceanParcels/virtualship/blob/44eae19e55545166c446e8eabe7c76ab13d7344b/src/virtualship/expedition/input_data.py#L98-L100
Note that this method does not change the direction of the vertical velocity; for that users need to add a
fieldset.W.set_scaling_factor(-1.0)This fixes #1746