Minor diagnostics code improvements and unit annotations #306
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
Codecov Report
@@ Coverage Diff @@
## dev/gfdl #306 +/- ##
=========================================
Coverage 37.17% 37.17%
=========================================
Files 265 265
Lines 74402 74407 +5
Branches 13822 13822
=========================================
+ Hits 27659 27664 +5
- Misses 41658 41659 +1
+ Partials 5085 5084 -1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Hallberg-NOAA
force-pushed
the
annotate_diags
branch
from
7e7f925 to
c4176e5
Compare
Use rescaled variables for 6 global mean temperature and salinity diagnostics, using the tmp_scale arguments to the various global mean functions so that they have conversion factors that can be verified against their declared units in their register_scalar_field calls. Also added or corrected unit descriptions for a handful of variables in the MOM_diagnostics module. All answers and output are bitwise identical.
Added an optional unscale argument to the various check_redundant and chksum_vec routines so that the values that are written out in error messages are independent of rescaling values. Also added or amended comments to document the units of numerous internal variables and function arguments in MOM_debugging.F90. All answers are bitwise identical, but there are new optional arguments to several publicly visible routines.
Added unscale arguments to the various check_redundant calls so that any error messages that are generated by inconsistent redundant points will be invariant to the unit scaling that is is in use. Also rescaled the units of dtbt_reset_period to [T ~> s] in the MOM_control_struct. All answers are bitwise identical, but in some rare debugging output will become consistent.
Hallberg-NOAA
force-pushed
the
annotate_diags
branch
from
c4176e5 to
931c49c
Compare
|
This PR has been updated to address concerns from Alistair Adcroft regarding the clarity of the comments describing arbitrary but potentially rescaled units. |
marshallward
approved these changes
Jan 31, 2023
|
Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/18123 ✔️ |
This was referenced Apr 6, 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 PR has three commits that improve the diagnostics code, by adding to the description of internal variables and their units, by using rescaled units for 6 globally averaged temperature and salinity diagnostics, and by adding unscale arguments to the various check_redundant and chksum_vec routines that can be used to give debugging error messages that are invariant to dimensional rescaling. A separate commit adds unscale arguments to the various check_redundant calls so that any error messages that are generated by inconsistent redundant points will be invariant to the unit scaling that is in use. All answers and typical output are bitwise identical, but there are new optional arguments to several publicly visible routines.
The commits in this PR include: