Release 042022 (#184)

* Merge of updates from GFDL Weather and Climate Dynamics Division (202204):

    *add license header to missing files and fix typo in header

    *updates needed for fv3_gfsphysics to have access to bounded_domain

    *remove obsoleted driver/SHiELD files

    *updating to fix bug where long_name and units attributes were not being captured in the RESTARTS

    *remove unused function fv_diagnostics::max_vorticity_hy1

    *remove avec timer remnants

    *adding ability to specify prefix and directory when reading and writing restarts

    *remove old style namelist read in favor of read from internal character variable

    *Added option for a mean wind

    *The planetary radius and rotation rate are now re-scalable by a namelist parameter (small_earth_scale) instead of using exclusively the hard-coded FMS constant.

    *fv_mapz: Cleanup and added helpful annotations to avoid getting lost so easily

    * remove duplicate code and fix lstatus on all grids depending on gfs_data and gfs_data.tile1

    * New idealized tests

    *Makes the non-hydrostatic restart variables optional for reads to allow hydrostatic ICs

    *Fix the hydrostatic TE remapping; Add GMAO cubic for TE remapping, which is used if kord_tm=0 and remap_te=.true.

    *Add a TE remapping option (kord_tm=0)

    *Addressing GNU Warnings

    *Add the L75 vertical config from HAFS

    * clean up fms_mp_mod and remove mp_bcst

CODE_STYLE.md

@@ -70,7 +70,7 @@
 !* (at your option) any later version.
 !*
 !* The FV3 dynamical core is distributed in the hope that it will be
-!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty
+!* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 !* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 !* See the GNU General Public License for more details.
 !*

GFDL_tools/fv_ada_nudge.F90

@@ -10,7 +10,7 @@
 !* (at your option) any later version.
 !*
 !* The FV3 dynamical core is distributed in the hope that it will be
-!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty
+!* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 !* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 !* See the GNU General Public License for more details.
 !*
@@ -262,7 +262,7 @@ module fv_ada_nudge_mod
  contains
 
 
-  subroutine fv_ada_nudge ( Time, dt, npx, npy, npz, ps_dt, u_dt, v_dt, t_dt, q_dt, zvir, ptop, &
+  subroutine fv_ada_nudge ( Time, dt, npx, npy, npz, ps_dt, u_dt, v_dt, t_dt, q_dt, zvir, &
                             ak, bk, ts, ps, delp, ua, va, pt, nwat, q, phis, gridstruct, &
                             bd, domain )
 
@@ -271,7 +271,7 @@ subroutine fv_ada_nudge ( Time, dt, npx, npy, npz, ps_dt, u_dt, v_dt, t_dt, q_dt
   integer,         intent(in):: npz           ! vertical dimension
   integer,         intent(in):: nwat
   real,            intent(in):: dt
-  real,            intent(in):: zvir, ptop
+  real,            intent(in):: zvir
   type(domain2d), intent(INOUT), target :: domain
   type(fv_grid_bounds_type), intent(IN) :: bd
   real, intent(in   ), dimension(npz+1):: ak, bk
@@ -435,7 +435,7 @@ subroutine fv_ada_nudge ( Time, dt, npx, npy, npz, ps_dt, u_dt, v_dt, t_dt, q_dt
 
 
   call get_obs(Time, dt, zvir, ak, bk, ps, ts, ps_obs, delp, pt, nwat, q, u_obs, v_obs, t_obs, q_obs,   &
-               phis, gz_int, ua, va, u_dt, v_dt, npx, npy, npz, factor, mask, ptop, bd, gridstruct, domain)
+               phis, gz_int, ua, va, u_dt, v_dt, npx, npy, npz, factor, mask, bd, gridstruct, domain)
 ! *t_obs* is virtual temperature
 #ifdef ENABLE_ADA ! snz
 
@@ -1269,10 +1269,10 @@ end subroutine compute_slp
 
 
  subroutine get_obs(Time, dt, zvir, ak, bk, ps, ts, ps_obs, delp, pt, nwat, q, u_obs, v_obs, t_obs, q_obs,  &
-                    phis, gz_int, ua, va, u_dt, v_dt, npx, npy, npz, factor, mask, ptop, bd, gridstruct, domain)
+                    phis, gz_int, ua, va, u_dt, v_dt, npx, npy, npz, factor, mask, bd, gridstruct, domain)
   type(time_type), intent(in):: Time
   integer,         intent(in):: npz, nwat, npx, npy
-  real,            intent(in):: zvir, ptop
+  real,            intent(in):: zvir
   real,            intent(in):: dt, factor
   real, intent(in), dimension(npz+1):: ak, bk
   type(fv_grid_bounds_type), intent(IN) :: bd
@@ -1423,26 +1423,26 @@ subroutine get_obs(Time, dt, zvir, ak, bk, ps, ts, ps_obs, delp, pt, nwat, q, u_
   if ( nudge_winds ) then
 
        call remap_uv(npz, ak,  bk, ps(is:ie,js:je), delp,  ut,     vt,   &
-                     km, ps_dat(is:ie,js:je,1),  u_dat(:,:,:,1), v_dat(:,:,:,1), ptop, bd )
+                     km, ps_dat(is:ie,js:je,1),  u_dat(:,:,:,1), v_dat(:,:,:,1), bd )
 
        u_obs(:,:,:) = alpha*ut(:,:,:)
        v_obs(:,:,:) = alpha*vt(:,:,:)
 
        call remap_uv(npz, ak, bk, ps(is:ie,js:je), delp,   ut,      vt,   &
-                     km, ps_dat(is:ie,js:je,2),  u_dat(:,:,:,2), v_dat(:,:,:,2), ptop, bd )
+                     km, ps_dat(is:ie,js:je,2),  u_dat(:,:,:,2), v_dat(:,:,:,2), bd )
 
        u_obs(:,:,:) = u_obs(:,:,:) + beta*ut(:,:,:)
        v_obs(:,:,:) = v_obs(:,:,:) + beta*vt(:,:,:)
   endif
 
        call remap_tq(npz, ak, bk, ps(is:ie,js:je), delp,  ut,  vt,  &
-                     km,  ps_dat(is:ie,js:je,1),  t_dat(:,:,:,1), q_dat(:,:,:,1), zvir, ptop, bd)
+                     km,  ps_dat(is:ie,js:je,1),  t_dat(:,:,:,1), q_dat(:,:,:,1), zvir, bd)
 
        t_obs(:,:,:) = alpha*ut(:,:,:)
        q_obs(:,:,:) = alpha*vt(:,:,:)
 
        call remap_tq(npz, ak, bk, ps(is:ie,js:je), delp,  ut,  vt,  &
-                     km,  ps_dat(is:ie,js:je,2),  t_dat(:,:,:,2), q_dat(:,:,:,2), zvir, ptop, bd)
+                     km,  ps_dat(is:ie,js:je,2),  t_dat(:,:,:,2), q_dat(:,:,:,2), zvir, bd)
 
        t_obs(:,:,:) = t_obs(:,:,:) + beta*ut(:,:,:)
        q_obs(:,:,:) = q_obs(:,:,:) + beta*vt(:,:,:)
