+(*)Fix a scaling bug in MOM_horizontal_regridding #123
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
Avoids using hard-coded dimensional tolerances in horizontal_regridding and improves the documentation of the variables and their units in this file. Without this change, calls to horiz_interp_and_extrap_tracer with a non-unity conversion factor will exhibit unexpected changes in answers, and may have wildly inappropriate amounts of smoothing of the interpolated values in arrays that are initialized from z-space file. However, the defaults are carefully chosen to avoid changing answers in any cases that do not use rescaling of tracer concentrations. The specific changes include: - Add a new optional argument tr_iter_tol to the horiz_interp_and_extrap_tracer routines to set an appropriate dimensional threshold for when the post-fill smoothing of tracers should be considered to be adequate. - Make the dimensional crit argument to fill_miss_2d non-optional, and fill it with appropriate values in calls from the horiz_interp_and_extrap_tracer routines when tr_iter_tol is not present. There should never be a hard-coded non-zero default for a dimensional variable! - Add a new optional scale argument to myStats - Eliminate the unused and unnecessary smooth logical argument to fill_miss_2d; the same functionality is obtained by setting the num_pass argument to 0. - Added to comments to document the units or unitlessness of the real variables in MOM_horizontal_regridding.F90. - Made minor changes to make the duplicated portions of the two horiz_interp_and_extrap_tracer similar. By default, all answers are bitwise identical, but this corrects a subtle bug with the use of the conversion factor argument in horiz_interp_and_extrap_tracer calls. There are new optional arguments to publicly visible routines.
Hallberg-NOAA
added
bug
Codecov Report
@@ Coverage Diff @@
## dev/gfdl #123 +/- ##
============================================
+ Coverage 28.77% 28.78% +0.01%
============================================
Files 249 249
Lines 72968 72991 +23
============================================
+ Hits 20995 21010 +15
- Misses 51973 51981 +8
Continue to review full report at Codecov.
|
|
Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/15453 ✔️ |
marshallward
approved these changes
May 10, 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.
Avoids using hard-coded dimensional tolerances in horizontal_regridding and
improves the documentation of the variables and their units in this file.
Without this change, calls to horiz_interp_and_extrap_tracer with a non-unity
conversion factor will exhibit unexpected changes in answers, and may have
wildly inappropriate amounts of smoothing of the interpolated values in arrays
that are initialized from z-space file. However, the defaults are carefully
chosen to avoid changing answers in any cases that do not use rescaling of
tracer concentrations. The specific changes include:
Add a new optional argument tr_iter_tol to the horiz_interp_and_extrap_tracer
routines to set an appropriate dimensional threshold for when the post-fill
smoothing of tracers should be considered to be adequate.
Make the dimensional crit argument to fill_miss_2d non-optional, and fill it
with appropriate values in calls from the horiz_interp_and_extrap_tracer
routines when tr_iter_tol is not present. There should never be a hard-coded
non-zero default for a dimensional variable!
Add a new optional scale argument to myStats
Eliminate the unused and unnecessary smooth logical argument to
fill_miss_2d; the same functionality is obtained by setting the num_pass
argument to 0.
Added to comments to document the units or unitlessness of the real
variables in MOM_horizontal_regridding.F90.
Made minor changes to make the duplicated portions of the two
horiz_interp_and_extrap_tracer similar.
By default, all answers are bitwise identical, but this corrects a subtle bug
with the use of the conversion factor argument in horiz_interp_and_extrap_tracer
calls. There are new optional arguments to publicly visible routines.