Adds support for TEMPO microphysics with 2-moment/predicted density graupel

.gitmodules

@@ -8,8 +8,8 @@
   branch = main
 [submodule "ccpp/physics"]
   path = ccpp/physics
-  url = https://github.com/ufs-community/ccpp-physics
-  branch = ufs/dev
+  url = https://github.com/AndersJensen-NOAA/ccpp-physics
+  branch = tempo_submodule
 [submodule "upp"]
   path = upp
   url = https://github.com/NOAA-EMC/UPP

CMakeLists.txt

@@ -23,6 +23,10 @@ endif()
 ###############################################################################
 
 set(MPI ON)
+# DJS asks Anders: These two PP directives are needed in TEMPO. We should avoid
+# using PP directives if possible, so let's plan to remove them if feasible.
+set(OLD_MPTBLS ON)
+set(ccpp_default ON)
 add_subdirectory(ccpp)
 
 ###############################################################################

ccpp/CMakeLists.txt

@@ -49,6 +49,12 @@ add_definitions(-DFV3)
 if(MPI)
   add_definitions(-DMPI)
 endif()
+if (OLD_MPTBLS)
+  add_definitions(-DOLD_MPTBLS)
+endif()
+if (ccpp_default)
+  add_definitions(-Dccpp_default)
+endif()
 
 #------------------------------------------------------------------------------
 # Set flag for 32bit dynamics build

ccpp/config/ccpp_prebuild_config.py

@@ -20,6 +20,7 @@
     'physics/physics/Radiation/RRTMG/radsw_param.f',
     'physics/physics/Radiation/RRTMG/radlw_param.f',
     'physics/physics/photochem/module_ozphys.F90',
+    'physics/physics/MP/TEMPO/tempo/module_mp_thompson_params.F90',
     'physics/physics/photochem/module_h2ophys.F90',
     'data/CCPP_typedefs.F90',
     'data/GFS_typedefs.F90',
@@ -45,6 +46,9 @@
         'module_ozphys' : '',
         'ty_ozphys'     : '',
         },
