Obsolete the HENYEY_IGW_BACKGROUND_NEW option.

[kshedstrom]

As discussed in the dev call today, make HENYEY_IGW_BACKGROUND_NEW obsolete.

[codecov]

Codecov Report

Merging #200 (13b40a3) into dev/gfdl (de3f260) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##           dev/gfdl     #200   +/-   ##
=========================================
  Coverage     37.14%   37.15%           
=========================================
  Files           262      262           
  Lines         72761    72748   -13     
  Branches      13598    13598           
=========================================
  Hits          27026    27026           
+ Misses        40721    40708   -13     
  Partials       5014     5014           

Impacted Files	Coverage Δ
src/diagnostics/MOM_obsolete_params.F90	69.31% <100.00%> (+0.35%)	⬆️
...rc/parameterizations/vertical/MOM_bkgnd_mixing.F90	32.02% <100.00%> (+2.08%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[Hallberg-NOAA]

When an option is made obsolete, it should be removed from the the model code (outside of find_obsolete_params), and all of the code that is used exclusively with that option should also be deleted.

Also, because HENYEY_IGW_BACKGROUND_NEW is used to set a logical variable, the right call to obsolete it in find_obsolete_params would be call obsolete_logical(param_file, "HENYEY_IGW_BACKGROUND_NEW"). We might also consider adding the optional argument , warning_val=.False.).

[kshedstrom]

Thanks for the feedback!

[Hallberg-NOAA]

This has passed pipeline testing at https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/16746, but it does change the contents of some MOM_parameter_doc files.

[marshallward]

@kshedstrom OK to squash this one?

[marshallward]

Nevermind, I see that it's already been merged into dev/ESMG.

In order to preserve the dev/ESMG history, this needs to be merge-commited.