Merge pull request #342 from grantfirl/gwd_interstitial_reorg

GWD interstitial reorganization

Author: grantfirl

physics/GFS_GWD_generic.F90

@@ -6,8 +6,6 @@ module GFS_GWD_generic_pre
 
 contains
 
-!> \section arg_table_GFS_GWD_generic_pre_init Argument Table
-!!
       subroutine GFS_GWD_generic_pre_init()
       end subroutine GFS_GWD_generic_pre_init
 
@@ -105,12 +103,64 @@ subroutine GFS_GWD_generic_pre_run(                               &
       end subroutine GFS_GWD_generic_pre_run
 !> @}
 
-! \ingroup GFS_ogwd
-! \brief Brief description of the subroutine
-!
-!> \section arg_table_GFS_GWD_generic_pre_finalize Argument Table
-!!
       subroutine GFS_GWD_generic_pre_finalize()
       end subroutine GFS_GWD_generic_pre_finalize
 
 end module GFS_GWD_generic_pre
+
+!> This module contains the CCPP-compliant orographic gravity wave drag post
+!! interstitial codes.
+module GFS_GWD_generic_post
+
+contains
+
+
+      subroutine GFS_GWD_generic_post_init()
+      end subroutine GFS_GWD_generic_post_init
+
+!! \section arg_table_GFS_GWD_generic_post_run Argument Table
+!! \htmlinclude GFS_GWD_generic_post_run.html
+!!
+!!  \section general General Algorithm
+!!  \section detailed Detailed Algorithm
+!!  @{
+      subroutine GFS_GWD_generic_post_run(lssav, ldiag3d, dtf, dusfcg, dvsfcg, dudt, dvdt, dtdt,          &
+      &  dugwd, dvgwd, du3dt, dv3dt, dt3dt, errmsg, errflg)
+
+      use machine, only : kind_phys
+      implicit none
+      
+      logical, intent(in) :: lssav, ldiag3d
+      
+      real(kind=kind_phys), intent(in) :: dusfcg(:), dvsfcg(:)
+      real(kind=kind_phys), intent(in) :: dudt(:,:), dvdt(:,:), dtdt(:,:)
+      real(kind=kind_phys), intent(in) :: dtf
+      
+      real(kind=kind_phys), intent(inout) :: dugwd(:), dvgwd(:)
+      real(kind=kind_phys), intent(inout) :: du3dt(:,:), dv3dt(:,:), dt3dt(:,:)
+      
+      character(len=*), intent(out) :: errmsg
+      integer,          intent(out) :: errflg
+
+      ! Initialize CCPP error handling variables
+      errmsg = ''
+      errflg = 0
+
+      if (lssav) then
+        dugwd(:) = dugwd(:) + dusfcg(:)*dtf
+        dvgwd(:) = dvgwd(:) + dvsfcg(:)*dtf
+
+        if (ldiag3d) then
+          du3dt(:,:) = du3dt(:,:) + dudt(:,:) * dtf
+          dv3dt(:,:) = dv3dt(:,:) + dvdt(:,:) * dtf
+          dt3dt(:,:) = dt3dt(:,:) + dtdt(:,:) * dtf
+        endif
+      endif
+
+    end subroutine GFS_GWD_generic_post_run
+!> @}
+    
+    subroutine GFS_GWD_generic_post_finalize()
+    end subroutine GFS_GWD_generic_post_finalize
+
+end module GFS_GWD_generic_post

physics/GFS_GWD_generic.meta

@@ -167,3 +167,140 @@
 [ccpp-arg-table]
   name = GFS_GWD_generic_pre_finalize
   type = scheme
