Document parallel boundary conditions and 'aligned trasform' parallel derivatives #2533
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
The `shifted()` modifier was removed in v4.0.0 due to the change in standard grid from aligned to toroidal. [skip ci]
The label `target` was replaced by `upper_target` and `lower_target` to fix a bug a long time ago. [skip ci]
'Aligned transform' is a variant on 'shifted metric' using transformation to and from a globally field aligned grid for parallel derivatives instead of yup/ydown slices. [skip ci]
ZedThree
previously approved these changes
Apr 1, 2022
There was a problem hiding this comment.
LGTM, thanks @johnomotani !
I think these docs highlight several pain points for the parallel derivatives, not least the boundary conditions. I'm not sure what could be done, but it would be really nice to have something without so many sharp edges (many of which are least partly my fault!)
ZedThree
reviewed
Apr 1, 2022
bendudson
approved these changes
Dec 7, 2022
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.
Add documentation for parallel boundary conditions. Fixes #2531.
Add documentation for 'aligned transform' variant of shifted metric parallel derivatives (as used by STORM, Hermes). 'Aligned transform' is the version that calculates parallel derivatives by transforming to a globally field aligned grid, calculating the operation, and transforming the result back to the toroidal grid. I've called it 'aligned transform' to get a short name - any suggestions for a better name very welcome!