Implement parcel_hscale as a namelist parameter in ZM deep convection scheme (#214)

Originator(s): swrneale

Description (include issue title and the keyword ['closes', 'fixes',
'resolves'] and issue number):
From issue
[#203](#203) "Change
the 'parcel_hscale' parameter in the ZM convection (zm_conv_intr.F90) to
a namelist parameter"
This PR is needed in parallel with ESCOMP/cam PR#
[1266](ESCOMP/CAM#1266)

List all namelist files that were added or changed:
M       schemes/zhang_mcfarlane/zm_conv_options_namelist.xml
 - Added new 'zmconv_parcel_hscale' namelist parameter for ZM scheme 

List all files eliminated and why: N/A

List all files added and what they do: N/A

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

M       schemes/zhang_mcfarlane/zm_conv_options.F90
M       schemes/zhang_mcfarlane/zm_conv_options.meta
 - Added new 'zmconv_parcel_hscale' namelist parameter for ZM scheme

M       schemes/zhang_mcfarlane/zm_convr.F90
M       schemes/zhang_mcfarlane/zm_convr.meta
- Replace hardcoded 'parcel_hscale' parameter with
'zmconv_parcel_hscale' namelist variable in core ZM scheme (zm_convr).

List all automated tests that failed, as well as an explanation for why
they weren't fixed:


Is this an answer-changing PR? If so, is it a new physics package,
algorithm change, tuning change, etc?
No

If yes to the above question, describe how this code was validated with
the new/modified features:

---------

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

Author: swrneale

schemes/zhang_mcfarlane/zm_conv_options.F90

@@ -13,7 +13,8 @@ subroutine zm_conv_options_init(masterproc, iulog, &
     zmconv_c0_lnd, zmconv_c0_ocn, zmconv_ke, zmconv_ke_lnd, &
     zmconv_momcu, zmconv_momcd, zmconv_num_cin, &
     no_deep_pbl_in, zmconv_tiedke_add, &
-    zmconv_capelmt, zmconv_dmpdz, zmconv_parcel_pbl, zmconv_tau)
+    zmconv_capelmt, zmconv_dmpdz, zmconv_parcel_pbl, &
+    zmconv_parcel_hscale, zmconv_tau)
 
     integer, intent(in)                  :: zmconv_num_cin  ! Number of negative buoyancy regions that are allowed
                                                              ! before the convection top and CAPE calculations are completed.
@@ -28,6 +29,7 @@ subroutine zm_conv_options_init(masterproc, iulog, &
     real(kind_phys),intent(in)           :: zmconv_capelmt
     real(kind_phys),intent(in)           :: zmconv_dmpdz
     logical, intent(in)                  :: zmconv_parcel_pbl ! Should the parcel properties include PBL mixing?
+    real(kind_phys),intent(in)           :: zmconv_parcel_hscale ! Fraction of PBL depth used to set initial ZM parcel properties
     real(kind_phys),intent(in)           :: zmconv_tau
     logical, intent(in)                  :: masterproc
     integer, intent(in)                  :: iulog
@@ -42,6 +44,7 @@ subroutine zm_conv_options_init(masterproc, iulog, &
       write(iulog,*) 'tuning parameters zm_conv_options_init: zm_dmpdz', zmconv_dmpdz
       write(iulog,*) 'tuning parameters zm_conv_options_init: zm_tiedke_add', zmconv_tiedke_add
       write(iulog,*) 'tuning parameters zm_conv_options_init: zm_parcel_pbl', zmconv_parcel_pbl
+      write(iulog,*) 'tuning parameters zm_conv_options_init: zm_parcel_hscale', zmconv_parcel_hscale
     endif
 
   end subroutine zm_conv_options_init

schemes/zhang_mcfarlane/zm_conv_options.meta

@@ -89,6 +89,12 @@
   type = logical
   dimensions = ()
   intent = in
+[ zmconv_parcel_hscale ]
+  standard_name = fraction_of_pbl_depth_mixed_for_initial_zhang_mcfarlane_parcel_properties
+  units = fraction
+  type = real | kind = kind_phys
+  dimensions = ()
+  intent = in
 [ zmconv_tau ]
   standard_name = deep_convective_adjustment_timescale_for_zhang_mcfarlane_deep_convection_scheme
   units = s

schemes/zhang_mcfarlane/zm_conv_options_namelist.xml

@@ -177,6 +177,22 @@
   </values>
 </entry>
 
+<entry id="zmconv_parcel_hscale">
+  <category>conv</category>
+  <group>zmconv_nl</group>
+  <standard_name>fraction_of_pbl_depth_mixed_for_initial_zhang_mcfarlane_parcel_properties</standard_name>
+  <units>fraction</units>
+  <type>real</type>
+  <kind>kind_phys</kind>
+  <desc>
+     The fraction of the boundary layer (PBL) depth,
+     over which to mix the initial ZM convective parcel properties (fraction).
+  </desc>
+  <values>
+     <value>0.5</value>
+  </values>
+</entry>
+
 <entry id="zmconv_tau">
   <category>conv</category>
   <group>zmconv_nl</group>

schemes/zhang_mcfarlane/zm_convr.F90

@@ -41,7 +41,7 @@ module zm_convr
    integer  limcnv       ! top interface level limit for convection
 
    logical :: lparcel_pbl     ! Switch to turn on mixing of parcel MSE air, and picking launch level to be the top of the PBL.
-
+   real(kind_phys) :: parcel_hscale
 
    real(kind_phys) :: tiedke_add      ! namelist configurable
    real(kind_phys) :: dmpdz_param     ! namelist configurable
@@ -58,7 +58,7 @@ subroutine zm_convr_init(plev, plevp, cpair, epsilo, gravit, latvap, tmelt, rair
                     pref_edge, zmconv_c0_lnd, zmconv_c0_ocn, zmconv_ke, zmconv_ke_lnd, &
                     zmconv_momcu, zmconv_momcd, zmconv_num_cin, &
                     no_deep_pbl_in, zmconv_tiedke_add, &
-                    zmconv_capelmt, zmconv_dmpdz, zmconv_parcel_pbl, zmconv_tau, &
+                    zmconv_capelmt, zmconv_dmpdz, zmconv_parcel_pbl, zmconv_parcel_hscale, zmconv_tau, &
                     masterproc, iulog, errmsg, errflg)
 
    integer, intent(in)   :: plev
@@ -83,7 +83,8 @@ subroutine zm_convr_init(plev, plevp, cpair, epsilo, gravit, latvap, tmelt, rair
    real(kind_phys),intent(in)           :: zmconv_tiedke_add
    real(kind_phys),intent(in)           :: zmconv_capelmt
    real(kind_phys),intent(in)           :: zmconv_dmpdz
-   logical, intent(in)           :: zmconv_parcel_pbl ! Should the parcel properties include PBL mixing?
+   logical, intent(in)                  :: zmconv_parcel_pbl ! Should the parcel properties include PBL mixing?
+   real(kind_phys),intent(in)           :: zmconv_parcel_hscale ! Fraction of PBL over which to mix ZM parcel.
    real(kind_phys),intent(in)           :: zmconv_tau
    logical, intent(in)                  :: masterproc
    integer, intent(in)                  :: iulog
@@ -118,38 +119,30 @@ subroutine zm_convr_init(plev, plevp, cpair, epsilo, gravit, latvap, tmelt, rair
    dmpdz_param = zmconv_dmpdz
    no_deep_pbl = no_deep_pbl_in
    lparcel_pbl = zmconv_parcel_pbl
+   parcel_hscale = zmconv_parcel_hscale
 
    tau = zmconv_tau
 
    !
    ! Limit deep convection to regions below 40 mb
    ! Note this calculation is repeated in the shallow convection interface
    !
-    limcnv = 0   ! null value to check against below
-    if (pref_edge(1) >= 4.e3_kind_phys) then
-       limcnv = 1
-    else
-       do k=1,plev
-          if (pref_edge(k) < 4.e3_kind_phys .and. pref_edge(k+1) >= 4.e3_kind_phys) then
-             limcnv = k
-             exit
-          end if
-       end do
-       if ( limcnv == 0 ) limcnv = plevp
-    end if
-
-    if ( masterproc ) then
-       write(iulog,*)'ZM_CONV_INIT: Deep convection will be capped at intfc ',limcnv, &
-            ' which is ',pref_edge(limcnv),' pascals'
-      write(iulog,*) 'tuning parameters zm_convr_init: tau',tau
-      write(iulog,*) 'tuning parameters zm_convr_init: c0_lnd',c0_lnd, ', c0_ocn', c0_ocn
-      write(iulog,*) 'tuning parameters zm_convr_init: num_cin', num_cin
-      write(iulog,*) 'tuning parameters zm_convr_init: ke',ke
-      write(iulog,*) 'tuning parameters zm_convr_init: no_deep_pbl',no_deep_pbl
-      write(iulog,*) 'tuning parameters zm_convr_init: zm_capelmt', capelmt
-      write(iulog,*) 'tuning parameters zm_convr_init: zm_dmpdz', dmpdz_param
-      write(iulog,*) 'tuning parameters zm_convr_init: zm_tiedke_add', tiedke_add
-      write(iulog,*) 'tuning parameters zm_convr_init: zm_parcel_pbl', lparcel_pbl
+   limcnv = 0   ! null value to check against below
+   if (pref_edge(1) >= 4.e3_kind_phys) then
+      limcnv = 1
+   else
+      do k=1,plev
+         if (pref_edge(k) < 4.e3_kind_phys .and. pref_edge(k+1) >= 4.e3_kind_phys) then
+            limcnv = k
+            exit
+         end if
+      end do
+      if ( limcnv == 0 ) limcnv = plevp
+   end if
+
+   if ( masterproc ) then
+      write(iulog,*)'ZM_CONV_INIT: Deep convection will be capped at intfc ',limcnv, &
+                    ' which is ',pref_edge(limcnv),' pascals'
    endif
 
    if (masterproc) write(iulog,*)'**** ZM: DILUTE Buoyancy Calculation ****'
@@ -934,12 +927,6 @@ subroutine buoyan_dilute(  ncol   ,pver    , &
    real(kind_phys) rd
    real(kind_phys) rl
 
-
-! Scaling of PBL height to give parcel mixing length for lparcel_pbl=True
-
-   real(kind_phys), parameter :: parcel_hscale  = 0.5_kind_phys
-
-
 !
 !-----------------------------------------------------------------------
 !
@@ -1386,13 +1373,6 @@ subroutine parcel_dilute (ncol, pver, cpliq, cpwv, rh2o, latice, msg, klaunch, p
             rcall = 3
             call ientropy (rcall,i,slcl,pl(i),qtlcl,tl(i),qslcl,tfguess,cpliq,cpwv,rh2o,lat(i), long(i), errmsg,errflg)
 
-!            write(iulog,*)' '
-!            write(iulog,*)' p',p(i,k+1),pl(i),p(i,lcl(i))
-!            write(iulog,*)' t',tmix(i,k+1),tl(i),tmix(i,lcl(i))
-!            write(iulog,*)' s',smix(i,k+1),slcl,smix(i,lcl(i))
-!            write(iulog,*)'qt',qtmix(i,k+1),qtlcl,qtmix(i,lcl(i))
-!            write(iulog,*)'qs',qsmix(i,k+1),qslcl,qsmix(i,lcl(i))
-
          endif
 !
       end if !  k < klaunch

schemes/zhang_mcfarlane/zm_convr.meta

@@ -132,6 +132,12 @@
   type = logical
   dimensions = ()
   intent = in
+[ zmconv_parcel_hscale ]
+  standard_name = fraction_of_pbl_depth_mixed_for_initial_zhang_mcfarlane_parcel_properties
+  units = fraction
+  type = real | kind = kind_phys
+  dimensions = ()
+  intent = in
 [ zmconv_tau ]
   standard_name = deep_convective_adjustment_timescale_for_zhang_mcfarlane_deep_convection_scheme
   units = s