User/bgr/jhl threshold option

[breichl]

Add an option to use the more restrictive tolerance check in place of the less restrictive tolerance check in MOM_kappa_shear and fix an iteration max criteria check.

• The new option (USE_RESTRICTIVE_TOLERANCE_CHECK) defaults to False to maintain the original JHL tolerance check. Setting it True uses the more restrictive option, which appears to improve the scheme stability.
• Fix for itt number criteria check that should have been max_KS_it but was max_RiNo_it

The first will not change answers by default. The second could potentially change answers, but only if the iteration count ever hits the cap max_KS_it. It does not hit the cap default of 13 with USE_RESTRICTIVE_TOLERANCE_CHECK=False in the global_ALE test cases, and therefore it does not change answers in any of these cases.

[codecov-commenter]

Codecov Report

Merging #1219 into dev/gfdl will decrease coverage by 0.01%.
The diff coverage is 35.19%.

@@             Coverage Diff              @@
##           dev/gfdl    #1219      +/-   ##
============================================
- Coverage     46.08%   46.06%   -0.02%     
============================================
  Files           214      224      +10     
  Lines         69399    70597    +1198     
============================================
+ Hits          31984    32524     +540     
- Misses        37415    38073     +658     

Impacted Files	Coverage Δ
...g_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90	0.00% <0.00%> (ø)
...fig_src/external/GFDL_ocean_BGC/generic_tracer.F90	0.00% <0.00%> (ø)
...c/external/GFDL_ocean_BGC/generic_tracer_utils.F90	0.00% <0.00%> (ø)
config_src/external/ODA_hooks/kdtree.f90	0.00% <0.00%> (ø)
config_src/external/ODA_hooks/ocean_da_core.F90	0.00% <0.00%> (ø)
config_src/external/ODA_hooks/ocean_da_types.F90	0.00% <0.00%> (ø)
config_src/external/ODA_hooks/write_ocean_obs.F90	0.00% <0.00%> (ø)
config_src/solo_driver/MESO_surface_forcing.F90	0.00% <0.00%> (ø)
config_src/solo_driver/user_surface_forcing.F90	0.00% <0.00%> (ø)
src/ALE/MOM_regridding.F90	31.47% <0.00%> (-0.17%)	⬇️
... and 214 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7cb606e...1634cee. Read the comment docs.

[Hallberg-NOAA]

I agree that these changes include a genuine bug fix in one case that could change answers in some unlikely instances (but note Murphy's Law), and a logical test that is helpful while preserving answers.

Because this changes the contents of the MOM_parameter_doc files and could change answers, this will have to be handled manually. These changes should have been noted in the commit descriptions, and the commit headers should have had the notation (*) and + at the start of the commit descriptions.

[marshallward]

https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/11323