Incorporate final RRTMGP mods to complete CPU-ized ccppization

.gitmodules

@@ -28,8 +28,8 @@
 
 [submodule "atmos_phys"]
 	path = src/atmos_phys
-	url = https://github.com/ESCOMP/atmospheric_physics
-	fxtag = atmos_phys0_18_002
+	url = https://github.com/peverwhee/atmospheric_physics
+	fxtag = b0cf14d631c641c69280f7b7ad81f61cc921af50
         fxrequired = AlwaysRequired
 	fxDONOTUSEurl = https://github.com/ESCOMP/atmospheric_physics
 

src/control/cam_snapshot_common.F90

@@ -625,6 +625,9 @@ subroutine cam_out_snapshot_init(cam_snapshot_before_num, cam_snapshot_after_num
    call snapshot_addfld( ncam_out_var, cam_out_snapshot,  cam_snapshot_before_num, cam_snapshot_after_num, &
      'cam_out%solld',               'cam_out_solld',           'W m-2',          horiz_only)
 
+   call snapshot_addfld( ncam_out_var, cam_out_snapshot,  cam_snapshot_before_num, cam_snapshot_after_num, &
+     'cam_out%flwds',               'cam_out_flwds',           'W m-2',          horiz_only)
+
    call snapshot_addfld( ncam_out_var, cam_out_snapshot,  cam_snapshot_before_num, cam_snapshot_after_num, &
      'cam_out%netsw',               'cam_out_netsw',           'unset',          horiz_only)
 

src/physics/rrtmgp/radiation.F90

@@ -220,6 +220,8 @@ module radiation
 
 integer :: nlwgpts
 integer :: nswgpts
+integer :: changeseed
+integer :: irad_always_modified
 
 real(kind=r8) :: tiny
 
@@ -413,7 +415,7 @@ subroutine radiation_init(pbuf2d)
    use rrtmgp_inputs_setup,       only: rrtmgp_inputs_setup_init
    use rrtmgp_inputs_cam,         only: rrtmgp_inputs_cam_init
    use rrtmgp_cloud_optics_setup, only: rrtmgp_cloud_optics_setup_init
-   use rrtmgp_sw_solar_var,       only: rrtmgp_sw_solar_var_init
+   use rrtmgp_sw_solar_var_setup, only: rrtmgp_sw_solar_var_setup_init
    use solar_irrad_data,          only: do_spctrl_scaling, has_spectrum
    use cloud_rad_props,           only: cloud_rad_props_init
    use rad_constituents,          only: iceopticsfile, liqopticsfile
@@ -445,14 +447,16 @@ subroutine radiation_init(pbuf2d)
                                           ! liquid budgets.
    integer :: history_budget_histfile_num ! history file number for budget fields
    integer :: ierr, istat, errflg
+   character(len=5) :: gaslist_tmp(8)
 
    integer :: dtime
+   real(r8) :: dtime_r8
 
    character(len=*), parameter :: sub = 'radiation_init'
    !-----------------------------------------------------------------------
 
    ! Initialize available_gases object
-   call rrtmgp_pre_init(nradgas, gaslist, available_gases, gaslist_lc, errmsg, errflg)
+   call rrtmgp_pre_init(nradgas, available_gases, gaslist_tmp, gaslist_lc, errmsg, errflg)
    if (errflg /= 0) then
       call endrun(sub//': '//errmsg)
    end if
@@ -467,13 +471,16 @@ subroutine radiation_init(pbuf2d)
       call endrun(sub//': sw '//errmsg)
    end if
 
+   dtime = get_step_size()
+   dtime_r8 = real(dtime, r8)
+
    ! Set up inputs to RRTMGP
    call rrtmgp_inputs_setup_init(ktopcam, ktoprad, nlaycam, sw_low_bounds, sw_high_bounds, nswbands,               &
                    pref_edge, nlay, pver, pverp, kdist_sw, kdist_lw, qrl_unused, is_first_step(), use_rad_dt_cosz, &
-                   get_step_size(), get_nstep(), iradsw, dt_avg, irad_always, is_first_restart_step(),             &
+                   dtime_r8, get_nstep(), iradsw, dt_avg, irad_always, is_first_restart_step(),                    &
                    p_top_for_equil_rad, nlwbands, nradgas, gasnamelength, idx_sw_diag, idx_nir_diag, idx_uv_diag,  &
-                   idx_sw_cloudsim, idx_lw_diag, idx_lw_cloudsim, nswgpts, nlwgpts, nlayp, nextsw_cday,            &
-                   get_curr_calday(), band2gpt_sw, errmsg, errflg)
+                   idx_sw_cloudsim, idx_lw_diag, idx_lw_cloudsim, nswgpts, nlwgpts, changeseed, nlayp, nextsw_cday, &
+                   get_curr_calday(), band2gpt_sw, irad_always_modified, errmsg, errflg)
    if (errflg /= 0) then
       call endrun(sub//': '//errmsg)
    end if
@@ -485,7 +492,7 @@ subroutine radiation_init(pbuf2d)
    ! Set radconstants module-level index variables that we're setting in CCPP-ized scheme now
    call radconstants_init(idx_sw_diag, idx_nir_diag, idx_uv_diag, idx_lw_diag)
 
-   call rrtmgp_sw_solar_var_init(nswbands, do_spctrl_scaling, has_spectrum, errmsg, errflg)
+   call rrtmgp_sw_solar_var_setup_init(nswbands, do_spctrl_scaling, has_spectrum, errmsg, errflg)
    if (errflg /= 0) then
       call endrun(sub//': '//errmsg)
    end if
@@ -890,6 +897,7 @@ subroutine radiation_tend( &
    real(r8)          :: cld_lw_abs(nlwbands,state%ncol,pver)  ! Cloud absorption optics depth
    real(r8)          :: snow_lw_abs(nlwbands,state%ncol,pver) ! Snow absorption optics depth
    real(r8)          :: grau_lw_abs(nlwbands,state%ncol,pver) ! Graupel absorption optics depth
+   real(r8)          :: c_cld_lw_abs(nlwbands,state%ncol,pver)
    real(r8)          :: cld_tau(nswbands,state%ncol,pver)  ! Cloud absorption optical depth (sw)
    real(r8)          :: snow_tau(nswbands,state%ncol,pver) ! Snow absorption optical depth (sw)
    real(r8)          :: grau_tau(nswbands,state%ncol,pver) ! Graupel absorption optical depth (sw)
@@ -1005,8 +1013,11 @@ subroutine radiation_tend( &
    real(r8) :: gb_snow_lw(pcols,pver)  ! grid-box mean LW snow optical depth
 
    logical :: is_mpas ! Flag for whether the dycore is MPAS
+   logical :: dosw_heat, dolw_heat
    real(r8) :: ftem(pcols,pver)        ! Temporary workspace for outfld variables
    real(r8), target :: zero_variable(1,1)
+   integer  :: dtime
+   real(r8) :: dtime_r8
 
    character(len=512) :: errmsg
    integer            :: errflg, err
@@ -1048,8 +1059,12 @@ subroutine radiation_tend( &
       end do
    end if
 
+   dtime = get_step_size()
+   dtime_r8 = real(dtime, r8)
+
    ! Get next SW radiation timestep
-   call rrtmgp_pre_timestep_init(get_nstep(), get_step_size(), iradsw, irad_always, offset, errmsg, errflg)
+   call rrtmgp_pre_timestep_init(ncol, coszrs, get_nstep(), dtime_r8, iradsw, &
+           irad_always_modified, offset, idxday, nday, idxnite, nnite, errmsg, errflg)
    if (errflg /= 0) then
       call endrun(sub//': '//errmsg)
    end if
@@ -1060,9 +1075,10 @@ subroutine radiation_tend( &
 
    ! Determine if we're running radiation (sw and/or lw) this timestep,
    !  find daylight and nighttime indices, and initialize fluxes
-   call rrtmgp_pre_run(coszrs(:ncol), get_nstep(), get_step_size(), iradsw, iradlw, irad_always, &
-           ncol, next_cday, idxday, nday, idxnite, nnite, dosw, dolw, nlay, nlwbands,   &
-           nswbands, spectralflux, nextsw_cday, fsw, fswc, flw, flwc, errmsg, errflg)
+   call rrtmgp_pre_run(coszrs(:ncol), get_nstep(), dtime_r8, iradsw, iradlw, irad_always_modified, &
+           ncol, next_cday, idxday, nday, idxnite, nnite, dosw, dolw, dosw_heat, dolw_heat, &
+           nlay, nlwbands, nswbands, spectralflux, nextsw_cday, fsw, fswc, flw, flwc, &
+           errmsg, errflg)
    if (errflg /= 0) then
       call endrun(sub//': '//errmsg)
    end if
@@ -1178,7 +1194,7 @@ subroutine radiation_tend( &
       ! Prepare state variables, daylit columns, albedos for RRTMGP
       ! Also calculate modified cloud fraction
       call rrtmgp_inputs_run(dosw, dolw, associated(cldfsnow), associated(cldfgrau), &
-                  masterproc, iulog, is_mpas, state%pmid(:ncol,:), state%pint(:ncol,:), state%t(:ncol,:), &
+                  (.not. is_mpas), state%pmid(:ncol,:), state%pint(:ncol,:), state%t(:ncol,:), &
                   nday, idxday, cldfprime(:ncol,:), coszrs(:ncol), kdist_sw, t_sfc,       &
                   emis_sfc, t_rad, pmid_rad, pint_rad, t_day, pmid_day,   &
                   pint_day, coszrs_day, alb_dir, alb_dif, cam_in%lwup(:ncol), stebol,  &
@@ -1203,7 +1219,7 @@ subroutine radiation_tend( &
       if (dosw) then
 
          ! Set cloud optical properties in cloud_sw object.
-         call rrtmgp_sw_cloud_optics_run(dosw, ncol, pver, ktopcam, ktoprad, nlay, nswgpts, nday, idxday,   &
+         call rrtmgp_sw_cloud_optics_run(dosw, ncol, pver, ktopcam, ktoprad, nswgpts, nday, idxday,         &
              fillvalue, nswbands, iulog, mu(:ncol,:), lambda(:ncol,:), nnite, idxnite, cld, cldfsnow_in,    &
              cldfgrau_in, cldfprime(:ncol,:), cld_tau(:,:ncol,:), grau_tau(:,:ncol,:), snow_tau(:,:ncol,:), &
              degrau(:ncol,:), dei(:ncol,:), des(:ncol,:), iclwp(:ncol,:), iciwp(:ncol,:), icswp(:ncol,:),   &
@@ -1260,8 +1276,8 @@ subroutine radiation_tend( &
                   !$acc end data
 
                   ! Scale the solar source
-                  call rrtmgp_sw_solar_var_run(toa_flux, band2gpt_sw, nswbands, sol_irrad, we, nbins, sol_tsi, &
-                                       do_spctrl_scaling, sfac, eccf, errmsg, errflg)
+                  call rrtmgp_sw_solar_var_run(toa_flux, 2, band2gpt_sw, nswbands, sol_irrad, we, nbins, sol_tsi, &
+                          nday, dosw, do_spctrl_scaling, sfac, eccf, errmsg, errflg)
                   if (errflg /= 0) then
                      call endrun(sub//': '//errmsg)
                   end if
@@ -1311,11 +1327,11 @@ subroutine radiation_tend( &
       if (dolw) then
 
          ! Set cloud optical properties in cloud_lw object.
-         call rrtmgp_lw_cloud_optics_run(dolw, ncol, nlay, nlaycam, cld(:ncol,:), cldfsnow_in,     &
+         call rrtmgp_lw_cloud_optics_run(dolw, ncol, nlay, cld(:ncol,:), cldfsnow_in,     &
              cldfgrau_in, cldfprime(:ncol,:), kdist_lw, cloud_lw, lambda(:ncol,:), mu(:ncol,:),    &
              iclwp(:ncol,:), iciwp(:ncol,:), tiny, dei(:ncol,:), icswp(:ncol,:), des(:ncol,:),     &
              icgrauwp(:ncol,:), degrau(:ncol,:), nlwbands, do_snow, do_graupel, pver, ktopcam,     &
-             tauc, cldf, cld_lw_abs, snow_lw_abs, grau_lw_abs, errmsg, errflg)
+             cld_lw_abs, snow_lw_abs, grau_lw_abs, c_cld_lw_abs, errmsg, errflg)
          if (errflg /= 0) then
             call endrun(sub//': '//errmsg)
          end if
@@ -1326,9 +1342,9 @@ subroutine radiation_tend( &
          grau_lw_abs_cloudsim(:ncol,:) = grau_lw_abs(idx_lw_cloudsim,:,:)
 
          ! Create McICA stochastic arrays for lw cloud optical properties
-         call rrtmgp_lw_mcica_subcol_gen_run(dolw, ktoprad, &
-                 kdist_lw, nlwbands, nlwgpts, ncol, pver, nlaycam, nlwgpts, &
-                 state%pmid(:ncol,:), cldf, tauc, cloud_lw, errmsg, errflg )
+         call rrtmgp_lw_mcica_subcol_gen_run(dolw, ktoprad, ktopcam, &
+                 kdist_lw, nlwbands, changeseed, ncol, pver, nlaycam, cldfprime(:ncol,:), &
+                 c_cld_lw_abs, nlwgpts, state%pmid(:ncol,:), cloud_lw, errmsg, errflg )
          if (errflg /= 0) then
             call endrun(sub//': '//errmsg)
          end if
@@ -1491,9 +1507,9 @@ subroutine radiation_tend( &
    cam_out%netsw(:) = 0._r8
 
    ! Calculate radiative heating (Q*dp), set netsw flux, and do object cleanup
-   call rrtmgp_post_run(qrs_prime(:ncol,:), qrl_prime(:ncol,:), fsns(:ncol), state%pdel(:ncol,:), atm_optics_sw, cloud_sw, &
-           aer_sw, fsw, fswc, atm_optics_lw, sources_lw, cloud_lw, aer_lw, flw, flwc, qrs(:ncol,:), qrl(:ncol,:),          &
-           cam_out%netsw(:ncol), errmsg, errflg)
+   call rrtmgp_post_run(nlay, dolw, qrs_prime(:ncol,:), qrl_prime(:ncol,:), fsns(:ncol), state%pdel(:ncol,:), &
+           atm_optics_sw, cloud_sw, aer_sw, fsw, fswc, atm_optics_lw, sources_lw, cloud_lw, aer_lw, flw, flwc,&
+           cam_out%flwds(:ncol), qrs(:ncol,:), qrl(:ncol,:), cam_out%netsw(:ncol), errmsg, errflg)
    if (errflg /= 0) then
      call endrun(sub//': '//errmsg)
    end if

src/utils/cam_ccpp/ccpp_constituent_prop_mod.F90

@@ -23,11 +23,17 @@ module ccpp_constituent_prop_mod
 
    end type ccpp_constituent_prop_ptr_t
 
+   type, public :: ccpp_constituent_properties_t
+      contains
+      procedure :: instantiate
+   end type ccpp_constituent_properties_t
+
    ! CCPP properties init routine
    public :: ccpp_const_props_init
 
    ! Public properties DDT variable:
    type(ccpp_constituent_prop_ptr_t), allocatable, public :: ccpp_const_props(:)
+   integer, public, parameter :: int_unassigned = HUGE(-1)
 
 contains
 
@@ -275,4 +281,31 @@ subroutine ccpp_const_props_init(ix_qv)
 
 end subroutine ccpp_const_props_init
 
+!+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+!CAM-equivalent stub so dynamic constituents register routines can build
+!+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+subroutine instantiate(this, std_name, long_name, units, vertical_dim,  &
+        advected, default_value, min_value, molar_mass, water_species,         &
+        mixing_ratio_type, errcode, errmsg)
+      use ccpp_kinds, only: kind_phys
+
+      ! Dummy arguments
+      class(ccpp_constituent_properties_t), intent(inout) :: this
+      character(len=*),                     intent(in)    :: std_name
+      character(len=*),                     intent(in)    :: long_name
+      character(len=*),                     intent(in)    :: units
+      character(len=*),                     intent(in)    :: vertical_dim
+      logical, optional,                    intent(in)    :: advected
+      real(kind_phys), optional,            intent(in)    :: default_value
+      real(kind_phys), optional,            intent(in)    :: min_value
+      real(kind_phys), optional,            intent(in)    :: molar_mass
+      logical, optional,                    intent(in)    :: water_species
+      character(len=*), optional,           intent(in)    :: mixing_ratio_type
+      integer,                              intent(out)   :: errcode
+      character(len=*),                     intent(out)   :: errmsg
+
+      ! STUB DOES NOTHING
+
+end subroutine instantiate
+
 end module ccpp_constituent_prop_mod

src/utils/cam_ccpp/ccpp_scheme_utils.F90

@@ -0,0 +1,42 @@
+module ccpp_scheme_utils
+
+   ! Module of utilities available to CCPP schemes; CAM stubs to enable CCPPized schemes to build
+
+   implicit none
+   private
+
+   !! Public interfaces
+   public :: ccpp_constituent_index          ! Lookup index constituent by name
+   public :: ccpp_constituent_indices        ! Lookup indices of consitutents by name
+
+contains
+   subroutine ccpp_constituent_index(standard_name, const_index, errcode, errmsg)
+      ! Dummy arguments
+      character(len=*),           intent(in)  :: standard_name
+      integer,                    intent(out) :: const_index
+      integer,          optional, intent(out) :: errcode
+      character(len=*), optional, intent(out) :: errmsg
+
+      ! Local variable
+      character(len=*), parameter :: subname = 'ccpp_constituent_index'
+
+      ! STUB DOES NOTHING
+
+   end subroutine ccpp_constituent_index
+
+   subroutine ccpp_constituent_indices(standard_names, const_inds, errcode, errmsg)
+      ! Dummy arguments
+      character(len=*),           intent(in)  :: standard_names(:)
+      integer,                    intent(out) :: const_inds(:)
+      integer,          optional, intent(out) :: errcode
+      character(len=*), optional, intent(out) :: errmsg
+
+      ! Local variables
+      integer                     :: indx
+      character(len=*), parameter :: subname = 'ccpp_constituent_indices'
+
+      ! STUB DOES NOTHING
+
+   end subroutine ccpp_constituent_indices
+
+end module ccpp_scheme_utils