+    'module_mp_thompson_params' : {
+        'module_mp_thompson_params' : '',
+        'ty_tempo_cfg'     : '',
     'module_h2ophys' : {
         'module_h2ophys' : '',
         'ty_h2ophys'     : '',
@@ -167,6 +171,10 @@
     'physics/physics/MP/Thompson/mp_thompson_pre.F90',
     'physics/physics/MP/Thompson/mp_thompson.F90',
     'physics/physics/MP/Thompson/mp_thompson_post.F90',
+    'physics/physics/MP/TEMPO/tempo/module_mp_thompson_params.F90',
+    'physics/physics/MP/TEMPO/mp_tempo_pre.F90',
+    'physics/physics/MP/TEMPO/mp_tempo.F90',
+    'physics/physics/MP/TEMPO/mp_tempo_post.F90',
     'physics/physics/MP/Zhao_Carr/zhaocarr_gscond.f',
     'physics/physics/MP/Zhao_Carr/zhaocarr_precpd.f',
     'physics/physics/PBL/HEDMF/hedmf.f',

ccpp/data/GFS_typedefs.F90

@@ -14,6 +14,7 @@ module GFS_typedefs
 
    use module_radsw_parameters,  only: topfsw_type, sfcfsw_type
    use module_radlw_parameters,  only: topflw_type, sfcflw_type
+   use module_mp_thompson_params,only: ty_tempo_cfg
    use module_ozphys,            only: ty_ozphys
    use module_h2ophys,           only: ty_h2ophys
 
@@ -932,6 +933,7 @@ module GFS_typedefs
     integer              :: imp_physics                    !< choice of microphysics scheme
     integer              :: imp_physics_gfdl          = 11 !< choice of GFDL     microphysics scheme
     integer              :: imp_physics_thompson      = 8  !< choice of Thompson microphysics scheme
+    integer              :: imp_physics_tempo         = 8  !< choice of TEMPO    microphysics scheme
     integer              :: imp_physics_wsm6          = 6  !< choice of WSMG     microphysics scheme
     integer              :: imp_physics_zhao_carr     = 99 !< choice of Zhao-Carr microphysics scheme
     integer              :: imp_physics_zhao_carr_pdf = 98 !< choice of Zhao-Carr microphysics scheme with PDF clouds
@@ -1016,6 +1018,7 @@ module GFS_typedefs
     !--- Thompson's microphysical parameters
     logical              :: ltaerosol       !< flag for aerosol version
     logical              :: mraerosol       !< flag for merra2_aerosol_aware
+    logical              :: lthailaware     !< flag for hail-aware version
     logical              :: lradar          !< flag for radar reflectivity
     real(kind=kind_phys) :: nsfullradar_diag!< seconds between resetting radar reflectivity calculation
     real(kind=kind_phys) :: ttendlim        !< temperature tendency limiter per time step in K/s
@@ -1024,6 +1027,7 @@ module GFS_typedefs
     real(kind=kind_phys) :: dt_inner        !< time step for the inner loop in s
     logical              :: sedi_semi       !< flag for semi Lagrangian sedi of rain
     integer              :: decfl           !< deformed CFL factor
+    type(ty_tempo_cfg)   :: tempo_cfg       !< Thompson MP configuration information.
     logical              :: thpsnmp_is_init !< Local scheme initialization flag
 
     !--- GFDL microphysical paramters
@@ -3212,13 +3216,13 @@ subroutine coupling_create (Coupling, Model)
       Coupling%spp_wts_cu_deep = clear_val
     endif
 
-    !--- needed for Thompson's aerosol option
-    if(Model%imp_physics == Model%imp_physics_thompson .and. (Model%ltaerosol .or. Model%mraerosol)) then
+    !--- needed for Thompson/TEMPO's aerosol option
+    if((Model%imp_physics == Model%imp_physics_thompson .or. Model%imp_physics == Model%imp_physics_tempo).and. (Model%ltaerosol .or. Model%mraerosol)) then
       allocate (Coupling%nwfa2d (IM))
       allocate (Coupling%nifa2d (IM))
       Coupling%nwfa2d   = clear_val
       Coupling%nifa2d   = clear_val
-    endif
+   endif
 
     if(Model%rrfs_sd) then
     !--- needed for smoke aerosol option
@@ -3538,6 +3542,7 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
     !--- Thompson microphysical parameters
     logical              :: ltaerosol      = .false.            !< flag for aerosol version
     logical              :: mraerosol      = .false.            !< flag for merra2_aerosol_aware
+    logical              :: lthailaware    = .false.            !< flag for hail-aware version
     logical              :: lradar         = .false.            !< flag for radar reflectivity
     real(kind=kind_phys) :: nsfullradar_diag  = -999.0          !< seconds between resetting radar reflectivity calculation, set to <0 for every time step
     real(kind=kind_phys) :: ttendlim       = -999.0             !< temperature tendency limiter, set to <0 to deactivate
@@ -4029,8 +4034,8 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
                                mg_do_graupel, mg_do_hail, mg_nccons, mg_nicons, mg_ngcons,  &
                                mg_ncnst, mg_ninst, mg_ngnst, sed_supersat, do_sb_physics,   &
                                mg_alf,   mg_qcmin, mg_do_ice_gmao, mg_do_liq_liu,           &
-                               ltaerosol, lradar, nsfullradar_diag, lrefres, ttendlim,      &
-                               ext_diag_thompson, dt_inner, lgfdlmprad,                     &
+                               ltaerosol, lthailaware, lradar, nsfullradar_diag, lrefres,   &
+                               ttendlim, ext_diag_thompson, dt_inner, lgfdlmprad,           &
                                sedi_semi, decfl,                                            &
                                nssl_cccn, nssl_alphah, nssl_alphahl,                        &
                                nssl_alphar, nssl_ehw0, nssl_ehlw0,                          &
@@ -4679,6 +4684,7 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
 !--- Thompson MP parameters
     Model%ltaerosol        = ltaerosol
     Model%mraerosol        = mraerosol
+    Model%lthailaware      = lthailaware
     if (Model%ltaerosol .and. Model%mraerosol) then
       write(0,*) 'Logic error: Only one Thompson aerosol option can be true, either ltaerosol or mraerosol)'
       stop
@@ -4694,6 +4700,16 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
     endif
     Model%sedi_semi        = sedi_semi
     Model%decfl            = decfl
+
+!--- TEMPO MP parameters
+! DJS to Anders: Maybe we put more of these nml options into the TEMPO configuration type?
+    Model%tempo_cfg%aerosol_aware = (ltaerosol .or. mraerosol)
+    Model%tempo_cfg%hail_aware    = lthailaware
+    if (Model%ltaerosol .and. Model%mraerosol) then
+       write(0,*) 'Logic error: Only one TEMPO aerosol option can be true, either ltaerosol or mraerosol)'
+       stop
+   end if
+
 !--- F-A MP parameters
     Model%rhgrd            = rhgrd
     Model%spec_adv         = spec_adv
@@ -4796,11 +4812,11 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
     Model%use_ufo          = use_ufo
     Model%exticeden        = exticeden
     if (Model%exticeden .and. &
-      (Model%imp_physics /= Model%imp_physics_gfdl .and. Model%imp_physics /= Model%imp_physics_thompson .and. &
-       Model%imp_physics /= Model%imp_physics_nssl )) then
+      (Model%imp_physics /= Model%imp_physics_gfdl  .and. Model%imp_physics /= Model%imp_physics_thompson .and. &
+       Model%imp_physics /= Model%imp_physics_tempo .and. Model%imp_physics /= Model%imp_physics_nssl )) then
       !see GFS_MP_generic_post.F90; exticeden is only compatible with GFDL,
       !Thompson, or NSSL MP
-      print *,' Using exticeden = T is only valid when using GFDL, Thompson, or NSSL microphysics.'
+      print *,' Using exticeden = T is only valid when using GFDL, Thompson, TEMPO, or NSSL microphysics.'
       stop
     end if
 ! GFDL surface layer options
@@ -5715,8 +5731,8 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
 !--- BEGIN CODE FROM COMPNS_PHYSICS
 !--- shoc scheme
     if (do_shoc) then
-      if (Model%imp_physics == Model%imp_physics_thompson) then
-        print *,'SHOC is not currently compatible with Thompson MP -- shutting down'
+      if (Model%imp_physics == Model%imp_physics_thompson .or. Model%imp_physics == Model%imp_physics_tempo) then
+        print *,'SHOC is not currently compatible with Thompson or TEMPO MP -- shutting down'
         stop
       endif
       Model%nshoc_3d   = 3
@@ -6076,7 +6092,7 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
                                           ' num_p2d =',Model%num_p2d
 
 
-    elseif (Model%imp_physics == Model%imp_physics_thompson) then !Thompson microphysics
+    elseif (Model%imp_physics == Model%imp_physics_thompson .or. Model%imp_physics == Model%imp_physics_tempo) then !Thompson/TEMPO microphysics
       Model%npdf3d  = 0
       Model%num_p3d = 3
       Model%num_p2d = 1
@@ -6096,6 +6112,7 @@ subroutine control_initialize (Model, nlunit, fn_nml, me, master, &
       if (Model%me == Model%master) print *,' Using Thompson double moment microphysics', &
                                           ' ltaerosol = ',Model%ltaerosol, &
                                           ' mraerosol = ',Model%mraerosol, &
+                                          ' lthailaware = ',Model%lthailaware, &
                                           ' ttendlim =',Model%ttendlim, &
                                           ' ext_diag_thompson =',Model%ext_diag_thompson, &
                                           ' dt_inner =',Model%dt_inner, &
@@ -6634,10 +6651,11 @@ subroutine control_print(Model)
         print *, ' wminco            : ', Model%wminco
         print *, ' '
       endif
-      if (Model%imp_physics == Model%imp_physics_wsm6 .or. Model%imp_physics == Model%imp_physics_thompson) then
-        print *, ' Thompson microphysical parameters'
+      if (Model%imp_physics == Model%imp_physics_wsm6 .or. Model%imp_physics == Model%imp_physics_thompson .or. Model%imp_physics == Model%imp_physics_tempo) then
+        print *, ' Thompson/TEMPO microphysical parameters'
         print *, ' ltaerosol         : ', Model%ltaerosol
         print *, ' mraerosol         : ', Model%mraerosol
+        print *, ' lthailaware       : ', Model%lthailaware
         print *, ' lradar            : ', Model%lradar
         print *, ' nsfullradar_diag  : ', Model%nsfullradar_diag
         print *, ' lrefres           : ', Model%lrefres

ccpp/data/GFS_typedefs.meta

@@ -4311,6 +4311,12 @@
   units = flag
   dimensions = ()
   type = integer
+[imp_physics_tempo]
+  standard_name = identifier_for_tempo_microphysics_scheme
+  long_name = choice of TEMPO microphysics scheme
+  units = flag
+  dimensions = ()
+  type = integer
 [imp_physics_wsm6]
   standard_name = identifier_for_wsm6_microphysics_scheme
   long_name = choice of WSM6 microphysics scheme
@@ -4835,6 +4841,12 @@
   units = flag
   dimensions = ()
   type = logical
+[lthailaware]
+  standard_name = flag_for_hail_physics
+  long_name = flag for hail physics
+  units = flag
+  dimensions = ()
+  type = logical
 [mraerosol]
   standard_name = do_merra2_aerosol_awareness
   long_name = flag for merra2 aerosol-aware physics for example the thompson microphysics
@@ -4885,6 +4897,12 @@
   units = count
   dimensions = ()
   type = integer
+[tempo_cfg]
+  standard_name = configuration_for_TEMPO_microphysics
+  long_name = configuration information for TEMPO microphysics
+  units = mixed
+  dimensions = ()
+  type = ty_tempo_cfg
 [thpsnmp_is_init]
   standard_name = flag_for_thompson_mp_scheme_initialization
   long_name = flag carrying scheme initialization status
@@ -10069,6 +10087,7 @@
   relative_path = ../physics/physics/
   dependencies = hooks/machine.F,hooks/physcons.F90
   dependencies = Radiation/RRTMG/radlw_param.f,Radiation/RRTMG/radsw_param.f
+  dependencies = MP/TEMPO/tempo/module_mp_thompson_params.F90
   dependencies = photochem/module_ozphys.F90,photochem/module_h2ophys.F90
   dependencies = MP/GFDL/GFDL_parse_tracers.F90
 

ccpp/suites/suite_FV3_GFS_v17_p8_ugwpv1_tempo.xml

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<suite name="FV3_GFS_v17_p8_ugwpv1_tempo" version="1">
+  <!-- <init></init> -->
+  <group name="time_vary">
+    <subcycle loop="1">
+      <scheme>GFS_time_vary_pre</scheme>
+      <scheme>GFS_rrtmg_setup</scheme>
+      <scheme>GFS_rad_time_vary</scheme>
+      <scheme>GFS_phys_time_vary</scheme>
+    </subcycle>
+  </group>
+  <group name="radiation">
+    <subcycle loop="1">
+      <scheme>GFS_suite_interstitial_rad_reset</scheme>
+      <scheme>GFS_rrtmg_pre</scheme>
+      <scheme>GFS_radiation_surface</scheme>
+      <scheme>rad_sw_pre</scheme>
+      <scheme>rrtmg_sw</scheme>
+      <scheme>rrtmg_sw_post</scheme>
+      <scheme>rrtmg_lw</scheme>
+      <scheme>rrtmg_lw_post</scheme>
+      <scheme>GFS_rrtmg_post</scheme>
+    </subcycle>
+  </group>
+  <group name="physics">
+    <subcycle loop="1">
+      <scheme>GFS_suite_interstitial_phys_reset</scheme>
+      <scheme>GFS_suite_stateout_reset</scheme>
+      <scheme>get_prs_fv3</scheme>
+      <scheme>GFS_suite_interstitial_1</scheme>
+      <scheme>GFS_surface_generic_pre</scheme>
+      <scheme>GFS_surface_composites_pre</scheme>
+      <scheme>dcyc2t3</scheme>
+      <scheme>GFS_surface_composites_inter</scheme>
+      <scheme>GFS_suite_interstitial_2</scheme>
+    </subcycle>
+    <!-- Surface iteration loop -->
+    <subcycle loop="2">
+      <scheme>sfc_diff</scheme>
+      <scheme>GFS_surface_loop_control_part1</scheme>
+      <scheme>sfc_nst_pre</scheme>
+      <scheme>sfc_nst</scheme>
+      <scheme>sfc_nst_post</scheme>
+      <scheme>noahmpdrv</scheme>
+      <scheme>sfc_sice</scheme>
+      <scheme>GFS_surface_loop_control_part2</scheme>
+    </subcycle>
+    <!-- End of surface iteration loop -->
+    <subcycle loop="1">
+      <scheme>GFS_surface_composites_post</scheme>
+      <scheme>sfc_diag</scheme>
+      <scheme>sfc_diag_post</scheme>
+      <scheme>GFS_surface_generic_post</scheme>
+      <scheme>GFS_PBL_generic_pre</scheme>
+      <scheme>satmedmfvdifq</scheme>
+      <scheme>GFS_PBL_generic_post</scheme>
+      <scheme>GFS_GWD_generic_pre</scheme>
+      <scheme>ugwpv1_gsldrag</scheme>
+      <scheme>ugwpv1_gsldrag_post</scheme>
+      <scheme>GFS_GWD_generic_post</scheme>
+      <scheme>GFS_suite_stateout_update</scheme>
+      <scheme>h2ophys</scheme>
+      <scheme>get_phi_fv3</scheme>
+      <scheme>GFS_suite_interstitial_3</scheme>
+      <scheme>GFS_DCNV_generic_pre</scheme>
+      <scheme>samfdeepcnv</scheme>
+      <scheme>GFS_DCNV_generic_post</scheme>
+      <scheme>GFS_SCNV_generic_pre</scheme>
+      <scheme>samfshalcnv</scheme>
+      <scheme>GFS_SCNV_generic_post</scheme>
+      <scheme>GFS_suite_interstitial_4</scheme>
+      <scheme>cnvc90</scheme>
+      <scheme>GFS_MP_generic_pre</scheme>
+      <scheme>mp_tempo_pre</scheme>
+      </subcycle>
+      <subcycle loop="1">
+        <scheme>mp_tempo</scheme>
+      </subcycle>
+        <subcycle loop="1">
+        <scheme>mp_tempo_post</scheme>
+        <scheme>GFS_MP_generic_post</scheme>
+        <scheme>maximum_hourly_diagnostics</scheme>
+      </subcycle>
+  </group>
+  <group name="stochastics">
+    <subcycle loop="1">
+      <scheme>GFS_stochastics</scheme>
+      <scheme>GFS_physics_post</scheme>
+    </subcycle>
+  </group>
+  <!-- <finalize></finalize> -->
+</suite>