Refactor dadadj for CCPP framework

doc/ChangeLog

@@ -1,7 +1,7 @@
 
 ===============================================================
 
-Tag name: atmos_phys0_02_xxx
+Tag name: atmos_phys0_0x_000
 Originator(s): jet
 Date: May 3, 2024
 One-line Summary: dadadj CCPP mods

dadadj/dadadj.F90 → dry_adiabatic_adjust/dadadj.F90

@@ -38,7 +38,8 @@ subroutine dadadj_init(dadadj_nlvdry, dadadj_niter, nz, errmsg, errflg)
 
     if (dadadj_nlvdry >= nz .or. dadadj_nlvdry < 0) then
        errflg = 1
-       write(errmsg,*) 'dadadj_init: dadadj_nlvdry=',dadadj_nlvdry,' but must be less than the number of vertical levels '
+       write(errmsg,*) 'dadadj_init: dadadj_nlvdry=',dadadj_nlvdry,' but must be less than the number of vertical levels ',&
+       '(',nz,'), and must be a positive integer.`
     end if
 
     nlvdry = dadadj_nlvdry
@@ -63,8 +64,8 @@ subroutine dadadj_run( &
     real(kind_phys), intent(in) :: cappa(:,:)  ! variable Kappa
     real(kind_phys), intent(in) :: state_t(:,:)   ! temperature (K)
     real(kind_phys), intent(in) :: state_q(:,:)   ! specific humidity
-    real(kind_phys), intent(out), TARGET :: t_tend(:,:)   ! temperature tendency
-    real(kind_phys), intent(out), TARGET :: q_tend(:,:)   ! specific humidity tendency
+    real(kind_phys), intent(out), target :: t_tend(:,:)   ! temperature tendency
+    real(kind_phys), intent(out), target :: q_tend(:,:)   ! specific humidity tendency
     real(kind_phys), intent(out) :: dadpdf(:,:)  ! PDF of where adjustments happened
 
     character(len=64),  intent(out) :: scheme_name
@@ -102,7 +103,30 @@ subroutine dadadj_run( &
     errflg = 0
     scheme_name = 'DADADJ'
 
-    allocate(c1dad(nlvdry), c2dad(nlvdry), c3dad(nlvdry), c4dad(nlvdry))
+    allocate(c1dad(nlvdry), stat=ierr)
+    if (ierr /= 0) then
+       errcode = ierr
+       errmsg = trim(scheme_name)//': Allocate of c1dad(nlvdry) failed'
+       return
+    end if
+    allocate(c2dad(nlvdry), stat=ierr)
+    if (ierr /= 0) then
+       errcode = ierr
+       errmsg = trim(scheme_name)//': Allocate of c2dad(nlvdry) failed'
+       return
+    end if
+    allocate(c3dad(nlvdry), stat=ierr)
+    if (ierr /= 0) then
+       errcode = ierr
+       errmsg = trim(scheme_name)//': Allocate of c3dad(nlvdry) failed'
+       return
+    end if
+    allocate(c4dad(nlvdry), stat=ierr)
+    if (ierr /= 0) then
+       errcode = ierr
+       errmsg = trim(scheme_name)//': Allocate of c4dad(nlvdry) failed'
+       return
+    end if
 
     ! t_tend< and tend_dtdq used as workspace until needed to calculate tendencies
     t => t_tend
@@ -117,7 +141,7 @@ subroutine dadadj_run( &
        cappaint = 0.5_kind_phys*(cappa(i,2) + cappa(i,1))
        gammad = cappaint*0.5_kind_phys*(t(i,2) + t(i,1))/pint(i,2)
        dtdp = (t(i,2) - t(i,1))/(pmid(i,2) - pmid(i,1))
-       dodad(i) = (dtdp + zeps) .gt. gammad
+       dodad(i) = (dtdp + zeps) > gammad
     end do
 
     dadpdf(:ncol,:) = 0._kind_phys
@@ -126,8 +150,8 @@ subroutine dadadj_run( &
          cappaint = 0.5_kind_phys*(cappa(i,k+1) + cappa(i,k))
          gammad = cappaint*0.5_kind_phys*(t(i,k+1) + t(i,k))/pint(i,k+1)
          dtdp = (t(i,k+1) - t(i,k))/(pmid(i,k+1) - pmid(i,k))
-         dodad(i) = dodad(i) .or. (dtdp + zeps).gt.gammad
-         if ((dtdp + zeps).gt.gammad) then
+         dodad(i) = dodad(i) .or. (dtdp + zeps) > gammad
+         if ((dtdp + zeps) > gammad) then
             dadpdf(i,k) = 1._kind_phys
          end if
       end do
@@ -152,26 +176,25 @@ subroutine dadadj_run( &
          end do
 
          ilconv = .false.
-         
+
          DBLZEP: do while (.not. ilconv)
-            
+
             do jiter = 1, niter
                ilconv = .true.
 
                do k = 1, nlvdry
                   zepsdp = zeps*(pmid(i,k+1) - pmid(i,k))
                   zgamma = c1dad(k)*(t(i,k) + t(i,k+1))
-                  
+
                   if ((t(i,k+1)-t(i,k)) >= (zgamma+zepsdp)) then
-                     write(6,*)'adjusting t and q at i,k=',i,k
                      ilconv = .false.
                      t(i,k+1) = t(i,k)*c3dad(k) + t(i,k+1)*c4dad(k)
                      t(i,k) = c2dad(k)*t(i,k+1)
                      qave = (pdel(i,k+1)*q(i,k+1) + pdel(i,k)*q(i,k))/(pdel(i,k+1)+ pdel(i,k))
                      q(i,k+1) = qave
                      q(i,k) = qave
                   end if
-                  
+
                end do
 
                if (ilconv) cycle COL ! convergence => next longitude
@@ -181,6 +204,7 @@ subroutine dadadj_run( &
             zeps = zeps + zeps
             if (zeps > 1.e-4_kind_phys) then
                errflg = i
+               errmsg = trim(scheme_name)//': Convergence failure, zeps > 1.e-4'
                return                ! error return
             end if
          end do DBLZEP

dadadj/dadadj.meta → dry_adiabatic_adjust/dadadj.meta

@@ -32,9 +32,9 @@
   dimensions = ()
   intent = out
 [ errflg ]
-  standard_name = ccpp_error_flag
-  long_name = Error flag for error handling in CCPP
-  units = flag
+  standard_name = ccpp_error_code
+  long_name = Error code for error handling in CCPP
+  units = 1
   type = integer
   dimensions = ()
   intent = out
@@ -78,10 +78,10 @@
   standard_name = air_temperature
   type = real | kind = kind_phys
   units = K
-  dimensions = (horizontal_dimension, vertical_layer_dimension)
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
   intent = in
 [ state_q ]
-  standard_name = water_vapor_mixing_ratio_wrt_dry_air
+  standard_name = water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water
   long_name = mass mixing ratio of water vapor / dry air
   advected = True
   units = kg kg-1
@@ -97,20 +97,20 @@
 [ t_tend ]
   standard_name = tendency_of_air_temperature
   units = K s-1
-  dimensions = (horizontal_dimension, vertical_layer_dimension)
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
   type = real | kind = kind_phys
   intent = out
 [ q_tend ]
   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_dimension, vertical_layer_dimension)
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
   intent = out
 [ dadpdf ]
-  standard_name = indicator_for_dry_adiabatic_adjusted_grid_cell
-  units = 1
+  standard_name = binary_indicator_for_dry_adiabatic_adjusted_grid_cell
+  units = fraction
   type = real | kind = kind_phys
-  dimensions = (horizontal_dimension, vertical_layer_dimension)
+  dimensions = (horizontal_loop_extent, vertical_layer_dimension)
   intent = out
 [ scheme_name ]
   standard_name = scheme_name
@@ -126,9 +126,9 @@
   dimensions = ()
   intent = out
 [ errflg ]
-  standard_name = ccpp_error_flag
-  long_name = Error flag for error handling in CCPP
-  units = flag
+  standard_name = ccpp_error_code
+  long_name = Error code for error handling in CCPP
+  units = 1
   type = integer
   dimensions = ()
   intent = out

dadadj/dadadj_namelist.xml → dry_adiabatic_adjust/dadadj_namelist.xml

@@ -84,7 +84,7 @@
   <standard_name>number_of_vertical_levels_from_model_top_where_dry_adiabatic_adjustment_occurs</standard_name>
   <units>count</units>
   <desc>
-    Number of layers from the top of the model over which to do dry convective adjustment.
+    Number of layers from the top of the model over which to do dry adiabatic adjustment.
     Must be less than plev (the number of vertical levels).
   </desc>
   <values>
@@ -99,7 +99,7 @@
   <units>count</units>
   <desc>
     The maximum number of iterations to achieve convergence in dry adiabatic adjustment.
-    For WACCM-X it can be advantageous to use a number which is much higher than the CAM
+    For WACCM-X it can be advantageous to use a number which is much higher than the default CAM value.
   </desc>
   <values>
     <value>15</value>

suite_cam7.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<suite name="dadadj" version="1.0">
+  <group name="physics_before_coupler">
+    <scheme>dadadj</scheme>
+    <scheme>apply_tendency_of_air_temperature</scheme>
+    <scheme>qneg</scheme>
+    <scheme>geopotential_temp</scheme>
+  </group>
+</suite>

test/test_sdfs/suite_dadadj.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<suite name="dadadj" version="1.0">
+  <group name="physics_before_coupler">
+    <scheme>dadadj</scheme>
+    <scheme>apply_tendency_of_air_temperature</scheme>
+    <scheme>qneg</scheme>
+    <scheme>geopotential_temp</scheme>
+  </group>
+</suite>