Skip to content
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

Incorrect result units for some differential operators #807

Closed
davidhassell opened this issue Sep 2, 2024 · 1 comment · Fixed by #808
Closed

Incorrect result units for some differential operators #807

davidhassell opened this issue Sep 2, 2024 · 1 comment · Fixed by #808
Labels
bug Something isn't working
Milestone

Comments

@davidhassell
Copy link
Collaborator

When the axis of differentiation has units (equivalent to) radians, the differential operators curl_xy, div_xy, grad_xy, and laplacian_xy display an inapproriate radian-1 or radian-2 component to the returned Field units. E.g.

>>> import cf
>>> f = cf.example_field(0)
>>> f.grad_xy(radius='earth')  # WRONG
[<CF Field: long_name=X gradient of specific_humidity(latitude(5), longitude(8)) m-1.rad-1>,
 <CF Field: long_name=Y gradient of specific_humidity(latitude(5), longitude(8)) m-1.rad-1>]
>>> # SHOULD BE
#[<CF Field: long_name=X gradient of specific_humidity(latitude(5), longitude(8)) m-1>,
# <CF Field: long_name=Y gradient of specific_humidity(latitude(5), longitude(8)) m-1>]

Units of radian are dimensionless, and in the context of these operators it is misleading for them to appear in the output. For instance, the curl of the horizontal wind fields in spherical polar corodinates should have units of s-1 (i.e. relative vorticity), not "s-1.radian-1".

The agreed solution is to provide an option to Field.derivative that just pretends that the coordinates along the axis of differentiation are dimensionless (i.e. have units of 1) when instructed to do so with a keyword argument.

@sadielbartholomew
Copy link
Member

The agreed solution is to provide an option to Field.derivative that just pretends that the coordinates along the axis of differentiation are dimensionless (i.e. have units of 1) when instructed to do so with a keyword argument.

Good write up thanks and yes, this is how I interpreted our agreed solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants