UFS/dev PR#299 (NCAR#1220)

* update standard names to move Xgrs to physics_timestep_initial* and remove *_of_new_state (default name refers to 'current' value)

* fix a few unchanged standard names

* change some timestep_initial variables to general variables; make satmedmfvdifq return new tendencies and new tendency application block in GFS_PBL_generic_post

* Refactor physics tendency calculations

- Added tendency variables (`ten_t`, `ten_u`, `ten_v`) for temperature and wind tendencies in SAMF deep and shallow convection schemes.
- Updated relevant `.meta` files to reflect changes in variable intent (`inout` -> `in` where appropriate) and added tendencies.
- Modified Interstitials (`GFS_DCNV_generic_post`, `GFS_DCNV_generic_pre`, `GFS_SCNV_generic_post`, `GFS_SCNV_generic_pre`) to directly use tendencies instead of saved state variables.
- Removed redundant saved variables (`save_u`, `save_v`, `save_t`).
- Added `delt` to post interstitials.

* update unified_ugwp, ugwpv1, and drag_suite to use new tendency code

* save tendency work with GFS_photochemistry

* add tracer tendency changes to convection; fix typos in GFS_photochemistry

* fix typo in samfdeepcnv.f

* save tendency work with Thompson MP

* save tendency work with radiation

* add FMS to ccpp-physics CMakeLists.txt for fv3

* add initial setting of state in GFS_time_vary_pre.fv3; fix horizontal_dimension in GFS_time_vary_pre.scm

* fix metadata in GFS_time_vary_pre.fv3

* add momentum tendency output to mp_thompson and fix intent in metadata

* fix array size bug in mp_thompson.F90; cleanup dtend code using new tendency paradigm; cleanup saving of states no longer needed

* fix improperly-merged conflict resolution in GFS_photochemistry.F90

* fix access of ntlnc/ntinc access of tracer array when missing

* convert many RAD, PBL, GWD, CONV, and MP schemes to return tendencies

* convert MG micro and Arakawa-Wu adjustment schemes

* convert MYNNEDMF PBL scheme to return tendencies

* add changes to MYNN EDMF PBL

* add back divide-by-zero bugfix in module_sf_noahmp_glacier.F90 that was removed recently

* remove obsolete interstitial schemes

* fix 2 minor compilation issues after testing with UFS RTs

* fix bug in MG MP

* fix near-surface air temperature standard name in GFS_surface_composites_pre

* apply tendency cleanup to GFDLMPv3 and TEMPO

* fix compilation error

* fix typo in TEMPO

* debug sgscloud_radpre/post

* remove tendency application code from rrtmg_lw/sw_post

* change thmpsn to thompson to fix compilation error

* fix compilation errors in GFS_radiation_post.F90

* remove Zhao-Carr cloud schemes and combine Xu-Randall cloud fraction calculations

* fix array size problem in cs_conv.F90

* refactor RAS tendencies

* fix compilation error in rascnv.F90

* change Xu-Randall cloud fraction  scheme to be elemental

* Fixed too-high lower bound for SMC
Deleted code associated with already removed print statements
Deleted excess comments.

* use new cld_frac_XuRandall function from module_radiation_clouds in RRTMGP scheme

* Tidy-up for PR.

* modify the cld_frac_XuRandall function call in RRTMGP scheme

* Changes to the post L-IAU checks:
* Change tfreeze to match that in NoahMP
* Only set SLC to SMC if temp newly > tfreez

* add the repository update to this PR

* Revert "add the repository update to this PR"

This reverts commit 565d62c.

* fix bug in GFDLMPv3 tendency implementation

* remove the printing tests

* remove Zhao-Carr schemes from modules in the UFS_SCM_NEPTUNE directory

* remove Zhao-Carr microphysics scheme from physics/MP directory

* fix hail tendency changes from reviewer suggestions

* fix indexing bug in cu_tiedtke caught in code review

* changes to RAS tendency application update code from code review

