Fix rescaling of internal tide debugging code #763
Conversation
|
Pull request #764 notes that MOM_internal_tides.F90 may be defining or calculating frequency incorrectly. So far as I can tell this does not impact the debugging code changed here, but any test cases used to confirm the diagnostics may be able to resolve the frequency issue. |
|
The code itself was not incorrect, per se, but it was inconsistent with the descriptions of the units of the debugging diagnostic variables in the comments describing them. The revised code will give equivalent model output, but it is now internally self-consistent with how it is described. I agree that this PR should be essentially independent of the corrections being made in PR #764. |
Hallberg-NOAA
changed the title
There was a problem hiding this comment.
You asked for @raphaeldussin to review, but IMHO the changes outside of internal tides look good to go.
Hallberg-NOAA
added
documentation
|
This rescaling of the debugging options will work as intended and documented in the comments, provided that PR #778 is handled first. |
Corrected the internal tide rescaling arguments so that some of the debugging variables have units that are consistent with their documented units. This involved changing the scale arguments to global_area_integral to tmp_scale arguments in 8 places so that the units of the output retain the scaling of the input variable. The multiplication by the reverse of the scaling factor was also added to 4 debugging output messages. The documented units of internal wave energies in 5 register_restart_field calls were previously given as "m3 s-2" in non-Boussinesq mode and "J m-2" in Boussinesq mode when the reverse was actually true. This has now been corrected. Also replaced the scale argument to 35 chksum calls with the equivalent but preferred unscale argument, following the pattern elsewhere in the MOM6 code. All answers are bitwise identical, and only debugging code was modified.
Hallberg-NOAA
force-pushed
the
better_int_tide_rescaling
branch
from
6fd0efb to
7f3cada
Compare
Corrected the internal tide rescaling arguments so that some of the debugging variables have units that are consistent with their documented units. This involved changing the
scalearguments toglobal_area_integral()totmp_scalearguments in 8 places so that the units of the output retain the scaling of the input variable. The multiplication by the reverse of the scaling factor was also added to 4 debugging output messages.The documented units of internal wave energies in 5 register_restart_field calls were previously given as "m3 s-2" in non-Boussinesq mode and "J m-2" in Boussinesq mode when the reverse was actually true. This has now been corrected.
Also replaced the
scaleargument to 35chksum()calls with the equivalent but preferredunscaleargument, following the pattern elsewhere in the MOM6 code.All answers are bitwise identical, and only debugging code was modified.