+*Update parameter defaults for 2024 and 2025, including EQN_OF_STATE #942
Conversation
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
Hallberg-NOAA
added
answer-changing
Hallberg-NOAA
changed the title
Hallberg-NOAA
force-pushed
the
update_param_defaults_2025
branch
from
663d389 to
ca0a081
Compare
Updated the default values of 15 runtime parameters, as agreed upon in a MOM6 consortium wide conversations on July 29, 2024 and December 16, 2024. The most prominent of these is that the default equation of state is now EQN_OF_STATE = "WRIGHT_FULL", in place of the buggy previous default of "WRIGHT". The 8 answer date parameters REGRIDDING_ANSWER_DATE, TIDES_ANSWER_DATE, WAVE_INTERFACE_ANSWER_DATE, MEKE_GM_SRC_ANSWER_DATE, NDIFF_ANSWER_DATE, KPP%ANSWER_DATE, HOR_DIFF_ANSWER_DATE and LOTW_BBL_ANSWER_DATE all now take their default values from DEFAULT_ANSWER_DATE. The bug-retention parameters MEKE_GM_SRC_ALT_SLOPE_BUG, HOR_DIFF_LIMIT_BUG, BACKSCATTER_UNDERBOUND, DETERMINE_TEMP_CONVERGENCE_BUG, LA_MISALIGNMENT_BUG and IDL_HURR_SCM_EDGE_TAPER_BUG are now false by default. The MOM_input files for the test cases in the `.testing/tc[01234]` directories were updated to explicitly set all of these parameters to their previous default values if they are used in the relevant cases, as well as parameters that will be change following discussions from June 2, 2205. Bitwise identical answers are recovered if all 15 of these parameters are set explicitly, but answers can change if any of these parameters take default values. All of these default changes are the consensus decision of consortium-wise MOM6 dev calls.
Updated the default values of 6 runtime parameters, as agreed upon in a MOM6 consortium wide conversations on June 2, 2025. VISC_REM_BUG and FRICTWORK_BUG are now false by default. MASS_WEIGHT_IN_PRESSURE_GRADIENT_TOP now takes its default value from the setting for MASS_WEIGHT_IN_PRESSURE_GRADIENT. Similarly, the default for DRAG_DIFFUSIVITY_ANSWER_DATE is now set to follow SET_DIFF_ANSWER_DATE. KELVIN_WAVE_VEL_NUDGING_TIMESCALE is now set to a negative value by default, forcing the user to provide a valid value at runtime. SHELFWAVE_CORRECT_AMPLITUDE now defaults to True.
Obsoleted 7 runtime parameters that always take the same value, as agreed upon in a MOM6 consortium wide conversations on June 2, 2025, and added tests to catch these parameters in MOM_obsolete_params. The parameters that were obsoleted include BETTER_BOUND_KH, BETTER_BOUND_AH, USE_DIABATIC_TIME_BUG, FIX_UNSPLIT_DT_VISC_BUG, CFL_BASED_TRUNCATIONS and KD_BACKGROUND_VIA_KDML_BUG. The runtime parameter MAXVEL still exists, but it is logged in a different order than before, changing the contents of the MOM_parameter_doc files. All answers are bitwise identical in cases that run, but cases that use these parameters will experience a fatal error.
Hallberg-NOAA
force-pushed
the
update_param_defaults_2025
branch
from
ca0a081 to
5ac077f
Compare
|
This PR has now been added as a PR directly to main on MOM-ocean in PR mom-ocean#1670. It is being retained as a PR to dev/gfdl for now to facilitate pipeline testing. |
Added code to set all intent(out) arguments in the stub version of the MOM_generic_tracer routines MOM_generic_tracer_stock(), MOM_generic_tracer_min_max() and MOM_generic_tracer_get() to avoid compile-time warnings. These stub routines are never supposed to be used, and there would be a fatal error during the registration phase if they are used. The values that are set in these stub routines are extremely large or otherwise nonsensical so that it would make it easier to debug them if they were used accidentally. All answers are bitwise identical in any cases that run successfully.
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 series of 3 commits updates the defaults for a total of 21 runtime parameters, and obsoletes another 7 runtime parameters, as agreed to in MOM6 consortium-wide meetings on July 29, 2024, December 16, 2024 and June 2, 2025.
The default equation of state is now
EQN_OF_STATE = "WRIGHT_FULL", in place of the buggy previous default of"WRIGHT".The 8 answer date parameters
REGRIDDING_ANSWER_DATE,TIDES_ANSWER_DATE,WAVE_INTERFACE_ANSWER_DATE,MEKE_GM_SRC_ANSWER_DATE,NDIFF_ANSWER_DATE,KPP%ANSWER_DATE,HOR_DIFF_ANSWER_DATEandLOTW_BBL_ANSWER_DATEall now take their default values fromDEFAULT_ANSWER_DATE.The bug-retention parameters
MEKE_GM_SRC_ALT_SLOPE_BUG,HOR_DIFF_LIMIT_BUG,BACKSCATTER_UNDERBOUND,DETERMINE_TEMP_CONVERGENCE_BUG,LA_MISALIGNMENT_BUG,IDL_HURR_SCM_EDGE_TAPER_BUG,VISC_REM_BUGandFRICTWORK_BUGare now false bydefault.
With these changes,
MASS_WEIGHT_IN_PRESSURE_GRADIENT_TOPnow takes its default value from the setting forMASS_WEIGHT_IN_PRESSURE_GRADIENT. Similarly, the default forDRAG_DIFFUSIVITY_ANSWER_DATEis now set to followSET_DIFF_ANSWER_DATE.KELVIN_WAVE_VEL_NUDGING_TIMESCALEis now set to a negative value by default, forcing the user to provide a valid value at runtime.SHELFWAVE_CORRECT_AMPLITUDEnow defaults to True.The parameters
BETTER_BOUND_KH,BETTER_BOUND_AH,USE_DIABATIC_TIME_BUG,FIX_UNSPLIT_DT_VISC_BUG,CFL_BASED_TRUNCATIONSandKD_BACKGROUND_VIA_KDML_BUGhave all been obsoleted and are no longer valid MOM6 runtime parameters.These changes can change answers if any of the impacted parameters are taking their default values, but answers will not change if they are set explicitly. The easiest way to determine what parameters must now be set explicitly to
retain existing answers is to run a configuration twice with versions of the model from before and after this PR, and to compare the MOM_parameter_doc.all files to determine which parameters have been changed by the changing defaults.
The specific commits in this PR include: