Introduce optional arguments in ccpp schemes and metadata

CMakeLists.txt

@@ -142,7 +142,9 @@ SET_PROPERTY(SOURCE ${SCHEMES} ${CAPS}
 # Lower optimization for certain schemes when compiling with Intel in Release mode
 if(CMAKE_BUILD_TYPE STREQUAL "Release" AND ${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel")
   # Define a list of schemes that need lower optimization with Intel in Release mode
-  set(SCHEME_NAMES_LOWER_OPTIMIZATION module_sf_mynn.F90)
+  set(SCHEME_NAMES_LOWER_OPTIMIZATION module_sf_mynn.F90
+                                      mynnedmf_wrapper.F90
+                                      gcycle.F90)
   foreach(SCHEME_NAME IN LISTS SCHEME_NAMES_LOWER_OPTIMIZATION)
     set(SCHEMES_TMP ${SCHEMES})
     # Need to determine the name of the scheme with its path

physics/CONV/C3/cu_c3_deep.F90

@@ -167,7 +167,7 @@ subroutine cu_c3_deep_run(        &
      real(kind=kind_phys),  dimension (its:)                   &
         ,intent (in  )                   ::  rand_mom,rand_vmas
 !$acc declare copyin(rand_clos,rand_mom,rand_vmas)
-     real(kind=kind_phys), intent(in), dimension (its:) :: ca_deep(:)
+     real(kind=kind_phys), intent(in), dimension (its:), optional :: ca_deep(:)
      integer, intent(in) :: do_capsuppress
      real(kind=kind_phys), intent(in), dimension(:) :: cap_suppress_j
 !$acc declare create(cap_suppress_j)
@@ -188,7 +188,10 @@ subroutine cu_c3_deep_run(        &
         frh_out,rainevap
      real(kind=kind_phys),    dimension (its:,kts:)                              &
         ,intent (in  )                      ::                         &
-        tmf, qmicro, sigmain, forceqv_spechum
+        tmf
+     real(kind=kind_phys),    dimension (its:,kts:)                              &
+        ,intent (in  ), optional            ::                         &
+        qmicro, sigmain, forceqv_spechum
      real(kind=kind_phys),    dimension (its:)                                      &
         ,intent (inout  )                   ::                         &
         pre,xmb_out
@@ -223,7 +226,7 @@ subroutine cu_c3_deep_run(        &
          q,qo,zuo,zdo,zdm
 !$acc declare sigmaout                                                                                                                                                      
      real(kind=kind_phys),    dimension (its:,kts:)                              &
-        ,intent (out)                     ::                           &
+        ,intent (out), optional           ::                           &
          sigmaout
      real(kind=kind_phys), dimension (its:)                                         &
         ,intent (in   )                   ::                           &
@@ -376,7 +379,7 @@ subroutine cu_c3_deep_run(        &
 !$acc       ktopdby,kbconx,ierr2,ierr3,kbmax)
 
      integer,  dimension (its:), intent(inout) :: ierr
-     integer,  dimension (its:), intent(in) :: csum
+     integer,  dimension (its:), intent(in), optional :: csum
      logical, intent(in) :: do_ca, progsigma
      logical, intent(in) :: flag_init, flag_restart
 !$acc declare copy(ierr) copyin(csum)

physics/CONV/C3/cu_c3_driver.F90

@@ -111,18 +111,19 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
    real (kind=kind_phys), intent(in) :: g,cp,fv,r_d,xlv,r_v,betascu,betamcu,betadcu
    logical, intent(in   ) :: ldiag3d
    logical, intent(in   ) :: progsigma
-   real(kind=kind_phys), intent(inout)                      :: dtend(:,:,:)
+   real(kind=kind_phys), intent(inout), optional            :: dtend(:,:,:)
 !$acc declare copy(dtend)
    integer, intent(in)                                      :: dtidx(:,:), &
         index_of_x_wind, index_of_y_wind, index_of_temperature,            &
         index_of_process_scnv, index_of_process_dcnv, ntqv, ntcw, ntiw
 !$acc declare copyin(dtidx)
-   real(kind=kind_phys),  dimension( : , : ), intent(in    ) :: forcet,forceqv_spechum,w,phil,delp
-   real(kind=kind_phys), dimension ( : , : ), intent(in    ) :: sigmain,qmicro
+   real(kind=kind_phys),  dimension( : , : ), intent(in    ), optional :: forcet,forceqv_spechum
+   real(kind=kind_phys),  dimension( : , : ), intent(in    ) :: w,phil,delp
+   real(kind=kind_phys), dimension ( : , : ), intent(in    ), optional :: sigmain,qmicro
    real(kind=kind_phys),  dimension( : , : ), intent(inout ) :: t,us,vs
-   real(kind=kind_phys),  dimension( : , : ), intent(inout ) :: qci_conv
+   real(kind=kind_phys),  dimension( : , : ), intent(inout ), optional :: qci_conv
    real(kind=kind_phys),  dimension( : , : ), intent(out   ) :: cnvw_moist,cnvc
-   real(kind=kind_phys), dimension ( : , : ), intent(out   ) :: sigmaout
+   real(kind=kind_phys), dimension ( : , : ), intent(out   ), optional :: sigmaout
    real(kind=kind_phys),  dimension( : , : ), intent(inout ) :: cliw, clcw
    real(kind=kind_phys), dimension ( : , : , :), intent(in    ) :: tmf
 !$acc declare copyin(forcet,forceqv_spechum,w,phil)
@@ -134,27 +135,31 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
    integer, intent(in) :: dfi_radar_max_intervals
    real(kind=kind_phys), intent(in) :: fhour, fh_dfi_radar(:)
    integer, intent(in) :: num_dfi_radar, ix_dfi_radar(:)
-   real(kind=kind_phys), intent(in) :: cap_suppress(:,:)
+   real(kind=kind_phys), intent(in), optional :: cap_suppress(:,:)
 !$acc declare copyin(fh_dfi_radar,ix_dfi_radar,cap_suppress)
 
    integer, dimension (:), intent(out) :: hbot,htop,kcnv
    integer, dimension (:), intent(in)  :: xland
-   real(kind=kind_phys),    dimension (:), intent(in) :: pbl,maxMF
+   real(kind=kind_phys),    dimension (:), intent(in) :: pbl
+   real(kind=kind_phys),    dimension (:), intent(in), optional :: maxMF
 !$acc declare copyout(hbot,htop,kcnv)
 !$acc declare copyin(xland,pbl)
    integer, dimension (im) :: tropics
 !$acc declare create(tropics)
 !  ruc variable
-   real(kind=kind_phys), dimension (:),   intent(in)  :: hfx2,qfx2,psuri,ca_deep
-   real(kind=kind_phys), dimension (:,:), intent(out) :: ud_mf,dd_mf,dt_mf
-   real(kind=kind_phys), dimension (:),   intent(out) :: raincv,cld1d,maxupmf,rainevap
+   real(kind=kind_phys), dimension (:),   intent(in)  :: hfx2,qfx2,psuri
+   real(kind=kind_phys), dimension (:),   intent(in),  optional :: ca_deep
+   real(kind=kind_phys), dimension (:,:), intent(out), optional :: ud_mf
+   real(kind=kind_phys), dimension (:,:), intent(out) :: dd_mf,dt_mf
+   real(kind=kind_phys), dimension (:),   intent(out) :: raincv,cld1d,rainevap
+   real(kind=kind_phys), dimension (:),   intent(out), optional :: maxupmf
    real(kind=kind_phys), dimension (:,:), intent(in)  :: t2di,p2di
 !$acc declare copyin(hfx2,qfx2,psuri,t2di,p2di)
 !$acc declare copyout(ud_mf,dd_mf,dt_mf,raincv,cld1d)
    ! Specific humidity from FV3
    real(kind=kind_phys), dimension (:,:), intent(in) :: qv2di_spechum
    real(kind=kind_phys), dimension (:,:), intent(inout) :: qv_spechum
-   real(kind=kind_phys), dimension (:), intent(inout) :: aod_gf
+   real(kind=kind_phys), dimension (:), intent(inout), optional :: aod_gf
 !$acc declare copyin(qv2di_spechum) copy(qv_spechum,aod_gf)
    ! Local water vapor mixing ratios and cloud water mixing ratios
    real(kind=kind_phys), dimension (im,km) :: qv2di, qv, forceqv, cnvw
@@ -165,7 +170,7 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
    real(kind=kind_phys), intent(in   ) :: dt
 
    integer, intent(in   ) :: imfshalcnv
-   integer, dimension(:), intent(inout) :: cactiv,cactiv_m
+   integer, dimension(:), intent(inout), optional :: cactiv,cactiv_m
 !$acc declare copy(cactiv,cactiv_m)
 
    character(len=*), intent(out) :: errmsg
@@ -841,30 +846,29 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
               ,ca_deep       &
               ,mconv         &
               ,omeg          &
-
-              ,cactiv       &
-              ,cnvwt        &
-              ,zu           &
-              ,zd           &
-              ,zdm          & ! hli
-              ,edt          &
-              ,edtm         & ! hli
-              ,xmb          &
-              ,xmbm         &
-              ,xmbs         &
-              ,pret         &
-              ,outu         &
-              ,outv         &
-              ,outt         &
-              ,outq         &
-              ,outqc        &
-              ,kbcon        &
-              ,ktop         &
-              ,cupclw       &
-              ,frhd         &
-              ,rainevap     &
-              ,ierr         &
-              ,ierrc        &
+              ,cactiv        &
+              ,cnvwt         &
+              ,zu            &
+              ,zd            &
+              ,zdm           & ! hli
+              ,edt           &
+              ,edtm          & ! hli
+              ,xmb           &
+              ,xmbm          &
+              ,xmbs          &
+              ,pret          &
+              ,outu          &
+              ,outv          &
+              ,outt          &
+              ,outq          &
+              ,outqc         &
+              ,kbcon         &
+              ,ktop          &
+              ,cupclw        &
+              ,frhd          &
+              ,rainevap      &
+              ,ierr          &
+              ,ierrc         &
 !    the following should be set to zero if not available
               ,rand_mom      & ! for stochastics mom, if temporal and spatial patterns exist
               ,rand_vmas     & ! for stochastics vertmass, if temporal and spatial patterns exist

physics/CONV/C3/cu_c3_driver.meta

@@ -156,13 +156,15 @@
   dimensions = (horizontal_loop_extent)
   type = integer
   intent = inout
+  optional = True
 [cactiv_m]
   standard_name = counter_for_grell_freitas_mid_level_convection
   long_name = mid-level cloud convective activity memory
   units = none
   dimensions = (horizontal_loop_extent)
   type = integer
   intent = inout
+  optional = True
 [g]
   standard_name = gravitational_acceleration
   long_name = gravitational acceleration
@@ -219,6 +221,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [forceqv_spechum]
   standard_name = tendendy_of_specific_humidity_due_to_nonphysics
   long_name = moisture tendency due to dynamics only
@@ -227,6 +230,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [tmf]
   standard_name = tendency_of_vertically_diffused_tracer_concentration
   long_name = updated tendency of the tracers due to vertical diffusion in PBL scheme
@@ -243,6 +247,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [sigmain]
   standard_name = prognostic_updraft_area_fraction_in_convection
   long_name = convective updraft area fraction
@@ -251,6 +256,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [sigmaout]
   standard_name = updraft_area_fraction_updated_by_physics
   long_name = convective updraft area fraction updated by physics
@@ -259,6 +265,7 @@
   type = real
   kind = kind_phys
   intent = out
+  optional = True
 [betascu]
   standard_name = tuning_param_for_shallow_cu
   long_name = tuning param for shallow cu in case prognostic closure is used
@@ -438,6 +445,7 @@
   type = real
   kind = kind_phys
   intent = inout
+  optional = True
 [cliw]
   standard_name = ice_water_mixing_ratio_convective_transport_tracer
   long_name = ratio of mass of ice water to mass of dry air plus vapor (without condensates) in the convectively transported tracer array
@@ -470,6 +478,7 @@
   type = real
   kind = kind_phys
   intent = out
+  optional = True
 [dd_mf]
   standard_name = instantaneous_atmosphere_downdraft_convective_mass_flux
   long_name = (downdraft mass flux) * delt
@@ -531,6 +540,7 @@
   type = real
   kind = kind_phys
   intent = inout
+  optional = True
 [dtidx]
   standard_name = cumulative_change_of_state_variables_outer_index
   long_name = index of state-variable and process in last dimension of diagnostic tendencies array AKA cumulative_change_index
@@ -616,6 +626,7 @@
   type = real
   kind = kind_phys
   intent = inout
+  optional = True
 [fhour]
   standard_name = forecast_time
   long_name = current forecast time
@@ -661,6 +672,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [ca_deep]
   standard_name = cellular_automata_area_fraction_for_deep_convection_from_coupled_process
   long_name = fraction of cellular automata for deep convection
@@ -669,6 +681,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [rainevap]
   standard_name = physics_field_for_coupling
   long_name = physics_field_for_coupling
@@ -685,6 +698,7 @@
   type = real
   kind = kind_phys
   intent = out
+  optional = True
 [maxMF]
   standard_name = maximum_mass_flux
   long_name = maximum mass flux within a column
@@ -693,6 +707,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [do_mynnedmf]
   standard_name = flag_for_mellor_yamada_nakanishi_niino_pbl_scheme
   long_name = flag to activate MYNN-EDMF

physics/CONV/C3/cu_c3_driver_post.F90

@@ -26,15 +26,16 @@ subroutine cu_c3_driver_post_run (im, km, t, q, prevst, prevsq, cactiv, cactiv_m
       real(kind_phys),  intent(in)  :: t(:,:)
       real(kind_phys),  intent(in)  :: q(:,:)
       real(kind_phys), dimension(:),intent(in) :: garea
-      real(kind_phys),  intent(out) :: prevst(:,:)
-      real(kind_phys),  intent(out) :: prevsq(:,:)
-      integer,          intent(in)  :: cactiv(:)
-      integer,          intent(in)  :: cactiv_m(:)
-      real(kind_phys),  intent(out) :: conv_act(:)
-      real(kind_phys),  intent(out) :: conv_act_m(:)
+      real(kind_phys),  intent(out), optional :: prevst(:,:)
+      real(kind_phys),  intent(out), optional :: prevsq(:,:)
+      integer,          intent(in),  optional :: cactiv(:)
+      integer,          intent(in),  optional :: cactiv_m(:)
+      real(kind_phys),  intent(out), optional :: conv_act(:)
+      real(kind_phys),  intent(out), optional :: conv_act_m(:)
       ! for Radar reflectivity
       real(kind_phys),  intent(in)  :: dt
-      real(kind_phys),  intent(in)  :: raincv(:), maxupmf(:)
+      real(kind_phys),  intent(in)  :: raincv(:)
+      real(kind_phys),  intent(in), optional :: maxupmf(:)
       real(kind_phys),  intent(inout) :: refl_10cm(:,:)
       character(len=*), intent(out) :: errmsg
 !$acc declare copyin(t,q,cactiv,cactiv_m) copyout(prevst,prevsq,conv_act,conv_act_m)

physics/CONV/C3/cu_c3_driver_post.meta

@@ -45,6 +45,7 @@
   type = real
   kind = kind_phys
   intent = out
+  optional = True
 [prevsq]
   standard_name = specific_humidity_on_previous_timestep
   long_name = moisture from previous time step
@@ -53,20 +54,23 @@
   type = real
   kind = kind_phys
   intent = out
+  optional = True
 [cactiv]
   standard_name = counter_for_grell_freitas_convection
   long_name = convective activity memory
   units = none
   dimensions = (horizontal_loop_extent)
   type = integer
   intent = in
+  optional = True
 [cactiv_m]
   standard_name = counter_for_grell_freitas_mid_level_convection
   long_name = midlevel convective activity memory
   units = none
   dimensions = (horizontal_loop_extent)
   type = integer
   intent = in
+  optional = True
 [conv_act]
   standard_name = consecutive_calls_for_grell_freitas_convection
   long_name = Memory counter for GF
@@ -75,6 +79,7 @@
   type = real
   kind = kind_phys
   intent = out
+  optional = True
 [conv_act_m]
   standard_name = consecutive_calls_for_grell_freitas_mid_level_convection
   long_name = Memory counter for GF midlevel
@@ -83,6 +88,7 @@
   type = real
   kind = kind_phys
   intent = out
+  optional = True
 [dt]
   standard_name = timestep_for_physics
   long_name = physics time step
@@ -115,6 +121,7 @@
   type = real
   kind = kind_phys
   intent = in
+  optional = True
 [refl_10cm]
   standard_name = radar_reflectivity_10cm
   long_name = instantaneous refl_10cm