sima0_09_000: Complete CCPPization of gravity wave drag

[jimmielin]

Tag name (required for release branches): sima0_09_000
Originator(s): @jimmielin

Description (include the issue title, and the keyword ['closes', 'fixes', 'resolves'] followed by the issue number):

• Completes CCPPization of gravity wave drag parameterizations for CAM4 through CAM7.
• Ports frontogenesis bug fix for SE dycore from cam6_4_126: Fix frontogenesis bug (SE dycore only) CAM#1415
• Adds vorticity calculation for gravity waves from existing CAM SE dycore.

Describe any changes made to build system: N/A

Describe any changes made to the namelist: NLCOMP will fail due to added gamma file /gw_drag_input_nl/ bnd_rdggm

List any changes to the defaults for the input datasets (e.g. boundary datasets): N/A

List all files eliminated and why: N/A

List all files added and what they do: see below with A flag

List all existing files that have been modified, and describe the changes:
(Helpful git command: git diff --name-status development...<your_branch_name>)

M       cime_config/testdefs/testlist_cam.xml
A       cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam4_derecho/shell_commands
A       cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam4_derecho/user_nl_cam
A       cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam7_derecho/shell_commands
A       cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam7_derecho/user_nl_cam
  - add tests for CAM4 and CAM7 gravity wave schemes

M       cime_config/testdefs/testmods_dirs/cam/outfrq_se_cslam_analy_ic/user_nl_cam
  - add topo file to analytic ic FCAM7 test for now. this should be removed 
    in the future when FCAM7 test runs standalone without analytic ICs.

M       src/control/runtime_obj.F90
M       src/control/runtime_opts.F90
  - remove gw_front and gw_front_igw from runtime object. 
    This controls the provisioning of frontogenesis fields from the SE dycore to the physics state.
  - These two parameters were not read from namelist and were controlled 
    independently from the schemes, and changing them would not enable/disable
    the frontogenesis gw scheme, so I removed them to avoid further confusion. 
    I think this needs a more elegant solution to determine active schemes
    from the host model end. 

M       src/data/registry.xml

M       src/dynamics/se/dp_coupling.F90
M       src/dynamics/se/dyn_comp.F90
M       src/dynamics/se/gravity_waves_sources.F90
  - always provide frontgf, frontga to physics state
  - port vorticity code (vort4gw) for moving mountains gravity wave parameterization
    from CAM SE dycore to SIMA.

M       src/control/cam_comp.F90
A       src/physics/utils/gravity_wave_drag_ridge_read.F90
A       src/physics/utils/gravity_wave_drag_ridge_read.meta
M       cime_config/namelist_definition_cam.xml
  - add host-model utility to read topo and gamma ridge file (on model decomp) 
    for gravity wave parameterizations.

M       src/data/ref_pres.F90
M       src/data/ref_pres.meta
  - add bottom pressure and index of gravity wave tapering at top of model to ref_pres.
  - change standard name of do_molec_diff to do_molecular_diffusion.

M       test/unit/python/sample_files/ref_pres.meta
M       test/unit/python/sample_files/ref_pres_SourceMods.meta
  - change standard name of do_molec_diff to do_molecular_diffusion.

If there are new failures (compared to the test/existing-test-failures.txt file),
have them OK'd by the gatekeeper, note them here, and add them to the file.
If there are baseline differences, include the test and the reason for the
diff. What is the nature of the change? Roundoff?

derecho/intel/aux_sima:

  SMS_Ln9.mpasa480_mpasa480.FKESSLER.derecho_intel.cam-outfrq_kessler_mpas_derecho (Overall: NLFAIL) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FADIAB.derecho_intel.cam-outfrq_se_cslam (Overall: NLFAIL) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FHS94.derecho_intel.cam-outfrq_se_cslam (Overall: NLFAIL) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FKESSLER.derecho_intel.cam-outfrq_se_cslam (Overall: NLFAIL) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FTJ16.derecho_intel.cam-outfrq_se_cslam (Overall: NLFAIL) details:
  - new namelist group gw_drag_input_nl

  SMS_Ln9.ne3pg3_ne3pg3_mg37.FCAM4.derecho_intel.cam-outfrq_se_cslam_analy_ic_cam4 (Overall: DIFF) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FCAM7.derecho_intel.cam-outfrq_se_cslam_analy_ic (Overall: DIFF) details:
  - answer change: SDFs added gravity wave drag parameterizations


  SMS_Ln9.ne3pg3_ne3pg3_mg37.FKESSLER.derecho_intel.cam-outfrq_se_cslam_multitape (Overall: NLFAIL) details:
  - pre-existing failure due to NLCOMP not supporting multiple history tapes

derecho/gnu/aux_sima:

  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_dme_adjust_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_hack_shallow_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_hb_vdiff_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_held_suarez_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_kessler_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_rk_stratiform_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_tj2016_after_coupler_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_tj2016_before_coupler_derecho (Overall: NLFAIL) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_zm_derecho (Overall: NLFAIL) details:
  SMS_Ln9.mpasa480_mpasa480.FKESSLER.derecho_gnu.cam-outfrq_kessler_mpas_derecho (Overall: NLFAIL) details:
  - new namelist group gw_drag_input_nl

  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_gw_cam4_derecho (Overall: DIFF) details:
  SMS_Ln2.ne3pg3_ne3pg3_mg37.FPHYStest.derecho_gnu.cam-outfrq_gw_cam7_derecho (Overall: DIFF) details:
  - new baselines for new physics test (gravity waves for CAM4 and CAM7 SE).

  SMS_Ln9.ne3pg3_ne3pg3_mg37.FCAM4.derecho_gnu.cam-outfrq_se_cslam_analy_ic_cam4 (Overall: DIFF) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FCAM7.derecho_gnu.cam-outfrq_se_cslam_analy_ic (Overall: DIFF) details:
  - answer change: SDFs added gravity wave drag parameterizations

  SMS_Ln9.ne3pg3_ne3pg3_mg37.FADIAB.derecho_gnu.cam-outfrq_se_cslam (Overall: DIFF) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FHS94.derecho_gnu.cam-outfrq_se_cslam (Overall: DIFF) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FKESSLER.derecho_gnu.cam-outfrq_se_cslam (Overall: DIFF) details:
  SMS_Ln9.ne3pg3_ne3pg3_mg37.FTJ16.derecho_gnu.cam-outfrq_se_cslam (Overall: DIFF) details:
  - SE dycore answer differences after Derecho upgrade, unrelated to this PR.
  - new baselines are being established. see https://github.com/ESCOMP/CAM-SIMA/pull/443#issuecomment-3523069390

If this changes climate describe any run(s) done to evaluate the new
climate in enough detail that it(they) could be reproduced:

CAM-SIMA date used for the baseline comparison tests if different than latest:

[jimmielin]

I brought in the vorticity code from the SE dycore in CAM into this PR to enable the moving mountains GW parameterization in the FCAM7 compset.

I think the bug fixes from ESCOMP/CAM#1415 once they're in ESCOMP/CAM need to be ported to CAM-SIMA as well.

[jimmielin]

I ported the frontogenesis fixes from cam6_4_126 (ESCOMP/CAM#1415) into this PR, but the commit a1ce363 can be picked out into a separate PR if desired. I am changing gravity_waves_sources.F90 to add vorticity in either case, so I put the changes together in this PR.

[nusbaume]

Thanks for bringing in all of the new gravity wave code @jimmielin! I mostly just have a bunch of nit-picks and style requests, but of course let me know if any request is problematic. Thanks again!

[nusbaume]

Everything looks good to me now @jimmielin!