* check for flag_for_generic_tendency_due_to_gravity_wave_drag before computing diagnostic tendencies in drag_suite

* fix diagnostic tendency bug in physics/GWD/ugwpv1_gsldrag.F90

* remove unused arguments in physics/GWD/ugwpv1_gsldrag_post.F90

* fix tendency diagnostics in physics/GWD/unified_ugwp.F90

* fix merge problem in mp_thompson.meta

* add arguments to drag_suite_run called outside of ccpp entry point

* initialize dclw variables in cu_ntiedtke

* fix loop bounds for ten_q in cu_gf_driver.F90

* fix loop bounds in cu_c3_driver

* fix new_q typo in mp_fer_hires.F90

* deallocate locally-allocated variables in MP schemes

* update zeroing logic in m_micro_post after review

* Update for 10m wind option in fire_behavior module

* remove non-ASCII character in canopy_levs.F90 (from previous PR)

* Updates to progomega option of saSAS convection scheme

* Correction

* correction 2

* fix line in SHOC where a tracer was being updated directly

* remove old_ozone array since it was not being used

* deallocate local variables in satmedmfvdifq at end of run phase

* save temperature before modification to pass in to diagnostics in GFS_radiation_post

* fix diagnostic temp tendency in GFS_MP_generic.F90 for when radar is/isn't available

* Correct parameter setting in samfshalcnv to pass debug runs

* address saturation vapor pressure out of bounds error in hafs_4_nest RT

* update long names to remove 'updated by physics'; change prognostic updraft standard names

* remove additional references to Zhao-Carr microphysics

* remove Zhao-Carr references from GFS_scnv_generic_post

* fix deallocation statement in Thompson MP

* fix additional warnings

* Bug fix in physics/GWD/rayleigh_damp.f: don't mix scalars and rank-2 arrays

* remove whitespace changes in radiation_clouds.f

---------

Co-authored-by: VanderleiVargas-NOAA <vanderlei.vargas@noaa.gov>
Co-authored-by: Qingfu Liu <Qingfu.Liu@noaa.gov>
Co-authored-by: Clara.Draoper-NOAA <clara.draper@noaa.gov>
Co-authored-by: Michael Kavulich, Jr <kavulich@ucar.edu>
Co-authored-by: Lisa <lisa.bengtsson@noaa.gov>
Co-authored-by: Rhae Sung Kim <rhaesung.kim@noaa.gov>
Co-authored-by: Grant Firl <grant@Macbook-Air-M4.local>
Co-authored-by: Dom Heinzeller <dom.heinzeller@icloud.com>

Author: 9 people

.gitmodules

@@ -9,4 +9,4 @@
 [submodule "physics/SFC_Layer/MYNN/MYNN"]
   path = physics/SFC_Layer/MYNN/MYNN
   url = https://github.com/NCAR/MYNN-SFC
-  branch = main
+  branch = ccpp/dev

physics/CONV/C3/cu_c3_driver.F90

@@ -80,7 +80,7 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
                fhour,fh_dfi_radar,ix_dfi_radar,num_dfi_radar,cap_suppress,      &
                dfi_radar_max_intervals,ldiag3d,qci_conv,do_cap_suppress,        &
                sigmaout,maxupmf,maxMF,do_mynnedmf,ichoice_in,ichoicem_in,       &
-               ichoice_s_in,errmsg,errflg)
+               ichoice_s_in,ten_t,ten_u,ten_v,ten_q,dcliw,dclcw,errmsg,errflg)
 !-------------------------------------------------------------
       implicit none
       integer, parameter :: maxiens=1
@@ -120,11 +120,11 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
    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(in    ) :: t,us,vs
    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   ), optional :: sigmaout
-   real(kind=kind_phys),  dimension( : , : ), intent(inout ) :: cliw, clcw
+   real(kind=kind_phys),  dimension( : , : ), intent(in    ) :: cliw, clcw
    real(kind=kind_phys), dimension ( : , : , :), intent(in    ) :: tmf
 !$acc declare copyin(forcet,forceqv_spechum,w,phil)
 !$acc declare copy(t,us,vs,qci_conv,cliw, clcw)
@@ -158,7 +158,7 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
 !$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(in) :: qv_spechum
    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
@@ -172,7 +172,9 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
    integer, intent(in   ) :: imfshalcnv
    integer, dimension(:), intent(inout), optional :: cactiv,cactiv_m
 !$acc declare copy(cactiv,cactiv_m)
-
+   real(kind_phys), dimension(:,:), intent(out) :: ten_t, ten_u, ten_v, dcliw, dclcw
+   real(kind_phys), dimension(:,:,:), intent(out) :: ten_q
+   
    character(len=*), intent(out) :: errmsg
    integer,          intent(out) :: errflg
 
@@ -225,7 +227,7 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
 ! omega (omeg), windspeed (us,vs), and a flag (ierr) to turn off
 ! convection for this call only and at that particular gridpoint
 !
-   real(kind=kind_phys), dimension (im,km) :: qcheck,zo,t2d,q2d,po,p2d,rhoi,clw_ten
+   real(kind=kind_phys), dimension (im,km) :: qcheck,zo,t2d,q2d,po,p2d,rhoi,clw_ten,new_qv_spechum,new_cliw,new_clcw
    real(kind=kind_phys), dimension (im,km) :: tn,qo,tshall,qshall,dz8w,omeg
    real(kind=kind_phys), dimension (im)    :: z1,psur,cuten,cutens,cutenm
    real(kind=kind_phys), dimension (im)    :: umean,vmean,pmean,mc_thresh
@@ -268,7 +270,16 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
   ! initialize ccpp error handling variables
      errmsg = ''
      errflg = 0
-
+     
+     ten_t = 0.0
+     ten_u = 0.0
+     ten_v = 0.0
+     ten_q = 0.0
+     dcliw = 0.0
+     dclcw = 0.0
+     new_clcw = clcw
+     new_cliw = cliw
+     
      ichoice   = ichoice_in
      ichoicem  = ichoicem_in
      ichoice_s = ichoice_s_in
@@ -956,11 +967,12 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
                cnvw(i,k)=cnvwt(i,k)*xmb(i)*dt+cnvwts(i,k)*xmbs(i)*dt+cnvwtm(i,k)*xmbm(i)*dt
                ud_mf(i,k)=cuten(i)*zu(i,k)*xmb(i)*dt
                dd_mf(i,k)=cuten(i)*zd(i,k)*edt(i)*xmb(i)*dt
-               t(i,k)=t(i,k)+dt*(cutens(i)*outts(i,k)+cutenm(i)*outtm(i,k)+outt(i,k)*cuten(i))
+               
+               ten_t(i,k) = cutens(i)*outts(i,k)+cutenm(i)*outtm(i,k)+outt(i,k)*cuten(i)
                qv(i,k)=max(1.e-16,qv(i,k)+dt*(cutens(i)*outqs(i,k)+cutenm(i)*outqm(i,k)+outq(i,k)*cuten(i)))
                gdc(i,k,7)=sqrt(us(i,k)**2 +vs(i,k)**2)
-               us(i,k)=us(i,k)+outu(i,k)*cuten(i)*dt +outum(i,k)*cutenm(i)*dt +outus(i,k)*cutens(i)*dt
-               vs(i,k)=vs(i,k)+outv(i,k)*cuten(i)*dt +outvm(i,k)*cutenm(i)*dt +outvs(i,k)*cutens(i)*dt
+               ten_u(i,k) = outu(i,k)*cuten(i) +outum(i,k)*cutenm(i) +outus(i,k)*cutens(i)
+               ten_v(i,k) = outv(i,k)*cuten(i) +outvm(i,k)*cutenm(i) +outvs(i,k)*cutens(i)
 
                gdc(i,k,1)= max(0.,tun_rad_shall(i)*cupclws(i,k)*cutens(i))      ! my mod
                !gdc2(i,k,1)=max(0.,tun_rad_deep(i)*(cupclwm(i,k)*cutenm(i)+cupclw(i,k)*cuten(i)))
@@ -1005,10 +1017,13 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
                          )
                tem1 = max(0.0, min(1.0, (tcr-t(i,k))*tcrf))
                if (clcw(i,k) .gt. -999.0) then
-                cliw(i,k) = max(0.,cliw(i,k) + tem * tem1)            ! ice
-                clcw(i,k) = max(0.,clcw(i,k) + tem *(1.0-tem1))       ! water
+                new_cliw(i,k) = max(0.,cliw(i,k) + tem * tem1)            ! ice
+                new_clcw(i,k) = max(0.,clcw(i,k) + tem *(1.0-tem1))       ! water
+                dcliw(i,k) = (new_cliw(i,k) - cliw(i,k))/dt
+                dclcw(i,k) = (new_clcw(i,k) - clcw(i,k))/dt
                else
-                cliw(i,k) = max(0.,cliw(i,k) + tem)
+                new_cliw(i,k) = max(0.,cliw(i,k) + tem)
+                dcliw(i,k) = (new_cliw(i,k) - cliw(i,k))/dt
                endif
 
              enddo
@@ -1076,9 +1091,14 @@ subroutine cu_c3_driver_run(ntracer,garea,im,km,dt,flag_init,flag_restart,&
 ! Scale dry mixing ratios for water wapor and cloud water to specific humidy / moist mixing ratios
 !
 !$acc kernels
-        qv_spechum = qv/(1.0_kind_phys+qv)
+        new_qv_spechum = qv/(1.0_kind_phys+qv)
         cnvw_moist = cnvw/(1.0_kind_phys+qv)
 !$acc end kernels
+        do i=its,ite
+          do k=kts,kte
+            ten_q(i,k,ntqv) = (new_qv_spechum(i,k) - qv_spechum(i,k))/dt
+          end do
+        end do
 !
 ! Diagnostic tendency updates
 !

physics/CONV/C3/cu_c3_driver.meta

@@ -233,7 +233,7 @@
   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
+  long_name = tendency of the tracers due to vertical diffusion in PBL scheme
   units = kg kg-1 s-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension,number_of_vertical_diffusion_tracers)
   type = real
@@ -249,7 +249,7 @@
   intent = in
   optional = True
 [sigmain]
-  standard_name = prognostic_updraft_area_fraction_in_convection
+  standard_name = physics_timestep_initial_updraft_area_fraction
   long_name = convective updraft area fraction
   units = frac
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
@@ -258,8 +258,8 @@
   intent = in
   optional = True
 [sigmaout]
-  standard_name = updraft_area_fraction_updated_by_physics
-  long_name = convective updraft area fraction updated by physics
+  standard_name = updraft_area_fraction
+  long_name = convective updraft area fraction
   units = frac
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
@@ -315,21 +315,21 @@
   kind = kind_phys
   intent = out
 [qv_spechum]
-  standard_name = specific_humidity_of_new_state
-  long_name = water vapor specific humidity updated by physics
+  standard_name = specific_humidity
+  long_name = water vapor specific humidity
   units = kg kg-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
-  intent = inout
+  intent = in
 [t]
-  standard_name = air_temperature_of_new_state
-  long_name = updated temperature
+  standard_name = air_temperature
+  long_name = air temperature
   units = K
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
-  intent = inout
+  intent = in
 [cld1d]
   standard_name = cloud_work_function
   long_name = cloud work function
@@ -339,23 +339,23 @@
   kind = kind_phys
   intent = out
 [us]
-  standard_name = x_wind_of_new_state
-  long_name = updated x-direction wind
+  standard_name = x_wind
+  long_name = x-direction wind
   units = m s-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
-  intent = inout
+  intent = in
 [vs]
-  standard_name = y_wind_of_new_state
-  long_name = updated y-direction wind
+  standard_name = y_wind
+  long_name = y-direction wind
   units = m s-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
