Merge pull request #1361 from jimmielin/hplin/hb_diff

cam6_4_120: Complete CCPPization of HB PBL scheme and vertical diffusion solver (non-WACCM)

Author: jimmielin

.gitmodules

@@ -29,7 +29,7 @@
 [submodule "atmos_phys"]
 	path = src/atmos_phys
 	url = https://github.com/ESCOMP/atmospheric_physics
-	fxtag = atmos_phys0_17_003
+	fxtag = atmos_phys0_18_000
         fxrequired = AlwaysRequired
 	fxDONOTUSEurl = https://github.com/ESCOMP/atmospheric_physics
 

bld/build-namelist

@@ -5281,6 +5281,7 @@ sub check_snapshot_settings {
             push (@validList_ac, ("'chem_timestep_tend'"));
         }
         push (@validList_ac, ("'vertical_diffusion_section'",
+                              "'orographic_form_drag_stress'",
                               "'aero_model_drydep'", "'gw_tend'",
                               "'qbo_relax'", "'iondrag_calc_section'",
                               "'physics_dme_adjust'"));
@@ -5296,6 +5297,7 @@ sub check_snapshot_settings {
             push (@validList_ac, ("'chem_timestep_tend'"));
         }
         push (@validList_ac, ("'vertical_diffusion_section'",
+                              "'orographic_form_drag_stress'",
                               "'aero_model_drydep'", "'gw_tend'",
                               "'qbo_relax'", "'iondrag_calc_section'",
                               "'physics_dme_adjust'"));

bld/configure

@@ -2186,8 +2186,9 @@ sub write_filepath
     print $fh "$camsrcdir/src/atmos_phys/schemes/rasch_kristjansson\n";
     print $fh "$camsrcdir/src/atmos_phys/schemes/utilities\n";
     print $fh "$camsrcdir/src/atmos_phys/schemes/rayleigh_friction\n";
-
     print $fh "$camsrcdir/src/atmos_phys/schemes/cloud_fraction\n";
+    print $fh "$camsrcdir/src/atmos_phys/schemes/vertical_diffusion\n";
+    print $fh "$camsrcdir/src/atmos_phys/schemes/holtslag_boville\n";
 
     # Dynamics package and test utilities
     print $fh "$camsrcdir/src/dynamics/$dyn\n";

bld/namelist_files/namelist_definition.xml

@@ -5672,15 +5672,15 @@ Default:
 </entry>
 
 <entry id="cam_take_snapshot_before" type="char*32"  category="diagnostics"
-       group="phys_ctl_nl" valid_values="chem_emissions,aoa_tracers_timestep_tend,co2_cycle_set_ptend,chem_timestep_tend,vertical_diffusion_section,aero_model_drydep,gw_tend,qbo_relax,iondrag_calc_section,physics_dme_adjust,physics_dme_adjust,dadadj_tend,convect_deep_tend,convect_shallow_tend,convect_diagnostics_calc,macrop_driver_tend,clubb_tend_cam,microp_section,microp_driver_tend_subcol,aero_model_wetdep,radiation_tend,held_suarez_tend,kessler_tend,thatcher_jablonowski_precip_tend,rk_stratiform_tend,rayleigh_friction_tend,user_set" >
+       group="phys_ctl_nl" valid_values="chem_emissions,aoa_tracers_timestep_tend,co2_cycle_set_ptend,chem_timestep_tend,orographic_form_drag_stress,vertical_diffusion_section,aero_model_drydep,gw_tend,qbo_relax,iondrag_calc_section,physics_dme_adjust,physics_dme_adjust,dadadj_tend,convect_deep_tend,convect_shallow_tend,convect_diagnostics_calc,macrop_driver_tend,clubb_tend_cam,microp_section,microp_driver_tend_subcol,aero_model_wetdep,radiation_tend,held_suarez_tend,kessler_tend,thatcher_jablonowski_precip_tend,rk_stratiform_tend,rayleigh_friction_tend,user_set" >
 Name of parameterization to take snapshot before running
 user_set is used when a user inserts a call to cam_snapshot_all_outfld
   using cam_snapshot_before_num as the first argument.
 Default: Unused
 </entry>
 
 <entry id="cam_take_snapshot_after" type="char*32"  category="diagnostics"
