Ensure consistency between model namelist and CCPP suite definition file UPDATED with head of MAIN

physics/GFS_rrtmg_setup.F90

@@ -49,7 +49,7 @@ subroutine GFS_rrtmg_setup_init (                          &
           icliq_sw, crick_proof, ccnorm,                      &
           imp_physics,                                        &
           norad_precip, idate, iflip,                         &
-          im, faerlw, faersw, aerodp,                         & ! for consistency checks
+          do_RRTMGP, im, faerlw, faersw, aerodp,              & ! for consistency checks
           me, errmsg, errflg)
 ! =================   subprogram documentation block   ================ !
 !                                                                       !
@@ -188,6 +188,8 @@ subroutine GFS_rrtmg_setup_init (                          &
       integer, intent(in) :: idate(:)
       integer, intent(in) :: iflip
       ! For consistency checks
+
+      logical, intent(in)         :: do_RRTMGP
       integer, intent(in)         :: im
       real(kind_phys), intent(in) :: faerlw(:,:,:,:)
       real(kind_phys), intent(in) :: faersw(:,:,:,:)
@@ -208,6 +210,12 @@ subroutine GFS_rrtmg_setup_init (                          &
       errflg = 0
 
       if (is_initialized) return
+
+      if (do_RRTMGP) then
+        write(errmsg,'(*(a))') "Logic error: do_RRTMGP must be set to .false."
+        errflg = 1
+        return
+      end if
 
       ! Consistency checks for dimensions of arrays, this is required
       ! to detect differences in FV3's parameters that are used to

physics/GFS_rrtmg_setup.meta

@@ -185,6 +185,14 @@
   type = integer
   intent = in
   optional = F
+[do_RRTMGP]
+  standard_name = flag_for_rrtmgp_radiation_scheme
+  long_name = flag for RRTMGP scheme
+  units = flag
+  dimensions =  ()
+  type = logical
+  intent = in
+  optional = F
 [im]
   standard_name = horizontal_dimension
   long_name = horizontal dimension

physics/GFS_rrtmgp_setup.F90

@@ -40,13 +40,14 @@ module GFS_rrtmgp_setup
 !! \section arg_table_GFS_rrtmgp_setup_init
 !! \htmlinclude GFS_rrtmgp_setup_init.html
 !!
-  subroutine GFS_rrtmgp_setup_init(imp_physics, imp_physics_fer_hires, imp_physics_gfdl,    &
-       imp_physics_thompson, imp_physics_wsm6, imp_physics_zhao_carr,                       &
+  subroutine GFS_rrtmgp_setup_init(do_RRTMGP, imp_physics, imp_physics_fer_hires,           &
+       imp_physics_gfdl, imp_physics_thompson, imp_physics_wsm6, imp_physics_zhao_carr,     &
        imp_physics_zhao_carr_pdf, imp_physics_mg,  si, levr, ictm, isol, ico2, iaer, ialb,  &
        iems, ntcw, num_p3d,  ntoz, iovr, isubc_sw, isubc_lw, icliq_sw, crick_proof, ccnorm, &
        norad_precip, idate, iflip, me, errmsg, errflg)
 
     ! Inputs
+    logical, intent(in) :: do_RRTMGP
     integer, intent(in) :: &
          imp_physics,               & ! Flag for MP scheme
          imp_physics_fer_hires,     & ! Flag for fer-hires scheme
@@ -75,7 +76,14 @@ subroutine GFS_rrtmgp_setup_init(imp_physics, imp_physics_fer_hires, imp_physics
     errflg = 0
 
     if (is_initialized) return
-
+
+    ! Consistency checks
+    if (.not. do_RRTMGP) then
+      write(errmsg,'(*(a))') "Logic error: do_RRTMGP must be set to .true."
+      errflg = 1
+      return
+    end if
+
     ! Set radiation parameters
     isolar  = isol                     ! solar constant control flag
     ictmflg = ictm                     ! data ic time/date control flag

physics/GFS_rrtmgp_setup.meta

@@ -8,6 +8,14 @@
 [ccpp-arg-table]
   name = GFS_rrtmgp_setup_init
   type = scheme
+[do_RRTMGP]
+  standard_name = flag_for_rrtmgp_radiation_scheme
+  long_name = flag for RRTMGP scheme
+  units = flag
+  dimensions =  ()
+  type = logical
+  intent = in
+  optional = F
 [imp_physics]
   standard_name = flag_for_microphysics_scheme
   long_name = choice of microphysics scheme

physics/cires_ugwp.F90

@@ -40,7 +40,7 @@ module cires_ugwp
 !
     subroutine cires_ugwp_init (me, master, nlunit, input_nml_file, logunit, &
                 fn_nml2, lonr, latr, levs, ak, bk, dtp, cdmbgwd, cgwf,       &
-                pa_rf_in, tau_rf_in, con_p0, do_ugwp, errmsg, errflg)
+                pa_rf_in, tau_rf_in, con_p0, gwd_opt,do_ugwp, errmsg, errflg)
 
 !----  initialization of cires_ugwp
     implicit none
@@ -58,6 +58,7 @@ subroutine cires_ugwp_init (me, master, nlunit, input_nml_file, logunit, &
     real(kind=kind_phys), intent (in) :: cdmbgwd(:), cgwf(:) ! "scaling" controls for "old" GFS-GW schemes
     real(kind=kind_phys), intent (in) :: pa_rf_in, tau_rf_in
     real(kind=kind_phys), intent (in) :: con_p0
+    integer,              intent(in)  :: gwd_opt
     logical,              intent (in) :: do_ugwp
 
     character(len=*), intent (in) :: fn_nml2
@@ -76,6 +77,14 @@ subroutine cires_ugwp_init (me, master, nlunit, input_nml_file, logunit, &
     errflg = 0
 
     if (is_initialized) return
+
+    ! Consistency checks
+    if (gwd_opt/=1) then
+      write(errmsg,'(*(a))') "Logic error: namelist choice of gravity wave &
+      & drag is different from cires_ugwp scheme"
+      errflg = 1
+      return
+    end if  
 
     if (do_ugwp .or. cdmbgwd(3) > 0.0) then
       call cires_ugwpv0_mod_init (me, master, nlunit, input_nml_file, logunit, &

physics/cires_ugwp.meta

@@ -155,6 +155,14 @@
   kind = kind_phys
   intent = in
   optional = F
+[gwd_opt]
+  standard_name = gwd_opt
+  long_name = flag to choose gwd scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
 [do_ugwp]
   standard_name = do_ugwp
   long_name = flag to activate CIRES UGWP

physics/cu_gf_driver.F90

@@ -23,10 +23,13 @@ module cu_gf_driver
 !! \section arg_table_cu_gf_driver_init Argument Table
 !! \htmlinclude cu_gf_driver_init.html
 !!
-      subroutine cu_gf_driver_init(mpirank, mpiroot, errmsg, errflg)
+      subroutine cu_gf_driver_init(imfshalcnv, imfshalcnv_gf, imfdeepcnv, &
+                          imfdeepcnv_gf,mpirank, mpiroot, errmsg, errflg)
 
          implicit none
-
+
+         integer,                   intent(in) :: imfshalcnv, imfshalcnv_gf
+         integer,                   intent(in) :: imfdeepcnv, imfdeepcnv_gf       
          integer,                   intent(in)    :: mpirank
          integer,                   intent(in)    :: mpiroot
          character(len=*),          intent(  out) :: errmsg
@@ -44,6 +47,15 @@ subroutine cu_gf_driver_init(mpirank, mpiroot, errmsg, errflg)
          end if
          ! *DH temporary
 
+         ! Consistency checks
+         if (.not. (imfshalcnv == imfshalcnv_gf .or.                       &
+        &        imfdeepcnv == imfdeepcnv_gf)) then
+           write(errmsg,'(*(a))') 'Logic error: namelist choice of',       &
+        &    ' convection is different from Grell-Freitas scheme'
+           errflg = 1
+           return
+         end if
+
       end subroutine cu_gf_driver_init
 
       subroutine cu_gf_driver_finalize()

physics/cu_gf_driver.meta

@@ -7,6 +7,38 @@
 [ccpp-arg-table]
   name = cu_gf_driver_init
   type = scheme
+[imfshalcnv]
+  standard_name = flag_for_mass_flux_shallow_convection_scheme
+  long_name = flag for mass-flux shallow convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[imfshalcnv_gf]
+  standard_name = flag_for_gf_shallow_convection_scheme
+  long_name = flag for Grell-Freitas shallow convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[imfdeepcnv]
+  standard_name = flag_for_mass_flux_deep_convection_scheme
+  long_name = flag for mass-flux deep convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[imfdeepcnv_gf]
+  standard_name = flag_for_gf_deep_convection_scheme
+  long_name = flag for Grell-Freitas deep convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
 [mpirank]
   standard_name = mpi_rank
   long_name = current MPI-rank

physics/cu_ntiedtke.F90

@@ -106,10 +106,13 @@ module cu_ntiedtke
 !! \section arg_table_cu_ntiedtke_init Argument Table
 !! \htmlinclude cu_ntiedtke_init.html
 !!
-      subroutine cu_ntiedtke_init(mpirank, mpiroot, errmsg, errflg)
+      subroutine cu_ntiedtke_init(imfshalcnv, imfshalcnv_ntiedtke, imfdeepcnv,  &
+                          imfdeepcnv_ntiedtke,mpirank, mpiroot, errmsg, errflg)
 
          implicit none
 
+         integer,                   intent(in) :: imfshalcnv, imfshalcnv_ntiedtke
+         integer,                   intent(in) :: imfdeepcnv, imfdeepcnv_ntiedtke           
          integer,                   intent(in)    :: mpirank
          integer,                   intent(in)    :: mpiroot
          character(len=*),          intent(  out) :: errmsg
@@ -127,6 +130,21 @@ subroutine cu_ntiedtke_init(mpirank, mpiroot, errmsg, errflg)
          end if
          ! *DH temporary
 
+         ! Consistency checks
+         if (imfshalcnv/=imfshalcnv_ntiedtke) then
+           write(errmsg,'(*(a))') 'Logic error: namelist choice of',       &
+        &    ' shallow convection is different from new Tiedtke scheme'
+           errflg = 1
+           return
+         end if
+
+         if (imfdeepcnv/=imfdeepcnv_ntiedtke) then
+           write(errmsg,'(*(a))') 'Logic error: namelist choice of',       &
+        &    ' deep convection is different from new Tiedtke scheme'
+           errflg = 1
+           return
+         end if
+
       end subroutine cu_ntiedtke_init
 
       subroutine cu_ntiedtke_finalize()

physics/cu_ntiedtke.meta

@@ -7,6 +7,38 @@
 [ccpp-arg-table]
   name = cu_ntiedtke_init
   type = scheme
+[imfshalcnv]
+  standard_name = flag_for_mass_flux_shallow_convection_scheme
+  long_name = flag for mass-flux shallow convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[imfshalcnv_ntiedtke]
+  standard_name = flag_for_ntiedtke_shallow_convection_scheme
+  long_name = flag for new Tiedtke shallow convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[imfdeepcnv]
+  standard_name = flag_for_mass_flux_deep_convection_scheme
+  long_name = flag for mass-flux deep convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[imfdeepcnv_ntiedtke]
+  standard_name = flag_for_ntiedtke_deep_convection_scheme
+  long_name = flag for new Tiedtke deep convection scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
 [mpirank]
   standard_name = mpi_rank
   long_name = current MPI-rank

physics/drag_suite.F90

@@ -7,7 +7,24 @@ module drag_suite
 
       contains
 
-      subroutine drag_suite_init()
+      subroutine drag_suite_init(gwd_opt, errmsg, errflg)
+
+      integer,          intent(in)  :: gwd_opt
+      character(len=*), intent(out) :: errmsg
+      integer,          intent(out) :: errflg
+
+
+      ! Initialize CCPP error handling variables
+      errmsg = ''
+      errflg = 0
+
+      ! Consistency checks
+      if (gwd_opt/=3 .and. gwd_opt/=33) then
+        write(errmsg,'(*(a))') "Logic error: namelist choice of gravity wave &
+          & drag is different from drag_suite scheme"
+        errflg = 1
+        return
+      end if        
       end subroutine drag_suite_init
 
 ! \defgroup GFS_ogwd GFS Orographic Gravity Wave Drag

physics/drag_suite.meta

@@ -3,6 +3,36 @@
   type = scheme
   dependencies = 
 
+########################################################################
+[ccpp-arg-table]
+  name = unified_ugwp_init
+  type = scheme
+[gwd_opt]
+  standard_name = gwd_opt
+  long_name = flag to choose gwd scheme
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[errmsg]
+  standard_name = ccpp_error_message
+  long_name = error message for error handling in CCPP
+  units = none
+  dimensions = ()
+  type = character
+  kind = len=*
+  intent = out
+  optional = F
+[errflg]
+  standard_name = ccpp_error_flag
+  long_name = error flag for error handling in CCPP
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = out
+  optional = F
+
 ########################################################################
 [ccpp-arg-table]
   name = drag_suite_run

physics/gcm_shoc.F90

@@ -14,7 +14,22 @@ module shoc
 
 contains
 
-subroutine shoc_init ()
+subroutine shoc_init (do_shoc, errmsg, errflg)
+  implicit none
+  logical, intent(in) :: do_shoc
+  character(len=*), intent(out) :: errmsg
+  integer,          intent(out) :: errflg
+
+! Initialize CCPP error handling variables
+  errmsg = ''
+  errflg = 0
+
+! Consistency checks
+  if (.not. do_shoc) then
+    errflg = 1
+    write(errmsg,'(*(a))') 'Logic error: do_shoc == .false.'
+    return
+  end if
 end subroutine shoc_init
 
 subroutine shoc_finalize ()