-  intent = inout
+  intent = in
 [t2di]
-  standard_name = air_temperature
+  standard_name = physics_timestep_initial_air_temperature
   long_name = mid-layer temperature
   units = K
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
@@ -371,7 +371,7 @@
   kind = kind_phys
   intent = in
 [qv2di_spechum]
-  standard_name = specific_humidity
+  standard_name = physics_timestep_initial_specific_humidity
   long_name = water vapor specific humidity
   units = kg kg-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
@@ -454,15 +454,15 @@
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
-  intent = inout
+  intent = in
 [clcw]
   standard_name = cloud_condensed_water_mixing_ratio_convective_transport_tracer
   long_name = ratio of mass of cloud water to mass of dry air plus vapor (without condensates) in the convectively transported tracer array
   units = kg kg-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
-  intent = inout
+  intent = in
 [pbl]
   standard_name = atmosphere_boundary_layer_thickness
   long_name = PBL thickness
@@ -737,6 +737,54 @@
   dimensions = ()
   type = integer
   intent = in
+[ten_t]
+  standard_name = tendency_of_air_temperature
+  long_name = tendency of air temperature calculated by one physics scheme
+  units = K s-1
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  type = real
+  kind = kind_phys
+  intent = out
+[ten_u]
+  standard_name = tendency_of_x_wind
+  long_name = tendency of x wind calculated by one physics scheme
+  units = m s-2
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  type = real
+  kind = kind_phys
+  intent = out
+[ten_v]
+  standard_name = tendency_of_y_wind
+  long_name = tendency of y wind calculated by one physics scheme
+  units = m s-2
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  type = real
+  kind = kind_phys
+  intent = out
+[ten_q]
+  standard_name = tendency_of_tracer_concentration
+  long_name = tendency of tracer concentration calculated by one physics scheme
+  units = kg kg-1 s-1
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension,number_of_tracers)
+  type = real
+  kind = kind_phys
+  intent = out
+[dcliw]
+  standard_name = tendency_of_ice_water_mixing_ratio_convective_transport_tracer
+  long_name = tendency of ratio of mass of ice water to mass of dry air plus vapor (without condensates) in the convectively transported tracer array
+  units = kg kg-1 s-1
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  type = real
+  kind = kind_phys
+  intent = out
+[dclcw]
+  standard_name = tendency_of_cloud_condensed_water_mixing_ratio_convective_transport_tracer
+  long_name = tendency of ratio of mass of cloud water to mass of dry air plus vapor (without condensates) in the convectively transported tracer array
+  units = kg kg-1 s-1
+  dimensions = (horizontal_loop_extent,vertical_layer_dimension)
+  type = real
+  kind = kind_phys
+  intent = out
 [errmsg]
   standard_name = ccpp_error_message
   long_name = error message for error handling in CCPP

physics/CONV/C3/cu_c3_driver_post.meta

@@ -22,16 +22,16 @@
   type = integer
   intent = in
 [t]
-  standard_name = air_temperature_of_new_state
-  long_name = temperature updated by physics
+  standard_name = air_temperature
+  long_name = air temperature
   units = K
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
   intent = in
 [q]
-  standard_name = specific_humidity_of_new_state
-  long_name = water vapor specific humidity updated by physics
+  standard_name = specific_humidity
+  long_name = water vapor specific humidity
   units = kg kg-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real

physics/CONV/C3/cu_c3_driver_pre.meta

@@ -45,15 +45,15 @@
   kind = kind_phys
   intent = in
 [t]
-  standard_name = air_temperature
+  standard_name = physics_timestep_initial_air_temperature
   long_name = model layer mean temperature
   units = K
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)
   type = real
   kind = kind_phys
   intent = in
 [q]
-  standard_name = specific_humidity
+  standard_name = physics_timestep_initial_specific_humidity
   long_name = water vapor specific humidity
   units = kg kg-1
   dimensions = (horizontal_loop_extent,vertical_layer_dimension)