-       group="phys_ctl_nl" valid_values="chem_emissions,aoa_tracers_timestep_tend,co2_cycle_set_ptend,chem_timestep_tend,vertical_diffusion_section,aero_model_drydep,gw_tend,qbo_relax,iondrag_calc_section,physics_dme_adjust,physics_dme_adjust,dadadj_tend,convect_deep_tend,convect_shallow_tend,convect_diagnostics_calc,macrop_driver_tend,clubb_tend_cam,microp_section,microp_driver_tend_subcol,aero_model_wetdep,radiation_tend,held_suarez_tend,kessler_tend,thatcher_jablonowski_precip_tend,rk_stratiform_tend,rayleigh_friction_tend,user_set" >
+       group="phys_ctl_nl" valid_values="chem_emissions,aoa_tracers_timestep_tend,co2_cycle_set_ptend,chem_timestep_tend,orographic_form_drag_stress,vertical_diffusion_section,aero_model_drydep,gw_tend,qbo_relax,iondrag_calc_section,physics_dme_adjust,physics_dme_adjust,dadadj_tend,convect_deep_tend,convect_shallow_tend,convect_diagnostics_calc,macrop_driver_tend,clubb_tend_cam,microp_section,microp_driver_tend_subcol,aero_model_wetdep,radiation_tend,held_suarez_tend,kessler_tend,thatcher_jablonowski_precip_tend,rk_stratiform_tend,rayleigh_friction_tend,user_set" >
 Name of parameterization to take snapshot after running
 user_set is used when a user inserts a call to cam_snapshot_all_outfld
   using cam_snapshot_after_num as the first argument.

doc/ChangeLog

@@ -1,5 +1,101 @@
 ===============================================================
 
+Tag name: cam6_4_120
+Originator(s): jimmielin
+Date: September 26, 2025
+One-line Summary: Complete CCPPization of HB PBL scheme and vertical diffusion solver (non-WACCM)
+Github PR URL: https://github.com/ESCOMP/CAM/pull/1361
+
+Purpose of changes (include the issue number and title text for each relevant GitHub issue):
+- Completes #1300 by CCPPizing compute_hb_diff, compute_hb_free_atm_diff, pblintd, trbintd
+- Cleanup, refactoring, and optimization of HB
+- Partially completes #1205; and completes #1314 by CCPPizing partial interstitial logic of vertical_diffusion_tend
+- Partially completes #1205; and completes #1314 by CCPPizing compute_vdiff in diffusion_solver.F90
+- Correctly update 'AST' field in physics buffer in RK stratiform CAM interface for snapshot consistency (bit-for-bit).
+- Adds snapshot points for orographic form drag stress (Beljaars in CAM6+ and TMS in CAM5) for future CCPPization work.
+
+Describe any changes made to build system:
+- add holtslag_boville CCPP scheme
+- add vertical_diffusion CCPP scheme
+
+Describe any changes made to the namelist: N/A
+
+List any changes to the defaults for the boundary datasets: N/A
+
+Describe any substantial timing or memory changes: N/A
+
+Code reviewed by: nusbaume
+
+List all files eliminated:
+```
+D       src/physics/cam/hb_diff.F90
+  - moved to atmos_phys as CCPPized holstlag_boville scheme
+D       src/physics/cam/vdiff_lu_solver.F90
+  - moved to atmos_phys into to_be_ccppized (unchanged)
+```
+
+List all files added and what they do: N/A
+
+List all existing files that have been modified, and describe the changes:
+R053    src/physics/cam/diffusion_solver.F90    src/physics/cam/diffusion_solver_cam.F90
+  - this is the "remnant" diffusion solver supporting WACCM with molecular diffusion.
+  - partial refactor to avoid excessive code divergence with CCPPized diffusion_solver.
+  - renamed to avoid name conflict with CCPPized diffusion_solver.
+
+M       bld/configure
+  - add holtslag_boville and diffusion_solver folders in atmos_phys/schemes to build.
+
+M       src/physics/cam/vertical_diffusion.F90
+  - use CCPPized subroutines for HB and vertical diffusion solver.
+
+M       src/physics/cam/eddy_diff_cam.F90
+  - use CCPPized vertical diffusion solver.
+
+M       src/physics/cam/molec_diff.F90
+  - dechunkize and use assumed dimensions for vd_lu_qdecomp.
+
+M       src/physics/cam/clubb_intr.F90
+  - use CCPPized HB boundary layer computation.
+
+M       src/physics/cam/ref_pres.F90
+M       src/utils/air_composition.F90
+  - comment updates for clarification of units/purpose.
+
+M       src/physics/cam/rk_stratiform_cam.F90
+  - Correctly update AST pbuf field in RK stratiform CAM interface for snapshot consistency (bit-for-bit).
+
+M       src/physics/cam7/physpkg.F90
+M       src/physics/cam/physpkg.F90
+M       bld/build-namelist
+M       bld/namelist_files/namelist_definition.xml
+  - move Beljaars, TMS drag call routines to physpkg level for snapshotting.
+  - add orographic_form_drag_stress snapshot point.
+
+M       src/control/cam_snapshot_common.F90
+  - expand size of cam_in snapshot output maximum because it needs to fit all constituents.
+
+If there were any failures reported from running test_driver.sh on any test
+platform, and checkin with these failures has been OK'd by the gatekeeper,
+then copy the lines from the td.*.status files for the failed tests to the
+appropriate machine below.  All failed tests must be justified.
+
+derecho/intel/aux_cam: ALL PASS
+
+  SMS_D_Ln9_P1280x1.ne0CONUSne30x8_ne0CONUSne30x8_mt12.FCHIST.derecho_intel.cam-outfrq9s (Overall: PASS) details:
+    - This test continues to fail most of the time on lnd_set_decomp_and_domain.F90 line 497
+      despite the updated externals.
+      It can be re-run to eventually work (as it was done here).
+
+derecho/nvhpc/aux_cam:
+  ERS_Ln9.ne30pg3_ne30pg3_mt232.FHISTC_LTso.derecho_nvhpc.cam-outfrq9s_gpu_default (Overall: FAIL) details:
+    - pre-existing failure - See issue: https://github.com/ESCOMP/CAM/issues/1383
+
+izumi/nag/aux_cam: ALL PASS
+
+izumi/gnu/aux_cam: ALL PASS
+
+===============================================================
+
 Tag name: cam6_4_119
 Originator: peverwhee
 Date: 26 September, 2025

src/atmos_phys

@@ -84,7 +84,7 @@ module cam_snapshot_common
 type (snapshot_type)    ::  state_snapshot(30)
 type (snapshot_type)    ::  cnst_snapshot(pcnst)
 type (snapshot_type)    ::  tend_snapshot(6)
-type (snapshot_type)    ::  cam_in_snapshot(30)
+type (snapshot_type)    ::  cam_in_snapshot(pcnst+31)   ! needs to be bigger than pcnst because cam_in is split by constituent.
 type (snapshot_type)    ::  cam_out_snapshot(30)
 type (snapshot_type_nd) ::  pbuf_snapshot(300)
 
@@ -1218,6 +1218,9 @@ subroutine cam_pbuf_snapshot_all_outfld(lchnk, file_num, pbuf)
    real(r8), pointer, dimension(:,:,:,:)       :: tmpptr4d
    real(r8), pointer, dimension(:,:,:,:,:)     :: tmpptr5d
 
+   ! Special handling of integer type fields (output as real)
+   integer,  pointer, dimension(:,:)           :: tmpptr2d_int
+
 
    do i=1, npbuf_var
 
@@ -1227,28 +1230,40 @@ subroutine cam_pbuf_snapshot_all_outfld(lchnk, file_num, pbuf)
          ! Turn on the writing for only the requested tape (file_num)
          call cam_history_snapshot_activate(trim(pbuf_snapshot(i)%standard_name), file_num)
 
-         ! Retrieve the pbuf data (dependent on the number of dimensions)
-         ndims = count(pbuf_snapshot(i)%dim_name(:) /= '')
+         ! Retrieve the pbuf data. Special handling for certain
+         ! integer-type fields.
+         if( trim(pbuf_snapshot(i)%ddt_string) == 'clubbtop') then
+            call pbuf_get_field(pbuf, pbuf_idx, tmpptr2d_int)
+            ! copy into real
+            allocate(tmpptr2d(size(tmpptr2d_int, 1), size(tmpptr2d_int, 2)))
+            tmpptr2d = real(tmpptr2d_int, r8)
+            call outfld(pbuf_snapshot(i)%standard_name, tmpptr2d, pcols, lchnk)
+            deallocate(tmpptr2d)
+         else
+           ! For regular real-type data:
+           ! Retrieve the pbuf data (dependent on the number of dimensions)
+           ndims = count(pbuf_snapshot(i)%dim_name(:) /= '')
 
-         select case (ndims)  ! Note that dimension 5 and 6 do not work with pbuf_get_field, so these are not used here
+           select case (ndims)  ! Note that dimension 5 and 6 do not work with pbuf_get_field, so these are not used here
 
-         case (1)
-            call pbuf_get_field(pbuf, pbuf_idx, tmpptr2d)
-            call outfld(pbuf_snapshot(i)%standard_name, tmpptr2d, pcols, lchnk)
+           case (1)
+              call pbuf_get_field(pbuf, pbuf_idx, tmpptr2d)
+              call outfld(pbuf_snapshot(i)%standard_name, tmpptr2d, pcols, lchnk)
 
-         case (2)
-            call pbuf_get_field(pbuf, pbuf_idx, tmpptr3d)
-            call outfld(pbuf_snapshot(i)%standard_name, tmpptr3d, pcols, lchnk)
+           case (2)
+              call pbuf_get_field(pbuf, pbuf_idx, tmpptr3d)
+              call outfld(pbuf_snapshot(i)%standard_name, tmpptr3d, pcols, lchnk)
 
