Complete Zhang McFarlane conversion to CCPP

doc/ChangeLog

@@ -1,3 +1,59 @@
+
+===============================================================
+
+Tag name:
+Originator(s): cacraig
+Date: Dec 24, 2024
+One-line Summary: Complete Zhang McFarlane conversion to CCPP
+Github PR URL:
+
+This PR fixes the following NCAR/atmospheric_physics Github issues:
+Add ccpp'ized ZM :  https://github.com/ESCOMP/atmospheric_physics/issues/66
+
+Code reviewed by:
+
+List all existing files that have been added (A), modified (M), or deleted (D),
+and describe the changes:
+A       schemes/cloud_fraction/cloud_fraction_fice.F90
+A       schemes/cloud_fraction/cloud_fraction_fice.meta
+A       schemes/sima_diagnostics/zm_convr_tendency_diagnostics.F90
+A       schemes/sima_diagnostics/zm_convr_tendency_diagnostics.meta
+A       schemes/sima_diagnostics/zm_diagnostics.F90
+A       schemes/sima_diagnostics/zm_diagnostics.meta
+A       schemes/sima_diagnostics/zm_evap_tendency_diagnostics.F90
+A       schemes/sima_diagnostics/zm_evap_tendency_diagnostics.meta
+A       schemes/sima_diagnostics/zm_momtran_tendency_diagnostics.F90
+A       schemes/sima_diagnostics/zm_momtran_tendency_diagnostics.meta
+A       schemes/sima_diagnostics/zm_tendency_diagnostics.F90
+A       schemes/sima_diagnostics/zm_tendency_diagnostics.meta
+A       schemes/utilities/to_be_ccppized_temporary.F90
+A       schemes/utilities/to_be_ccppized_temporary.meta
+A       schemes/zhang_mcfarlane/set_deep_conv_fluxes_to_general.F90
+A       schemes/zhang_mcfarlane/set_deep_conv_fluxes_to_general.meta
+A       schemes/zhang_mcfarlane/set_general_conv_fluxes_to_deep.F90
+A       schemes/zhang_mcfarlane/set_general_conv_fluxes_to_deep.meta
+M       schemes/zhang_mcfarlane/zm_conv_convtran.F90
+M       schemes/zhang_mcfarlane/zm_conv_convtran.meta
+M       schemes/zhang_mcfarlane/zm_conv_evap.F90
+M       schemes/zhang_mcfarlane/zm_conv_evap.meta
+M       schemes/zhang_mcfarlane/zm_conv_momtran.F90
+M       schemes/zhang_mcfarlane/zm_conv_momtran.meta
+M       schemes/zhang_mcfarlane/zm_convr.F90
+M       schemes/zhang_mcfarlane/zm_convr.meta
+A       schemes/zhang_mcfarlane/zm_convr_namelist.xml
+A       suites/suite_zhang_mcfarlane.xml
+M       test/test_schemes/initialize_constituents.F90
+A       to_be_ccppized/error_messages.F90
+A       to_be_ccppized/namelist_utils.F90
+A       to_be_ccppized/units.F90
+A       to_be_ccppized/wv_sat_methods.F90
+A       to_be_ccppized/wv_saturation.F90
+
+List and Describe any test failures:
+
+Summarize any changes to answers:
+
+===============================================================
 ===============================================================
 
 Tag name: atmos_phys0_07_000

schemes/cloud_fraction/cloud_fraction_fice.F90

@@ -0,0 +1,89 @@
+module cloud_fraction_fice
+
+  use ccpp_kinds, only:  kind_phys
+  implicit none
+
+contains
+
+!================================================================================================
+
+!===============================================================================
+!> \section arg_table_cloud_fraction_fice_run Argument Table
+!! \htmlinclude cloud_fraction_fice_run.html
+!!
+  subroutine cloud_fraction_fice_run(ncol, t, tmelt, top_lev, pver, fice, fsnow)
+!
+! Compute the fraction of the total cloud water which is in ice phase.
+! The fraction depends on temperature only.
+! This is the form that was used for radiation, the code came from cldefr originally
+!
+! Author: B. A. Boville Sept 10, 2002
+!  modified: PJR 3/13/03 (added fsnow to ascribe snow production for convection )
+!-----------------------------------------------------------------------
+
+! Arguments
+    integer,  intent(in)  :: ncol          ! number of active columns
+    real(kind_phys), intent(in)  :: t(:,:)        ! temperature
+    real(kind_phys), intent(in)  :: tmelt         ! freezing point of water
+    integer, intent(in)  :: top_lev
+    integer, intent(in)  :: pver
+
+    real(kind_phys), intent(out) :: fice(:,:)     ! Fractional ice content within cloud
+    real(kind_phys), intent(out) :: fsnow(:,:)    ! Fractional snow content for convection
+
+! Local variables
+    real(kind_phys) :: tmax_fice                         ! max temperature for cloud ice formation
+    real(kind_phys) :: tmin_fice                         ! min temperature for cloud ice formation
+    real(kind_phys) :: tmax_fsnow                        ! max temperature for transition to convective snow
+    real(kind_phys) :: tmin_fsnow                        ! min temperature for transition to convective snow
+
+    integer :: i,k                                ! loop indexes
+
+!-----------------------------------------------------------------------
+
+    tmax_fice = tmelt - 10._kind_phys        ! max temperature for cloud ice formation
+    tmin_fice = tmax_fice - 30._kind_phys    ! min temperature for cloud ice formation
+    tmax_fsnow = tmelt                ! max temperature for transition to convective snow
+    tmin_fsnow = tmelt - 5._kind_phys        ! min temperature for transition to convective snow
+
+    fice(:,:top_lev-1) = 0._kind_phys
+    fsnow(:,:top_lev-1) = 0._kind_phys
+
+! Define fractional amount of cloud that is ice
+    do k=top_lev,pver
+       do i=1,ncol
+
+! If warmer than tmax then water phase
+          if (t(i,k) > tmax_fice) then
+             fice(i,k) = 0.0_kind_phys
+
+! If colder than tmin then ice phase
+          else if (t(i,k) < tmin_fice) then
+             fice(i,k) = 1.0_kind_phys
+
+! Otherwise mixed phase, with ice fraction decreasing linearly from tmin to tmax
+          else
+             fice(i,k) =(tmax_fice - t(i,k)) / (tmax_fice - tmin_fice)
+          end if
+
+! snow fraction partitioning
+
+! If warmer than tmax then water phase
+          if (t(i,k) > tmax_fsnow) then
+             fsnow(i,k) = 0.0_kind_phys
+
+! If colder than tmin then ice phase
+          else if (t(i,k) < tmin_fsnow) then
+             fsnow(i,k) = 1.0_kind_phys
+
+! Otherwise mixed phase, with ice fraction decreasing linearly from tmin to tmax
+          else
+             fsnow(i,k) =(tmax_fsnow - t(i,k)) / (tmax_fsnow - tmin_fsnow)
+          end if
+
+       end do
+    end do
+
+  end subroutine cloud_fraction_fice_run
+
+end module cloud_fraction_fice

schemes/cloud_fraction/cloud_fraction_fice.meta

@@ -0,0 +1,49 @@
+[ccpp-table-properties]
+  name = cloud_fraction_fice
+  type = scheme
+
+[ccpp-arg-table]
+  name  = cloud_fraction_fice_run
+  type  = scheme
+[ ncol ]
+  standard_name = horizontal_loop_extent
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ t ]
+  standard_name = air_temperature
+  units = K
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  intent = in
+[ tmelt ]
+  standard_name = freezing_point_of_water
+  units = K
+  type = real | kind = kind_phys
+  dimensions = ()
+  intent = in
+[ top_lev ]
+  standard_name = index_of_pressure_at_troposphere_cloud_top
+  units = index
+  type = integer
+  dimensions = ()
+  intent = in
+[ pver ]
+  standard_name = vertical_layer_dimension
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ fice ]
+  standard_name = mass_fraction_of_ice_content_within_stratiform_cloud
+  units = fraction
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  intent = out
+[ fsnow ]
+  standard_name = mass_fraction_of_snow_content_within_stratiform_cloud
+  units = fraction
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  intent = out

schemes/sima_diagnostics/zm_convr_tendency_diagnostics.F90