+  
+########################################################################
+[ccpp-arg-table]
+  name = GFS_GWD_generic_post_run
+  type = scheme
+[lssav]
+  standard_name = flag_diagnostics
+  long_name = flag for calculating diagnostic fields
+  units = flag
+  dimensions = ()
+  type = logical
+  intent = in
+  optional = F
+[ldiag3d]
+  standard_name = flag_diagnostics_3D
+  long_name = flag for calculating 3-D diagnostic fields
+  units = flag
+  dimensions = ()
+  type = logical
+  intent = in
+  optional = F
+[dtf]
+  standard_name = time_step_for_dynamics
+  long_name = dynamics time step
+  units = s
+  dimensions = ()
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[dusfcg]
+  standard_name = instantaneous_x_stress_due_to_gravity_wave_drag
+  long_name = zonal surface stress due to orographic gravity wave drag
+  units = Pa
+  dimensions = (horizontal_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[dvsfcg]
+  standard_name = instantaneous_y_stress_due_to_gravity_wave_drag
+  long_name = meridional surface stress due to orographic gravity wave drag
+  units = Pa
+  dimensions = (horizontal_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[dudt]
+  standard_name = tendency_of_x_wind_due_to_model_physics
+  long_name = zonal wind tendency due to model physics
+  units = m s-2
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[dvdt]
+  standard_name = tendency_of_y_wind_due_to_model_physics
+  long_name = meridional wind tendency due to model physics
+  units = m s-2
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[dtdt]
+  standard_name = tendency_of_air_temperature_due_to_model_physics
+  long_name = air temperature tendency due to model physics
+  units = K s-1
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = in
+  optional = F
+[dugwd]
+  standard_name = time_integral_of_x_stress_due_to_gravity_wave_drag
+  long_name = integral over time of zonal stress due to gravity wave drag
+  units = Pa s
+  dimensions = (horizontal_dimension)
+  type = real
+  kind = kind_phys
+  intent = inout
+  optional = F
+[dvgwd]
+  standard_name = time_integral_of_y_stress_due_to_gravity_wave_drag
+  long_name = integral over time of meridional stress due to gravity wave drag
+  units = Pa s
+  dimensions = (horizontal_dimension)
+  type = real
+  kind = kind_phys
+  intent = inout
+  optional = F
+[du3dt]
+  standard_name = cumulative_change_in_x_wind_due_to_orographic_gravity_wave_drag
+  long_name = cumulative change in zonal wind due to orographic gravity wave drag
+  units = m s-1
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = inout
+  optional = F
+[dv3dt]
+  standard_name = cumulative_change_in_y_wind_due_to_orographic_gravity_wave_drag
+  long_name = cumulative change in meridional wind due to orographic gravity wave drag
+  units = m s-1
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = inout
+  optional = F
+[dt3dt]
+  standard_name = cumulative_change_in_temperature_due_to_orographic_gravity_wave_drag
+  long_name = cumulative change in temperature due to orographic gravity wave drag
+  units = K
+  dimensions = (horizontal_dimension,vertical_dimension)
+  type = real
+  kind = kind_phys
+  intent = inout
+  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/cires_ugwp_post.F90

@@ -25,8 +25,8 @@ subroutine cires_ugwp_post_run (ldiag_ugwp, dtf, im, levs,     &
          tot_zmtb, tot_zlwb, tot_zogw,                              &
          tot_tofd, tot_mtb, tot_ogw, tot_ngw,                       &
          du3dt_mtb,du3dt_ogw, du3dt_tms, du3dt_ngw, dv3dt_ngw,      &
-         dtdt, dudt, dvdt, lssav, ldiag3d, dusfcg, dvsfcg, dugwd,   &
-         dvgwd, du3dt, dv3dt, dt3dt, errmsg, errflg)
+         dtdt, dudt, dvdt,     &
+         errmsg, errflg)
 
         use machine,                only: kind_phys
 
@@ -45,12 +45,6 @@ subroutine cires_ugwp_post_run (ldiag_ugwp, dtf, im, levs,     &
         real(kind=kind_phys), intent(inout), dimension(:,:) :: du3dt_mtb, du3dt_ogw, du3dt_tms, du3dt_ngw, dv3dt_ngw
         real(kind=kind_phys), intent(inout), dimension(:,:) :: dtdt, dudt, dvdt
 
-        ! For if (lssav) block, originally in gwdps_post_run
-        logical, intent(in) :: lssav, ldiag3d
-        real(kind=kind_phys), intent(in),    dimension(:)   :: dusfcg, dvsfcg
-        real(kind=kind_phys), intent(inout), dimension(:)   :: dugwd, dvgwd
-        real(kind=kind_phys), intent(inout), dimension(:,:) :: du3dt, dv3dt, dt3dt
-
         character(len=*),        intent(out) :: errmsg
         integer,                 intent(out) :: errflg
 
@@ -79,18 +73,6 @@ subroutine cires_ugwp_post_run (ldiag_ugwp, dtf, im, levs,     &
         dudt = dudt + gw_dudt
         dvdt = dvdt + gw_dvdt
 
-        ! Originally in gwdps_post_run
-        if (lssav) then
-          dugwd(:) = dugwd(:) + dusfcg(:)*dtf
-          dvgwd(:) = dvgwd(:) + dvsfcg(:)*dtf
-
-          if (ldiag3d) then
-            du3dt(:,:) = du3dt(:,:) + dudt(:,:) * dtf
-            dv3dt(:,:) = dv3dt(:,:) + dvdt(:,:) * dtf
-            dt3dt(:,:) = dt3dt(:,:) + dtdt(:,:) * dtf
-          endif
-        endif
-
       end subroutine cires_ugwp_post_run
 
 !> \section arg_table_cires_ugwp_post_finalize Argument Table

physics/cires_ugwp_post.meta

@@ -291,85 +291,6 @@
   kind = kind_phys
   intent = inout
   optional = F
-[lssav]
-  standard_name = flag_diagnostics
-  long_name = flag for calculating diagnostic fields
-  units = flag
-  dimensions = ()
-  type = logical
-  intent = in
-  optional = F
-[ldiag3d]
-  standard_name = flag_diagnostics_3D
-  long_name = flag for calculating 3-D diagnostic fields
-  units = flag
-  dimensions = ()
-  type = logical
-  intent = in
-  optional = F
-[dusfcg]
-  standard_name = instantaneous_x_stress_due_to_gravity_wave_drag
-  long_name = zonal surface stress due to orographic gravity wave drag
-  units = Pa
-  dimensions = (horizontal_dimension)
-  type = real
-  kind = kind_phys
-  intent = in
-  optional = F
-[dvsfcg]
-  standard_name = instantaneous_y_stress_due_to_gravity_wave_drag
-  long_name = meridional surface stress due to orographic gravity wave drag
-  units = Pa
-  dimensions = (horizontal_dimension)
-  type = real
-  kind = kind_phys
-  intent = in
-  optional = F
-[dugwd]
-  standard_name = time_integral_of_x_stress_due_to_gravity_wave_drag
-  long_name = integral over time of zonal stress due to gravity wave drag
-  units = Pa s
-  dimensions = (horizontal_dimension)
-  type = real
-  kind = kind_phys
-  intent = inout
-  optional = F
-[dvgwd]
-  standard_name = time_integral_of_y_stress_due_to_gravity_wave_drag
-  long_name = integral over time of meridional stress due to gravity wave drag
-  units = Pa s
-  dimensions = (horizontal_dimension)
-  type = real
-  kind = kind_phys
-  intent = inout
-  optional = F
-[du3dt]
-  standard_name = cumulative_change_in_x_wind_due_to_orographic_gravity_wave_drag
-  long_name = cumulative change in zonal wind due to orographic gravity wave drag
-  units = m s-1
-  dimensions = (horizontal_dimension,vertical_dimension)
-  type = real
-  kind = kind_phys
-  intent = inout
-  optional = F
-[dv3dt]
-  standard_name = cumulative_change_in_y_wind_due_to_orographic_gravity_wave_drag
-  long_name = cumulative change in meridional wind due to orographic gravity wave drag
-  units = m s-1
-  dimensions = (horizontal_dimension,vertical_dimension)
-  type = real
-  kind = kind_phys
-  intent = inout
-  optional = F
-[dt3dt]
-  standard_name = cumulative_change_in_temperature_due_to_orographic_gravity_wave_drag
-  long_name = cumulative change in temperature due to orographic gravity wave drag
-  units = K
-  dimensions = (horizontal_dimension,vertical_dimension)
-  type = real
-  kind = kind_phys
-  intent = inout
-  optional = F
 [errmsg]
   standard_name = ccpp_error_message
   long_name = error message for error handling in CCPP