sima0_09_000: Complete CCPPization of gravity wave drag (#426)

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
ESCOMP/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 #443 (comment)
```

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:

---------

Co-authored-by: Jesse Nusbaumer <[email protected]>

Author: jimmielin

.gitmodules

@@ -20,7 +20,7 @@
 [submodule "ncar-physics"]
         path          = src/physics/ncar_ccpp
 	url           = https://github.com/ESCOMP/atmospheric_physics
-	fxtag         = 73fce2706c1f70e1ba63ff4bb3dcb80323bb9cc6
+	fxtag         = atmos_phys0_19_000
         fxrequired    = AlwaysRequired
         fxDONOTUSEurl = https://github.com/ESCOMP/atmospheric_physics
 [submodule "rrtmgp-data"]

cime_config/namelist_definition_cam.xml

@@ -377,6 +377,19 @@
     </values>
   </entry>
 
+<!-- Gravity wave ridge parameterization inputs -->
+  <entry id="bnd_rdggm">
+    <type>char*256</type>
+    <category>gravity_wave_drag</category>
+    <group>gw_drag_input_nl</group>
+    <desc>
+      Full pathname of boundary dataset for meso-gamma ridges.
+    </desc>
+    <values>
+      <value>UNSET_PATH</value>
+    </values>
+  </entry>
+
 <!-- Vertical Coordinate -->
 
   <entry id="pver">

cime_config/testdefs/testlist_cam.xml

@@ -88,6 +88,24 @@
       <option name="comment">Test for Holtslag-Boville boundary layer scheme and vertical diffusion</option>
     </options>
   </test>
+  <test compset="FPHYStest" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln2" testmods="cam/outfrq_gw_cam4_derecho">
+    <machines>
+      <machine name="derecho" compiler="gnu" category="aux_sima"/>
+    </machines>
+    <options>
+      <option name="wallclock">00:10:00</option>
+      <option name="comment">Test for orographic gravity wave scheme (CAM4)</option>
+    </options>
+  </test>
+  <test compset="FPHYStest" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln2" testmods="cam/outfrq_gw_cam7_derecho">
+    <machines>
+      <machine name="derecho" compiler="gnu" category="aux_sima"/>
+    </machines>
+    <options>
+      <option name="wallclock">00:10:00</option>
+      <option name="comment">Test for moving mountain, deep convective, frontogenesis, beta ridge gravity wave scheme suite (CAM7)</option>
+    </options>
+  </test>
 
   <!-- Derecho dycore tests -->
   <test compset="FKESSLER" grid="mpasa480_mpasa480" name="SMS_Ln9" testmods="cam/outfrq_kessler_mpas_derecho">

cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam4_derecho/shell_commands

@@ -0,0 +1 @@
+ ./xmlchange CAM_CONFIG_OPTS="--dyn none --physics-suites gw_cam4"

cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam4_derecho/user_nl_cam

@@ -0,0 +1,28 @@
+! cam4 snapshot
+pver = 26
+ncdata = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_fhistc4_gw_drag_cam4_oro_snapshot_derecho_gnu_before_c20250826.nc'
+ncdata_check = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_fhistc4_gw_drag_cam4_oro_snapshot_derecho_gnu_after_c20250826.nc'
+
+debug_output = 0
+
+! tolerances for testing
+ncdata_check_err = .true.
+min_difference = 2e-15
+
+effgw_oro = 0.125D0
+gw_apply_tndmax = .true.
+gw_dc = 0.D0
+gw_lndscl_sgh = .true.
+gw_oro_south_fac = 1.d0
+gw_prndl = 0.25d0
+gw_qbo_hdepth_scaling = 1.0D0
+gw_top_taper = .false.
+pgwv = 0
+tau_0_ubc = .false.
+
+! diagnostics for gravity wave drag
+hist_add_inst_fields;h1: EKGW
+hist_output_frequency;h1: 1*nsteps
+hist_write_nstep0;h1: .true.
+hist_precision;h1: REAL64
+hist_max_frames;h1: 1

cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam7_derecho/shell_commands

@@ -0,0 +1 @@
+ ./xmlchange CAM_CONFIG_OPTS="--dyn none --physics-suites gw_cam7_se"

cime_config/testdefs/testmods_dirs/cam/outfrq_gw_cam7_derecho/user_nl_cam

@@ -0,0 +1,50 @@
+! fhistc_ltso snapshot
+pver = 58
+ncdata = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_fhistc_ltso_gw_drag_cam7se_snapshot_derecho_gnu_before_c20251013.nc'
+ncdata_check = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_fhistc_ltso_gw_drag_cam7se_snapshot_derecho_gnu_after_c20251013.nc'
+
+debug_output = 0
+
+! tolerances for testing
+ncdata_check_err = .true.
+min_difference = 2e-15
+
+! topo file for beta ridge scheme input
+bnd_topo               = '/glade/campaign/cesm/cesmdata/inputdata/atm/cam/topo/se/ne3pg3_gmted2010_modis_bedmachine_nc0540_Laplace1000_noleak_20230209.nc'
+
+gw_movmtn_use_pbl_source = .true. ! se dycore
+gw_movmtn_alpha         =  0.01d0
+effgw_beres_dp         = 0.15D0
+effgw_cm               = 1.D0
+effgw_movmtn_pbl               =  1.0d0
+effgw_rdg_beta         = 0.5D0
+effgw_rdg_beta_max             = 0.5D0
+front_gaussian_width           =  30.D0
+gw_frontgfc               = 1.25D-15
+gw_apply_tndmax                = .false.
+gw_dc          = 2.5D0
+gw_dc_long             = 0.D0
+gw_drag_file_dp           = '/glade/campaign/cesm/cesmdata/inputdata/atm/waccm/gw/newmfspectra40_dc25.nc'
+gw_drag_file_movmtn                = '/glade/campaign/cesm/cesmdata/inputdata/atm/waccm/gw/mfc0lookup_mm.nc'
+gw_lndscl_sgh          = .true.
+gw_oro_south_fac               = 1.d0
+gw_polar_taper         = .false.
+gw_prndl               = 0.5D0
+gw_qbo_hdepth_scaling          = 0.32D0
+gw_movmtn_plaunch         =  32500.0d0
+gw_movmtn_psteer          =  65000.0d0
+gw_movmtn_source          =  1
+gw_rdg_beta_nrdg             = 10
+pgwv           = 32
+pgwv_long              = 0
+gw_rdg_beta_cd_llb               = 1.0D0
+tau_0_ubc              = .true.
+gw_front_taubgnd                = 1.5D-3
+gw_rdg_beta_trpd_leewv            = .false.
+
+! diagnostics for gravity wave drag
+hist_add_inst_fields;h1: EKGW
+hist_output_frequency;h1: 1*nsteps
+hist_write_nstep0;h1: .true.
+hist_precision;h1: REAL64
+hist_max_frames;h1: 1

cime_config/testdefs/testmods_dirs/cam/outfrq_se_cslam_analy_ic/user_nl_cam

@@ -2,3 +2,11 @@ hist_add_inst_fields;h1: T, Q, U, V, PS
 hist_output_frequency;h1: 1*nsteps
 hist_write_nstep0;h1: .true.
 analytic_ic_type=held_suarez_1994
+
+! generally, analytic_ic runs do not need a topo file (see namelist_definition_cam.xml)
+! however, a topo file needs to be supplied to run the Beta Ridge gravity wave scheme.
+!
+! in the future, the FCAM7 test can be migrated to using 'real' initial conditions,
+! and this line can be removed, and
+! analytic ic runs can go back to having no topo file supplied as it is by default.
+bnd_topo='/glade/campaign/cesm/cesmdata/inputdata/atm/cam/topo/se/ne3pg3_gmted2010_modis_bedmachine_nc0540_Laplace1000_noleak_20230209.nc'

src/control/cam_comp.F90

@@ -101,6 +101,7 @@ subroutine cam_init(caseid, ctitle, model_doi_url,                         &
       use vert_coord,                only: pver
       use phys_vars_init_check,      only: mark_as_initialized
       use tropopause_climo_read,     only: tropopause_climo_read_file
+      use gravity_wave_drag_ridge_read, only: gravity_wave_drag_ridge_read_file
       use orbital_data,              only: orbital_data_init
       use ccpp_kinds,                only: kind_phys
       use ccpp_constituent_prop_mod, only: ccpp_constituent_prop_ptr_t
@@ -243,6 +244,9 @@ subroutine cam_init(caseid, ctitle, model_doi_url,                         &
       ! Read tropopause climatology
       call tropopause_climo_read_file()
 
+      ! Read gravity wave drag data for ridge parameterization
+      call gravity_wave_drag_ridge_read_file()
+
       ! TEMPORARY:  Prescribe realistic but inaccurate physical quantities
       ! necessary for MUSICA that are currently unavailable in CAM-SIMA.
       !

src/control/runtime_obj.F90

@@ -20,10 +20,6 @@ module runtime_obj
    type, public :: runtime_options
       character(len=CS), private            :: phys_suite = unset_str
       character(len=16), private            :: waccmx_opt = unset_str
-      ! use_gw_front: Frontogenesis
-      logical,           private :: use_gw_front = .false.
-      ! use_gw_front_igw: Frontogenesis to inertial spectrum.
-      logical,           private :: use_gw_front_igw = .false.
       ! update_thermo_variables: update thermo "constants" to composition-dependent thermo variables
       logical,           private :: update_thermo_variables = .false.
    contains
@@ -33,8 +29,6 @@ module runtime_obj
       ! Runtime parameters of interest to dycore
       procedure, public :: waccmx_on
       procedure, public :: waccmx_option
-      procedure, public :: gw_front
-      procedure, public :: gw_front_igw
       procedure, public :: update_thermodynamic_variables
    end type runtime_options
 
@@ -74,35 +68,19 @@ pure character(len=16) function waccmx_option(self)
 
    end function waccmx_option
 
-   pure logical function gw_front(self)
-      class(runtime_options), intent(in) :: self
-
-      gw_front = self%use_gw_front
-
-   end function gw_front
-
-   pure logical function gw_front_igw(self)
-      class(runtime_options), intent(in) :: self
-
-      gw_front_igw = self%use_gw_front_igw
-
-   end function gw_front_igw
-
    pure logical function update_thermodynamic_variables(self)
       class(runtime_options), intent(in) :: self
 
       update_thermodynamic_variables = self%update_thermo_variables
 
    end function update_thermodynamic_variables
 
-   subroutine cam_set_runtime_opts(phys_suite, waccmx_opt,                    &
-        gw_front, gw_front_igw)
+   subroutine cam_set_runtime_opts(phys_suite, waccmx_opt)
       use cam_abortutils, only: endrun
+
       ! Initialize the CAM runtime object
       character(len=CS), intent(in) :: phys_suite
       character(len=16), intent(in) :: waccmx_opt
-      logical,           intent(in) :: gw_front
-      logical,           intent(in) :: gw_front_igw
 
       if (runtime_configured) then
          ! We might need more action to reset this so do not allow it now
@@ -111,8 +89,6 @@ subroutine cam_set_runtime_opts(phys_suite, waccmx_opt,                    &
 
       cam_runtime_opts%phys_suite = trim(phys_suite)
       cam_runtime_opts%waccmx_opt = trim(waccmx_opt)
-      cam_runtime_opts%use_gw_front = gw_front
-      cam_runtime_opts%use_gw_front_igw = gw_front_igw
       cam_runtime_opts%update_thermo_variables = (trim(waccmx_opt) == 'ionosphere' .or. &
             trim(waccmx_opt) == 'neutral')