@@ -0,0 +1,70 @@
+module zm_convr_tendency_diagnostics
+   use ccpp_kinds, only:  kind_phys
+
+   implicit none
+   private
+   save
+
+   public :: zm_convr_tendency_diagnostics_init ! init routine
+   public :: zm_convr_tendency_diagnostics_run  ! main routine
+
+CONTAINS
+
+ !> \section arg_table_zm_convr_tendency_diagnostics_init  Argument Table
+ !! \htmlinclude zm_convr_tendency_diagnostics_init.html
+ subroutine zm_convr_tendency_diagnostics_init(errmsg, errflg)
+    use cam_history,         only: history_add_field
+    use cam_history_support, only: horiz_only
+
+    character(len=512), intent(out) :: errmsg
+    integer,            intent(out) :: errflg
+
+    ! Local variables:
+
+    errmsg = ''
+    errflg = 0
+
+    call history_add_field ('ZMDT', 'T tendency - Zhang-McFarlane moist convection', 'lev', 'avg', 'K s-1')
+    call history_add_field ('ZMDQ', 'Q tendency - Zhang-McFarlane moist convection', 'lev', 'avg', 'kg kg-1 s-1')
+
+   end subroutine zm_convr_tendency_diagnostics_init
+
+   !> \section arg_table_zm_convr_tendency_diagnostics_run  Argument Table
+   !! \htmlinclude zm_convr_tendency_diagnostics_run.html
+   subroutine zm_convr_tendency_diagnostics_run(ncol, pver, cpair, heat, qtnd, errmsg, errflg)
+
+      use cam_history, only: history_out_field
+
+      !------------------------------------------------
+      !   Input / output parameters
+      !------------------------------------------------
+      integer, intent(in) :: ncol
+      integer, intent(in) :: pver
+
+      real(kind_phys), intent(in) :: cpair
+      real(kind_phys), intent(in) :: heat(:,:)
+      real(kind_phys), intent(in) :: qtnd(:,:)
+
+      ! CCPP error handling variables
+      character(len=512), intent(out) :: errmsg
+      integer,          intent(out) :: errflg
+
+
+      real(kind_phys) :: ftem(ncol,pver)
+
+      integer :: index_cldliq
+
+      errmsg = ''
+      errflg = 0
+
+      ftem(:,:) = 0._kind_phys
+
+      ftem(:ncol,:pver) = heat(:ncol,:pver)/cpair
+      call history_out_field('ZMDT    ', ftem)
+      call history_out_field('ZMDQ    ', qtnd)
+
+   end subroutine zm_convr_tendency_diagnostics_run
+
+   !=======================================================================
+
+end module zm_convr_tendency_diagnostics

schemes/sima_diagnostics/zm_convr_tendency_diagnostics.meta

@@ -0,0 +1,70 @@
+[ccpp-table-properties]
+  name = zm_convr_tendency_diagnostics
+  type = scheme
+
+[ccpp-arg-table]
+  name  = zm_convr_tendency_diagnostics_init
+  type  = scheme
+[ errmsg ]
+  standard_name = ccpp_error_message
+  long_name = Error message for error handling in CCPP
+  units = none
+  type = character | kind = len=512
+  dimensions = ()
+  intent = out
+[ errflg ]
+  standard_name = ccpp_error_code
+  long_name = Error flag for error handling in CCPP
+  units = 1
+  type = integer
+  dimensions = ()
+  intent = out
+
+[ccpp-arg-table]
+  name  = zm_convr_tendency_diagnostics_run
+  type  = scheme
+[ ncol ]
+  standard_name = horizontal_loop_extent
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ pver ]
+  standard_name = vertical_layer_dimension
+  units = count
+  type = integer
+  dimensions = ()
+  intent = in
+[ cpair ]
+  standard_name = specific_heat_of_dry_air_at_constant_pressure
+  units = J kg-1 K-1
+  type = real | kind = kind_phys
+  dimensions = ()
+  intent = in
+[ heat ]
+  standard_name = tendency_of_dry_air_enthalpy_at_constant_pressure
+  units = J kg-1 s-1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  intent = in
+[ qtnd ]
+  standard_name = tendency_of_water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water
+  units = kg kg-1 s-1
+  type = real | kind = kind_phys
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  intent = in
+[ errmsg ]
+  standard_name = ccpp_error_message
+  long_name = Error message for error handling in CCPP
+  units = none
+  type = character | kind = len=512
+  dimensions = ()
+  intent = out
+[ errflg ]
+  standard_name = ccpp_error_code
+  long_name = Error flag for error handling in CCPP
+  units = 1
+  type = integer
+  dimensions = ()
+  intent = out
+