+(*)Add OBC_TS_RESERVOIR_INIT_BUG runtime param - #1142
Merged
Hallberg-NOAA merged 1 commit intoJun 30, 2026
Merged
Conversation
The code that was previously wrapped by the runtime parameter OBC_RESERVOIR_INIT_BUG actually included two separate bugs in the order with which the tracer reservoirs were initialized. This commit adds the new runtime parameter OBC_TS_RESERVOIR_INIT_BUG that wraps only the point where temperature and salinity in the reservoirs are set with new runs, and not the bug that sets when the other tracers are initialized, which is still selected with OBC_RESERVOIR_INIT_BUG. Although there are cases where the answers could be changed by the value of OBC_TS_RESERVOIR_INIT_BUG, this only applies when REGRID_ACCELERATE_INIT is true, which appears to be uncommon. It is even possible that there are no cases with active OBCs and tracer reservoirs that also use REGRID_ACCELERATE_INIT=True, in which case OBC_TS_RESERVOIR_INIT_BUG could be rapidly obsoleted, whereas there are cases (like the loop_current test case) where the value of OBC_RESERVOIR_INIT_BUG does change answers. All answers in test cases are bitwise identical, but there could be some cases where this new parameter changes answers.
|
I have not tested these changes, they are clear enough that I don't think the usual testing is needed, but I support separating the one bug flag into two this way. I also support obsoleting |
|
If @herrwang0 is happy with this change and how it will fit with #1139 then I will approve this PR. |
herrwang0
approved these changes
Jun 30, 2026
Member
Author
|
This PR has passed pipeline testing at https://gitlab.gfdl.noaa.gov/ogrp/mom6ci/MOM6/-/pipelines/31256 with the expected warnings about new runtime parameters. |
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
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.
The code that was previously wrapped by the runtime parameter
OBC_RESERVOIR_INIT_BUGactually included two separate bugs in the order with which the tracer reservoirs were initialized. This commit adds the new runtime parameterOBC_TS_RESERVOIR_INIT_BUGthat wraps only the point where temperature and salinity in the reservoirs are set with new runs, and not the bug that sets when the other tracers are initialized, which is still selected withOBC_RESERVOIR_INIT_BUG. Although there are cases where the answers could be changed by the value ofOBC_TS_RESERVOIR_INIT_BUG, this only applies whenREGRID_ACCELERATE_INITis true, which appears to be uncommon. It is even possible that there are no cases with active OBCs and tracer reservoirs that also useREGRID_ACCELERATE_INIT=True, in which caseOBC_TS_RESERVOIR_INIT_BUGcould be rapidly obsoleted, whereas there are cases (like the loop_current test case) where the value ofOBC_RESERVOIR_INIT_BUGdoes change answers. All answers in test cases are bitwise identical, but there could be some cases where this new parameter changes answers.