-         case (3)
-            call pbuf_get_field(pbuf, pbuf_idx, tmpptr3d)
-            call outfld(pbuf_snapshot(i)%standard_name, tmpptr4d, pcols, lchnk)
+           case (3)
+              call pbuf_get_field(pbuf, pbuf_idx, tmpptr3d)
+              call outfld(pbuf_snapshot(i)%standard_name, tmpptr4d, pcols, lchnk)
 
-         case (4)
-            call pbuf_get_field(pbuf, pbuf_idx, tmpptr5d)
-            call outfld(pbuf_snapshot(i)%standard_name, tmpptr5d, pcols, lchnk)
+           case (4)
+              call pbuf_get_field(pbuf, pbuf_idx, tmpptr5d)
+              call outfld(pbuf_snapshot(i)%standard_name, tmpptr5d, pcols, lchnk)
 
-         end select
+           end select
+         endif
 
          ! Now that the field has been written, turn off the writing for field
          call cam_history_snapshot_deactivate(trim(pbuf_snapshot(i)%standard_name))

src/control/cam_snapshot_common.F90

@@ -2105,7 +2105,7 @@ subroutine clubb_tend_cam( state,   ptend_all,   pbuf,     hdtime, &
     use perf_mod,       only: t_startf, t_stopf
 
 #ifdef CLUBB_SGS
-    use hb_diff,                   only: pblintd
+    use holtslag_boville_diff, only: hb_pbl_dependent_coefficients_run
     use clubb_api_module, only: &
       nparams, &
       setup_parameters_api, &
@@ -2599,6 +2599,10 @@ subroutine clubb_tend_cam( state,   ptend_all,   pbuf,     hdtime, &
       edsclr, &
       n
 
+    ! dummy outputs for CCPP-ized subroutines
+    character(len=512)   :: errmsg
+    integer              :: errflg
+
 #endif
 
   call t_startf('clubb_tend_cam')
@@ -4699,16 +4703,37 @@ subroutine clubb_tend_cam( state,   ptend_all,   pbuf,     hdtime, &
     kbfs   (1:ncol) = calc_kinematic_buoyancy_flux(kinheat(1:ncol), zvir, th(1:ncol,pver), kinwat(1:ncol))
     obklen (1:ncol) = calc_obukhov_length(thv(1:ncol,pver), ustar2(1:ncol), gravit, karman, kbfs(1:ncol))
 
-    dummy2(:) = 0._r8
-    dummy3(:) = 0._r8
 
     where (kbfs(:ncol)  ==  -0.0_r8) kbfs(:ncol) = 0.0_r8
 
-    !  Compute PBL depth according to Holtslag-Boville Scheme
-    call pblintd(ncol, thv, state1%zm, state1%u, state1%v, &
-                ustar2, obklen, kbfs, pblh, dummy2, &
-                state1%zi, cloud_frac(:,1:pver), 1._r8-cam_in%landfrac, dummy3)
-
+    ! Compute PBL depth according to Holtslag-Boville Scheme -- only pblh is needed here
+    ! and other outputs are discarded
+    !REMOVECAM - no longer need this when CAM is retired and pcols no longer exists
+    pblh(:) = 0._r8
+    dummy2(:) = 0._r8
+    dummy3(:) = 0._r8
+    !REMOVECAM_END
+    call hb_pbl_dependent_coefficients_run( &
+      ncol      = ncol,                                      &
+      pver      = pver,                                      &
+      pverp     = pverp,                                     &
+      gravit    = gravit,                                    &
+      z         = state1%zm(:ncol,:pver),                    &
+      zi        = state1%zi(:ncol,:pverp),                   &
+      u         = state1%u(:ncol,:pver),                     &
+      v         = state1%v(:ncol,:pver),                     &
+      cldn      = cloud_frac(:ncol,:pver),                   &
+      ! Inputs from CLUBB (not HB coefficients)
+      thv       = thv(:ncol,:pver),                          &
+      ustar     = ustar2(:ncol),                             &
+      kbfs      = kbfs(:ncol),                               &
+      obklen    = obklen(:ncol),                             &
+      ! Output variables
+      pblh      = pblh(:ncol),                               &
+      wstar     = dummy2(:ncol),                             &
+      bge       = dummy3(:ncol),                             &
+      errmsg    = errmsg,                                    &
+      errflg    = errflg)
 
     ! Assign the first pver levels of cloud_frac back to cld
     cld(:,1:pver) = cloud_frac(:,1:pver)