Merge pull request #446 from dustinswales/dtc/develop

RRTMGP w/ GFS SDFs + some housekeeping

physics/GFS_cloud_diagnostics.meta

@@ -0,0 +1,159 @@
+########################################################################
+[ccpp-arg-table]
+  name = GFS_cloud_diagnostics_run
+  type = scheme
+[ncol]
+  standard_name = horizontal_loop_extent
+  long_name = horizontal dimension
+  units = count
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F
+[nLev]
+  standard_name = vertical_dimension
+  long_name = number of vertical levels
+  units = count
+  dimensions = ()
+  type = integer
+  intent = in
+  optional = F  
+[lsswr]
+  standard_name = flag_to_calc_sw
+  long_name = logical flags for sw radiation calls
+  units = flag
+  dimensions = ()
+  type = logical
+  intent = in
+  optional = F
+[lslwr]
+  standard_name = flag_to_calc_lw
+  long_name = logical flags for lw radiation calls
+  units = flag
+  dimensions = ()
+  type = logical
+  intent = in
+  optional = F    
+[lat]
+  standard_name = latitude
+  long_name = latitude
+  units = radian
+  dimensions = (horizontal_dimension)
+  type = real
+  intent = in
+  kind = kind_phys
+  optional = F  
+[p_lay]
+  standard_name = air_pressure_at_layer_for_RRTMGP_in_hPa
+  long_name = air pressure at vertical layer for radiation calculation
+  units = hPa
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F   
+[cld_frac]
+  standard_name = total_cloud_fraction
+  long_name = layer total cloud fraction
+  units = frac
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F 
+[p_lev]
+  standard_name = air_pressure_at_interface_for_RRTMGP_in_hPa
+  long_name = air pressure at vertical interface for radiation calculation
+  units = hPa
+  dimensions = (horizontal_dimension,vertical_dimension_plus_one)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F    
+[mtopa]
+  standard_name = model_layer_number_at_cloud_top
+  long_name = vertical indices for low, middle and high cloud tops
+  units = index
+  dimensions = (horizontal_dimension,3)
+  type = integer
+  intent = out
+  optional = F
+[mbota]
+  standard_name = model_layer_number_at_cloud_base
+  long_name = vertical indices for low, middle and high cloud bases
+  units = index
+  dimensions = (horizontal_dimension,3)
+  type = integer
+  intent = out
+  optional = F
+[de_lgth]
+  standard_name = cloud_decorrelation_length
+  long_name = cloud decorrelation length
+  units = km
+  dimensions = (horizontal_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[deltaZ]
+  standard_name = layer_thickness
+  long_name = layer_thickness
+  units = m
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F    
+[cloud_overlap_param]
+  standard_name = cloud_overlap_param
+  long_name = cloud overlap parameter
+  units = km
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[precip_overlap_param]
+  standard_name = precip_overlap_param
+  long_name = precipitation overlap parameter
+  units = km
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F  
+[con_pi]
+  standard_name = pi
+  long_name = ratio of a circle's circumference to its diameter
+  units = none
+  dimensions = ()
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F   
+[cldsa]
+  standard_name = cloud_area_fraction_for_radiation
+  long_name = fraction of clouds for low, middle, high, total and BL
+  units = frac
+  dimensions = (horizontal_dimension,5)
+  type = real
+  kind = kind_phys
+  intent = out
+  optional = F  
+[errmsg]
+  standard_name = ccpp_error_message
+  long_name = error message for error handling in CCPP
+  units = none
+  dimensions = ()
+  type = character
+  kind = len=*
+  intent = out
+  optional = F
+[errflg]
+  standard_name = ccpp_error_flag
+  long_name = error flag for error handling in CCPP
+  units = flag
+  dimensions = ()
+  type = integer
+  intent = out
+  optional = F    

physics/GFS_rrtmgp_gfdlmp_pre.F90

@@ -0,0 +1,234 @@
+! ########################################################################################
+! This module contains the interface between the GFDL macrophysics and the RRTMGP radiation
+! schemes. Only compatable with Model%imp_physics = Model%imp_physics_gfdl
+! ########################################################################################
+module GFS_rrtmgp_gfdlmp_pre
+  use machine,      only: kind_phys
+  use physparam,    only: lcnorm, lcrick, idcor, iovrlw, iovrsw
+  use rrtmgp_aux,   only: check_error_msg
+  use module_radiation_clouds, only: get_alpha_exp, get_alpha_dcorr
+  ! Parameters
+  real(kind_phys), parameter :: &
+       reliq_def  = 10.0 ,      & ! Default liq radius to 10 micron (used when effr_in=F)
+       reice_def  = 50.0,       & ! Default ice radius to 50 micron (used when effr_in=F)
+       rerain_def = 1000.0,     & ! Default rain radius to 1000 micron (used when effr_in=F)
+       resnow_def = 250.0,      & ! Default snow radius to 250 micron (used when effr_in=F)    
+       reice_min  = 10.0,       & ! Minimum ice size allowed by scheme
+       reice_max  = 150.0,      & ! Maximum ice size allowed by scheme
+       cllimit    = 0.001         ! Lowest cloud fraction in GFDL MP scheme
+
+   public GFS_rrtmgp_gfdlmp_pre_init, GFS_rrtmgp_gfdlmp_pre_run, GFS_rrtmgp_gfdlmp_pre_finalize
+
+contains  
+  ! ######################################################################################
+  ! ######################################################################################
+  subroutine GFS_rrtmgp_gfdlmp_pre_init()
+  end subroutine GFS_rrtmgp_gfdlmp_pre_init
+
+  ! ######################################################################################
+  ! ######################################################################################
+!! \section arg_table_GFS_rrtmgp_gfdlmp_pre_run
+!! \htmlinclude GFS_rrtmgp_gfdlmp_pre_run.html
+!!  
+  subroutine GFS_rrtmgp_gfdlmp_pre_run(nCol, nLev, nTracers, ncnd, i_cldliq, i_cldice,   &
+       i_cldrain, i_cldsnow, i_cldgrpl, i_cldtot, yearlen, lsswr, lslwr, effr_in, julian,&
+       lat, p_lev, p_lay, tv_lay, effrin_cldliq, effrin_cldice, effrin_cldrain,          &
+       effrin_cldsnow, tracer, con_pi, con_g, con_rd, con_epsq,                          &
+       cld_frac, cld_lwp, cld_reliq, cld_iwp, cld_reice, cld_swp, cld_resnow, cld_rwp,   &
+       cld_rerain, precip_frac, cloud_overlap_param, precip_overlap_param, de_lgth,      &
+       deltaZ, errmsg, errflg)
+    implicit none
+
+    ! Inputs   
+    integer, intent(in)    :: &
+         nCol,              & ! Number of horizontal grid points
+         nLev,              & ! Number of vertical layers
+         ncnd,              & ! Number of cloud condensation types.
+         nTracers,          & ! Number of tracers from model. 
+         i_cldliq,          & ! Index into tracer array for cloud liquid. 
+         i_cldice,          & ! Index into tracer array for cloud ice.
+         i_cldrain,         & ! Index into tracer array for cloud rain.
+         i_cldsnow,         & ! Index into tracer array for cloud snow.
+         i_cldgrpl,         & ! Index into tracer array for cloud groupel.
+         i_cldtot,          & ! Index into tracer array for cloud total amount.
+         yearlen              ! Length of current year (365/366) WTF?             
+    logical, intent(in) :: &
+    	 lsswr,             & ! Call SW radiation?
+    	 lslwr,             & ! Call LW radiation
+    	 effr_in              ! Provide hydrometeor radii from macrophysics?
+    real(kind_phys), intent(in) :: &
+         julian,            & ! Julian day 
+         con_pi,            & ! Physical constant: pi
+         con_g,             & ! Physical constant: gravitational constant
+         con_rd,            & ! Physical constant: gas-constant for dry air
+         con_epsq             ! Physical constant(?): Minimum value for specific humidity
+    real(kind_phys), dimension(nCol), intent(in) :: &
+         lat                  ! Latitude             
+    real(kind_phys), dimension(nCol,nLev), intent(in) :: &         
+         tv_lay,            & ! Virtual temperature (K)
+         p_lay,             & ! Pressure at model-layers (Pa)
+         effrin_cldliq,     & ! Effective radius for liquid cloud-particles (microns)
+         effrin_cldice,     & ! Effective radius for ice cloud-particles (microns)
+         effrin_cldrain,    & ! Effective radius for rain cloud-particles (microns)
+         effrin_cldsnow       ! Effective radius for snow cloud-particles (microns)
+    real(kind_phys), dimension(nCol,nLev+1), intent(in) :: &         
+         p_lev                ! Pressure at model-level interfaces (Pa)
+    real(kind_phys), dimension(nCol, nLev, nTracers),intent(in) :: &
+         tracer               ! Cloud condensate amount in layer by type ()         
+
+    ! Outputs     
+    real(kind_phys), dimension(nCol),intent(out) :: &
+         de_lgth              ! Decorrelation length     
+    real(kind_phys), dimension(nCol,nLev),intent(out) :: &
+         cld_frac,             & ! Total cloud fraction
+         cld_lwp,              & ! Cloud liquid water path
+         cld_reliq,            & ! Cloud liquid effective radius
+         cld_iwp,              & ! Cloud ice water path
+         cld_reice,            & ! Cloud ice effecive radius
+         cld_swp,              & ! Cloud snow water path
+         cld_resnow,           & ! Cloud snow effective radius
+         cld_rwp,              & ! Cloud rain water path
+         cld_rerain,           & ! Cloud rain effective radius       
+         precip_frac,          & ! Precipitation fraction
+         cloud_overlap_param,  & ! Cloud-overlap parameter
+         precip_overlap_param, & ! Precipitation overlap parameter  
+         deltaZ                  ! Layer thickness (km)          
+    character(len=*), intent(out) :: &
+         errmsg               ! Error message
+    integer, intent(out) :: &  
+         errflg               ! Error flag
+
+    ! Local variables
+    real(kind_phys) :: tem1
+    real(kind_phys), dimension(nCol, nLev, min(4,ncnd)) :: cld_condensate
+    integer :: iCol,iLay,l,ncndl,iovr
+    real(kind_phys), dimension(nCol,nLev) :: deltaP
+
+    if (.not. (lsswr .or. lslwr)) return
+
+    ! Initialize CCPP error handling variables
+    errmsg = ''
+    errflg = 0
+
+    ! Test inputs
+    if (ncnd .ne. 5) then
+       errmsg = 'Incorrect number of cloud condensates provided'
+       errflg = 1
+       call check_error_msg('GFS_rrtmgp_gfdlmp_pre_run',errmsg)
+       return
+    endif
+    ! 
+    if (lcrick) then
+       errmsg = 'Namelist option lcrick is not supported.'
+       errflg = 1
+       call check_error_msg('GFS_rrtmgp_gfdlmp_pre_run',errmsg)
+       return
+    endif
+    ! 
+    if (lcnorm) then
+       errmsg = 'Namelist option lcnorm is not supported.'
+       errflg = 1
+       call check_error_msg('GFS_rrtmgp_gfdlmp_pre_run',errmsg)
+       return
+    endif
+
+    ! Initialize outputs
+    cld_lwp(:,:)    = 0.0
+    cld_reliq(:,:)  = 0.0
+    cld_iwp(:,:)    = 0.0
+    cld_reice(:,:)  = 0.0
+    cld_rwp(:,:)    = 0.0
+    cld_rerain(:,:) = 0.0
+    cld_swp(:,:)    = 0.0
+    cld_resnow(:,:) = 0.0
+
+    ! ####################################################################################
+    ! Pull out cloud information for GFDL MP scheme.
+    ! ####################################################################################
+    ! Condensate
+    cld_condensate(1:nCol,1:nLev,1) = tracer(1:nCol,1:nLev,i_cldliq)     ! -liquid water
+    cld_condensate(1:nCol,1:nLev,2) = tracer(1:nCol,1:nLev,i_cldice)     ! -ice water
+    cld_condensate(1:nCol,1:nLev,3) = tracer(1:nCol,1:nLev,i_cldrain)    ! -rain water
+    cld_condensate(1:nCol,1:nLev,4) = tracer(1:nCol,1:nLev,i_cldsnow) + &! -snow + grapuel
+                                      tracer(1:nCol,1:nLev,i_cldgrpl) 
+
+    ! Since we combine the snow and grapuel, define local variable for number of condensate types.
+    ncndl = min(4,ncnd)
+
+    ! Set really tiny suspended particle amounts to clear
+    do l=1,ncndl
+       do iLay=1,nLev
+          do iCol=1,nCol   
+             if (cld_condensate(iCol,iLay,l) < con_epsq) cld_condensate(iCol,iLay,l) = 0.0
+          enddo
+       enddo
+    enddo
+
+    ! Cloud-fraction
+    cld_frac(1:nCol,1:nLev)   = tracer(1:nCol,1:nLev,i_cldtot)
+
+    ! Precipitation fraction (Hack. For now use cloud-fraction)
+    precip_frac(1:nCol,1:nLev) = tracer(1:nCol,1:nLev,i_cldtot)
+
+    ! Condensate and effective size
+    deltaP = abs(p_lev(:,2:nLev+1)-p_lev(:,1:nLev))/100.  
+    do iLay = 1, nLev
+       do iCol = 1, nCol
+          ! Compute liquid/ice condensate path from mixing ratios (kg/kg)->(g/m2)   
+          if (cld_frac(iCol,iLay) .ge. cllimit) then         
+             tem1          = (1.0e5/con_g) * deltaP(iCol,iLay)
+             cld_lwp(iCol,iLay)  = cld_condensate(iCol,iLay,1) * tem1
+             cld_iwp(iCol,iLay)  = cld_condensate(iCol,iLay,2) * tem1
+             cld_rwp(iCol,iLay)  = cld_condensate(iCol,iLay,3) * tem1
+             cld_swp(iCol,iLay)  = cld_condensate(iCol,iLay,4) * tem1  
+          endif
+          ! Use radii provided from the macrophysics        
+		  if (effr_in) then
+             cld_reliq(iCol,iLay)  = effrin_cldliq(iCol,iLay)
+             cld_reice(iCol,iLay)  = max(reice_min, min(reice_max,effrin_cldice(iCol,iLay)))
+             cld_rerain(iCol,iLay) = effrin_cldrain(iCol,iLay)
+             cld_resnow(iCol,iLay) = effrin_cldsnow(iCol,iLay)
+          else
+             cld_reliq(iCol,iLay)  = reliq_def
+             cld_reice(iCol,iLay)  = reice_def
+             cld_rerain(iCol,iLay) = rerain_def
+             cld_resnow(iCol,iLay) = resnow_def
+          endif
+       enddo
+    enddo
+
+    ! ####################################################################################
+    ! Cloud (and precipitation) overlap
+    ! ####################################################################################
+
+    iovr = max(iovrsw,iovrlw)  
+
+    ! Compute layer-thickness
+    do iCol=1,nCol
+       do iLay=1,nLev
+          deltaZ(iCol,iLay) = ((con_rd/con_g)*0.001) * abs(log(p_lev(iCol,iLay)) - log(p_lev(iCol,iLay+1))) * tv_lay(iCol,iLay)
+       enddo
+    enddo
+
+    !
+    ! Cloud overlap parameter
+    !
+    if (iovr == 3) then
+       call get_alpha_dcorr(nCol, nLev, lat, con_pi, deltaZ, de_lgth, cloud_overlap_param)
+    endif
+    if (iovr == 4 .or. iovr == 5) then 
+       call get_alpha_exp(nCol, nLev, deltaZ, iovr, lat, julian, yearlen, cld_frac, cloud_overlap_param)
+    endif
+
+    ! 
+    ! Compute precipitation overlap parameter (Hack. Using same as cloud for now)
+    !
+    precip_overlap_param = cloud_overlap_param    
+
+  end subroutine GFS_rrtmgp_gfdlmp_pre_run
+
+  ! #########################################################################################
+  ! #########################################################################################
+  subroutine GFS_rrtmgp_gfdlmp_pre_finalize()
+  end subroutine GFS_rrtmgp_gfdlmp_pre_finalize
+end module GFS_rrtmgp_gfdlmp_pre