@@ -2309,9 +2309,9 @@ end subroutine get_int_hght
 
 
  subroutine remap_tq( npz, ak,  bk,  ps, delp,  t,  q,  &
-                      kmd, ps0, ta, qa, zvir, ptop, bd)
+                      kmd, ps0, ta, qa, zvir, bd)
   integer, intent(in):: npz, kmd
-  real,    intent(in):: zvir, ptop
+  real,    intent(in):: zvir
   real,    intent(in):: ak(npz+1), bk(npz+1)
   type(fv_grid_bounds_type), intent(IN) :: bd
   real,    intent(in), dimension(bd%is:bd%ie,bd%js:bd%je):: ps0
@@ -2373,7 +2373,7 @@ subroutine remap_tq( npz, ak,  bk,  ps, delp,  t,  q,  &
               qp(i,k) = qa(i,j,k)
            enddo
         enddo
-        call mappm(kmd, pe0, qp, npz, pe1, qn1, is,ie, 0, kord_data, ptop)
+        call mappm(kmd, pe0, qp, npz, pe1, qn1, is,ie, 0, kord_data)
         do k=1,npz
            do i=is,ie
               q(i,j,k) = qn1(i,k)
@@ -2388,7 +2388,7 @@ subroutine remap_tq( npz, ak,  bk,  ps, delp,  t,  q,  &
          tp(i,k) = ta(i,j,k)
       enddo
    enddo
-   call mappm(kmd, pn0, tp, npz, pn1, qn1, is,ie, 1, kord_data, ptop)
+   call mappm(kmd, pn0, tp, npz, pn1, qn1, is,ie, 1, kord_data)
 
    do k=1,npz
       do i=is,ie
@@ -2401,9 +2401,8 @@ subroutine remap_tq( npz, ak,  bk,  ps, delp,  t,  q,  &
  end subroutine remap_tq
 
 
- subroutine remap_uv(npz, ak, bk, ps, delp, u, v, kmd, ps0, u0, v0, ptop, bd)
+ subroutine remap_uv(npz, ak, bk, ps, delp, u, v, kmd, ps0, u0, v0, bd)
   integer, intent(in):: npz
-  real,    intent(IN):: ptop
   real,    intent(in):: ak(npz+1), bk(npz+1)
   type(fv_grid_bounds_type), intent(IN) :: bd
   real,    intent(inout):: ps(bd%is:bd%ie,bd%js:bd%je)
@@ -2460,7 +2459,7 @@ subroutine remap_uv(npz, ak, bk, ps, delp, u, v, kmd, ps0, u0, v0, ptop, bd)
             qt(i,k) = u0(i,j,k)
          enddo
       enddo
-      call mappm(kmd, pe0, qt, npz, pe1, qn1, is,ie, -1, kord_data, ptop)
+      call mappm(kmd, pe0, qt, npz, pe1, qn1, is,ie, -1, kord_data)
       do k=1,npz
          do i=is,ie
             u(i,j,k) = qn1(i,k)
@@ -2474,7 +2473,7 @@ subroutine remap_uv(npz, ak, bk, ps, delp, u, v, kmd, ps0, u0, v0, ptop, bd)
             qt(i,k) = v0(i,j,k)
          enddo
       enddo
-      call mappm(kmd, pe0, qt, npz, pe1, qn1, is,ie, -1, kord_data, ptop)
+      call mappm(kmd, pe0, qt, npz, pe1, qn1, is,ie, -1, kord_data)
       do k=1,npz
          do i=is,ie
             v(i,j,k) = qn1(i,k)
@@ -2516,14 +2515,34 @@ subroutine fv_ada_nudge_end
        call fv_io_register_axis(ada_driver_restart, numx=1, numy=1, numz=1, zsize=(/size(Atm_var%u_adj,3)/))
        call register_restart_field(ada_driver_restart, &
             & "u_adj", Atm_var%u_adj(:,:,:), dim_names_4d)
+       call register_variable_attribute(ada_driver_restart, &
+            & "u_adj", "long_name", "u_adj", str_len=len("u_adj"))
+       call register_variable_attribute(ada_driver_restart, &
+            & "u_adj", "units", "none", str_len=len("none"))
        call register_restart_field(ada_driver_restart, &
             & "v_adj", Atm_var%v_adj(:,:,:), dim_names_4d)
+       call register_variable_attribute(ada_driver_restart, &
+            & "v_adj", "long_name", "v_adj", str_len=len("v_adj"))
+       call register_variable_attribute(ada_driver_restart, &
+            & "v_adj", "units", "none", str_len=len("none"))
        call register_restart_field(ada_driver_restart, &
             & "t_adj", Atm_var%t_adj(:,:,:), dim_names_4d)
+       call register_variable_attribute(ada_driver_restart, &
+            & "t_adj", "long_name", "t_adj", str_len=len("t_adj"))
+       call register_variable_attribute(ada_driver_restart, &
+            & "t_adj", "units", "none", str_len=len("none"))
        call register_restart_field(ada_driver_restart, &
             & "q_adj", Atm_var%q_adj(:,:,:), dim_names_4d)
+       call register_variable_attribute(ada_driver_restart, &
+            & "q_adj", "long_name", "q_adj", str_len=len("q_adj"))
+       call register_variable_attribute(ada_driver_restart, &
+            & "q_adj", "units", "none", str_len=len("none"))
        call register_restart_field(ada_driver_restart, &
             & "ps_adj", Atm_var%ps_adj(:,:), dim_names_4d)
+       call register_variable_attribute(ada_driver_restart, &
+            & "ps_adj", "long_name", "ps_adj", str_len=len("ps_adj"))
+       call register_variable_attribute(ada_driver_restart, &
+            & "ps_adj", "units", "none", str_len=len("none"))
        call write_restart(ada_driver_restart)
        call close_file(ada_driver_restart)
     endif

GFDL_tools/fv_climate_nudge.F90

@@ -10,7 +10,7 @@
 !* (at your option) any later version.
 !*
 !* The FV3 dynamical core is distributed in the hope that it will be
-!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty
+!* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 !* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 !* See the GNU General Public License for more details.
 !*
@@ -262,12 +262,11 @@ end subroutine fv_climate_nudge_init
 !###################################################################################
 
 subroutine fv_climate_nudge (Time, dt, is, ie, js, je, npz, pfull, &
-                                   lon, lat, phis, ptop, ak, bk,        &
+                                   lon, lat, phis, ak, bk,        &
                                    ps, u, v, t, q, psdt, udt, vdt, tdt, qdt )
 type(time_type), intent(in) :: Time
 real,            intent(in) :: dt
 integer,         intent(in) :: is, ie, js, je, npz
-real,            intent(IN) :: ptop
 
 real, intent(in)    :: phis(is:ie,js:je)
 real, intent(in)    :: lon (is:ie,js:je)
@@ -439,15 +438,15 @@ subroutine fv_climate_nudge (Time, dt, is, ie, js, je, npz, pfull, &
           enddo
 
           if (get_wind) then
-             call remap_3d (is, ie, js, je, nlev_obs, npz, phaf_obs, u_obs, phaf, State(n)%u, -1, ptop)
-             call remap_3d (is, ie, js, je, nlev_obs, npz, phaf_obs, v_obs, phaf, State(n)%v, -1, ptop)
+             call remap_3d (is, ie, js, je, nlev_obs, npz, phaf_obs, u_obs, phaf, State(n)%u, -1)
+             call remap_3d (is, ie, js, je, nlev_obs, npz, phaf_obs, v_obs, phaf, State(n)%v, -1)
           endif
           if (get_qhum .or. get_temp) then
-             call remap_3d (is, ie, js, je, nlev_obs, npz, phaf_obs, q_obs, phaf, State(n)%q(:,:,:,1), 0, ptop)
+             call remap_3d (is, ie, js, je, nlev_obs, npz, phaf_obs, q_obs, phaf, State(n)%q(:,:,:,1), 0)
           endif
           if (get_temp) then
              ! use logp
-             call remap_3d (is, ie, js, je, nlev_obs, npz, lphaf_obs, t_obs, lphaf, State(n)%t, 1, ptop)
+             call remap_3d (is, ie, js, je, nlev_obs, npz, lphaf_obs, t_obs, lphaf, State(n)%t, 1)
              State(n)%t = State(n)%t/(1.+ZVIR*State(n)%q(:,:,:,1)) ! virtual effect
           endif
 
@@ -1023,7 +1022,7 @@ end subroutine remap_ps
 !---------------------------------------------------
 
   subroutine remap_3d( is, ie, js, je, km, npz, &
-                       pe0, qn0, pe1, qn1, n, ptop )
+                       pe0, qn0, pe1, qn1, n )
 
 !--------
 ! Input:
@@ -1035,7 +1034,6 @@ subroutine remap_3d( is, ie, js, je, km, npz, &
     real,  intent(in):: qn0(is:ie,js:je,km)    ! scalar quantity on input data levels
     real,  intent(in):: pe1(is:ie,js:je,npz+1) ! pressure at layer interfaces for model data
   integer, intent(in):: n                      ! -1 wind; 0 sphum; +1 ptemp
-    real,  intent(IN):: ptop
 
 !--------
 ! Output:
@@ -1046,7 +1044,7 @@ subroutine remap_3d( is, ie, js, je, km, npz, &
   integer :: i, j, k
 
     do j = js,je
-       call mappm(km, pe0(is:ie,j,:), qn0(is:ie,j,:), npz, pe1(is:ie,j,:), qn1(is:ie,j,:), is,ie, n, 8, ptop)
+       call mappm(km, pe0(is:ie,j,:), qn0(is:ie,j,:), npz, pe1(is:ie,j,:), qn1(is:ie,j,:), is,ie, n, 8)
     enddo
 
   end subroutine remap_3d

GFDL_tools/fv_cmip_diag.F90

@@ -10,7 +10,7 @@
 !* (at your option) any later version.
 !*
 !* The FV3 dynamical core is distributed in the hope that it will be
-!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty
+!* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 !* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 !* See the GNU General Public License for more details.
 !*

GFDL_tools/read_climate_nudge_data.F90

@@ -11,7 +11,7 @@
 !* (at your option) any later version.
 !*
 !* The FV3 dynamical core is distributed in the hope that it will be
-!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty
+!* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 !* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 !* See the GNU General Public License for more details.
 !*

README.md

@@ -1,6 +1,6 @@
 # GFDL_atmos_cubed_sphere
 
-The source contained herein reflects the 202107 release of the Finite Volume Cubed-Sphere Dynamical Core (FV3) from GFDL
+The source contained herein reflects the 202204 release of the Finite Volume Cubed-Sphere Dynamical Core (FV3) from GFDL
 
 The GFDL Microphysics is also available within this repository.
 

RELEASE.md

@@ -1,3 +1,27 @@
+# RELEASE NOTES for FV3 202204: Summary
+FV3-202204-public --- April 2022
+Lucas Harris, GFDL [email protected]
+
+This version has been tested against the current SHiELD physics
+and with FMS release 2022.01 from https://github.com/NOAA-GFDL/FMS
+
+This release includes the following:
+- Release of stand-alone solo_core functionality with simple physics.
+- Updated GFDL Microphysics, used for real-time 2021 C-SHiELD and T-SHiELD.  (L Zhou)
+- Merges numerous updates from dev/emc.
+- Leverage DA functionality from UFS with additional changes (M Tong).
+- Updates to use the latest FMS release, including fms2_io.
+- Adds license header to missing files and fixes typo in header.
+- Fixes a bug where long_name and units attributes were not being captured in restart files.
+- Adds the ability to specify prefix and directory when reading and writing restarts.
+- The planetary radius and rotation rate are now re-scalable by a namelist parameter (small_earth_scale) instead of using exclusively the hard-coded FMS constant.
+- Removes obsolete driver/SHiELD files.
+- Removes unused function fv_diagnostics::max_vorticity_hy1.
+- Removes avec timer remnants.
+- Removes old style namelist read in favor of read from internal character variable.
+- Adds option for a mean wind.
+- Addresses GNU warnings.
+
 
 # RELEASE NOTES for FV3 202107: Summary
 

driver/GFDL/atmosphere.F90

@@ -10,7 +10,7 @@
 !* (at your option) any later version.
 !*
 !* The FV3 dynamical core is distributed in the hope that it will be
-!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty
+!* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 !* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 !* See the GNU General Public License for more details.
 !*