Add scalar dot gradient#1500
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new vector-calculus helper on UxDataArray to compute the dot product between a (u, v) vector field and the gradient of a scalar field q, addressing issue #539.
Changes:
- Implement
UxDataArray.scalardotgradient(v, q)to computeu * dq/dx + v * dq/dyfor 1D face-centered fields with validation. - Add tests that (a) verify the dot product uses the expected gradient components and (b) rejects misaligned face indexes (no silent realignment).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
uxarray/core/dataarray.py |
Adds the scalardotgradient method with input validation, alignment, and output metadata. |
test/core/test_vector_calculus.py |
Adds MPAS-Ocean-focused tests for scalardotgradient, including a mocked-gradient correctness test and a misalignment error test. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
erogluorhan
reviewed
May 21, 2026
rajeeja
force-pushed
the
rajeeja/scalardotgradient_539
branch
2 times, most recently
from
4972c69 to
53e4cee
Compare
rajeeja
force-pushed
the
rajeeja/scalardotgradient_539
branch
from
53e4cee to
ceae73f
Compare
erogluorhan
reviewed
Jun 17, 2026
erogluorhan
left a comment
erogluorhan
left a comment
Member
There was a problem hiding this comment.
This still needs an entry into the vector calculus user guide per the previous review cycle. One it is done, this should be good to go.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
erogluorhan
approved these changes
Jun 18, 2026
erogluorhan
left a comment
erogluorhan
left a comment
Member
There was a problem hiding this comment.
Thanks a lot for adding this!
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.
Adds UxDataArray.scalardotgradient for computing the dot product between a vector field and scalar-field gradient. Closes #539.