meaningful description of switch #634
Merged
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
|
testing: |
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.
CABLE
Thank you for submitting a pull request to the CABLE Project.
Description
The history of this switch was that in ACCESS1.3, when we first introduced 17 tiles, and tiled soils, manipulation of fields files was way harder than what it is now. Plus, we didn't have a similar field to use as a base. We began with files of constant temperature, moisture etc. Progressively made amendments. In one iteration (lasting months perhaps), we clobbered values on snow fields in particular by calling a special initialization routine. This was more or less the first time was coupled (to the UM) - hence the naming of the flag as runtime_coupled. As time went on we occasionally used it in other scenarios. The meaning of the flag and its declaration initialization got mixed up until eventually it was determined that while the flag was TRUE, the conditions should be IF .NOT. . It is all very convoluted evolution to basically set a switch that triggers a special (albeit basic) initialization of soilnow fields in the instance where the initializations through a restart (etc) cannot be trusted.
It make way more sense to rename the switch, declare it as FALSE, and update the conditionals rather than than have this crazy double negative situation.
Fixes #536
Type of change
CLARIFICATION
Checklist
Testing
📚 Documentation preview 📚: https://cable--634.org.readthedocs.build/en/634/