CCPP v6.0.0 SciDoc updates

physics/GFS_DCNV_generic_post.F90

@@ -148,5 +148,4 @@ subroutine GFS_DCNV_generic_post_run (im, levs, lssav, ldiag3d, qdiag3d, ras, &
       endif ! if (lssav)
 
     end subroutine GFS_DCNV_generic_post_run
-
     end module GFS_DCNV_generic_post

physics/GFS_GWD_generic_pre.F90

@@ -6,12 +6,10 @@ module GFS_GWD_generic_pre
 
 contains
 
-!! \section arg_table_GFS_GWD_generic_pre_run Argument Table
+!> \section arg_table_GFS_GWD_generic_pre_run Argument Table
 !! \htmlinclude GFS_GWD_generic_pre_run.html
 !!
-!!  \section general General Algorithm
-!!  \section detailed Detailed Algorithm
-!!  @{
+!!  \section gfs_gwd_ge_pre_ga General Algorithm
       subroutine GFS_GWD_generic_pre_run(                               &
      &           im, levs, nmtvr, mntvar,                               &
      &           oc, oa4, clx, theta,                                   &
@@ -136,6 +134,5 @@ subroutine GFS_GWD_generic_pre_run(                               &
       endif
 
       end subroutine GFS_GWD_generic_pre_run
-!> @}
 
-end module GFS_GWD_generic_pre
+end module GFS_GWD_generic_pre

physics/GFS_MP_generic_post.F90

@@ -13,7 +13,7 @@ module GFS_MP_generic_post
 !! will be called.  the tallies are then summed in calwxt_dominant(). For GFDL cloud MP scheme, determine convective 
 !! rain/snow by surface temperature;  and determine explicit rain/snow by rain/snow coming out directly from MP.
 !! 
-!! \section arg_table_GFS_MP_generic_post_run Argument Table
+!> \section arg_table_GFS_MP_generic_post_run Argument Table
 !! \htmlinclude GFS_MP_generic_post_run.html
 !!
 !> \section gfs_mp_gen GFS MP Generic Post General Algorithm

physics/GFS_cloud_diagnostics.F90

@@ -1,8 +1,6 @@
-! ########################################################################################
-! This module contains code to produce the UFS High/Mid/Low cloud-diagnostics. 
-! This was bundled together with the prognostic cloud modules within the RRTMG implementation.
-! For the RRTMGP implementation we propose to keep these diagnostics independent.
-! ########################################################################################
+!>\file GFS_cloud_diagnostics.F90
+!!
+
 module GFS_cloud_diagnostics
   use machine,                 only: kind_phys
   use physparam,               only: icldflg
@@ -29,14 +27,13 @@ module GFS_cloud_diagnostics
   public GFS_cloud_diagnostics_run, GFS_cloud_diagnostics_init,&
        GFS_cloud_diagnostics_finalize, hml_cloud_diagnostics_init
 contains
-  ! ######################################################################################
-  ! ######################################################################################
-  subroutine GFS_cloud_diagnostics_init()
-  end subroutine GFS_cloud_diagnostics_init
-
-  ! ######################################################################################
-  ! ######################################################################################
-!! \section arg_table_GFS_cloud_diagnostics_run
+
+!>\defgroup gfs_cloud_diagnostics_mod GFS Cloud Diagnostics Module
+!> This module contains code to produce the UFS High/Mid/Low cloud-diagnostics.
+!! This was bundled together with the prognostic cloud modules within the RRTMG implementation.
+!! For the RRTMGP implementation we propose to keep these diagnostics independent.
+!> @{
+!> \section arg_table_GFS_cloud_diagnostics_run
 !! \htmlinclude GFS_cloud_diagnostics_run.html
 !!  
   subroutine GFS_cloud_diagnostics_run(nCol, nLev, iovr_rand, iovr_maxrand, iovr_max,    & 
@@ -118,13 +115,5 @@ subroutine GFS_cloud_diagnostics_run(nCol, nLev, iovr_rand, iovr_maxrand, iovr_m
          iovr_exprand, cldsa, mtopa, mbota)	
 
   end subroutine GFS_cloud_diagnostics_run
-
-  ! ######################################################################################
-  ! ######################################################################################
-  subroutine GFS_cloud_diagnostics_finalize()
-  end subroutine GFS_cloud_diagnostics_finalize
-
-  ! ######################################################################################
-  ! Subroutine hml_cloud_diagnostics_initialize is removed (refer to GFS_rrtmgp_setup.F90) 
-  ! ######################################################################################
+!> @}
 end module GFS_cloud_diagnostics

physics/GFS_phys_time_vary.fv3.F90

@@ -4,7 +4,6 @@
 !>\defgroup mod_GFS_phys_time_vary GFS Physics Time Update
 !! This module contains GFS physics time vary subroutines including ozone, stratospheric water vapor,
 !! aerosol, IN&CCN and surface properties updates.
-!> @{
    module GFS_phys_time_vary
 
 #ifdef _OPENMP
@@ -65,7 +64,7 @@ module GFS_phys_time_vary
 !! \htmlinclude GFS_phys_time_vary_init.html
 !!
 !>\section gen_GFS_phys_time_vary_init GFS_phys_time_vary_init General Algorithm
-!! @{
+!> @{
       subroutine GFS_phys_time_vary_init (                                                         &
               me, master, ntoz, h2o_phys, iaerclm, iccn, iflip, im, nx, ny, idate, xlat_d, xlon_d, &
               jindx1_o3, jindx2_o3, ddy_o3, ozpl, jindx1_h, jindx2_h, ddy_h, h2opl,fhour,          &
@@ -705,13 +704,13 @@ function find_eq_smc(bexp, dwsat, dksat, ddz, smcmax) result(smc)
          end function find_eq_smc
 
       end subroutine GFS_phys_time_vary_init
-!! @}
+!> @}
 
 !> \section arg_table_GFS_phys_time_vary_timestep_init Argument Table
 !! \htmlinclude GFS_phys_time_vary_timestep_init.html
 !!
 !>\section gen_GFS_phys_time_vary_timestep_init GFS_phys_time_vary_timestep_init General Algorithm
-!! @{
+!> @{
       subroutine GFS_phys_time_vary_timestep_init (                                                 &
             me, master, cnx, cny, isc, jsc, nrcm, im, levs, kdt, idate, nsswr, fhswr, lsswr, fhour, &
             imfdeepcnv, cal_pre, random_clds, nscyc, ntoz, h2o_phys, iaerclm, iccn, clstp,          &
@@ -910,13 +909,13 @@ subroutine GFS_phys_time_vary_timestep_init (
          endif
 
       end subroutine GFS_phys_time_vary_timestep_init
-!! @}
+!> @}
 
 !> \section arg_table_GFS_phys_time_vary_timestep_finalize Argument Table
 !! \htmlinclude GFS_phys_time_vary_timestep_finalize.html
 !!
 !>\section gen_GFS_phys_time_vary_timestep_finalize GFS_phys_time_vary_timestep_finalize General Algorithm
-!! @{
+!> @{
       subroutine GFS_phys_time_vary_timestep_finalize (errmsg, errflg)
 
          implicit none
@@ -930,7 +929,7 @@ subroutine GFS_phys_time_vary_timestep_finalize (errmsg, errflg)
          errflg = 0
 
       end subroutine GFS_phys_time_vary_timestep_finalize
-!! @}
+!> @}
 
 !> \section arg_table_GFS_phys_time_vary_finalize Argument Table
 !! \htmlinclude GFS_phys_time_vary_finalize.html
@@ -980,4 +979,3 @@ subroutine GFS_phys_time_vary_finalize(errmsg, errflg)
       end subroutine GFS_phys_time_vary_finalize
 
    end module GFS_phys_time_vary
-!> @}

physics/GFS_rad_time_vary.fv3.F90

@@ -1,5 +1,5 @@
 !>\file GFS_rad_time_vary.fv3.F90
-!!  Contains code related to GFS physics suite setup (radiation part of time_vary_step)
+!!  Contains code related to GFS radiation suite setup (radiation part of time_vary_step)
    module GFS_rad_time_vary
 
       implicit none
@@ -11,6 +11,7 @@ module GFS_rad_time_vary
       contains
 
 !>\defgroup mod_GFS_rad_time_vary GFS Radiation Time Update
+!! This module contains code related to GFS radiation setup.
 !> @{
 !> \section arg_table_GFS_rad_time_vary_timestep_init Argument Table
 !! \htmlinclude GFS_rad_time_vary_timestep_init.html

physics/GFS_radiation_surface.F90

@@ -1,15 +1,19 @@
-!>\file GFS_radiation_surface.f90
+!>\file GFS_radiation_surface.F90
 !! This file contains calls to module_radiation_surface::setemis() to set up
 !! surface emissivity for LW radiation and to module_radiation_surface::setalb()
 !! to set up surface albedo for SW radiation.
+
       module GFS_radiation_surface
 
       use machine,                   only: kind_phys
 
       contains
 
-!>\defgroup GFS_radiation_surface GFS radiation surface
-!! @{
+!>\defgroup GFS_radiation_surface_mod GFS Radiation Surface Module
+!! This module contains calls to module_radiation_surface::setemis() to set up
+!! surface emissivity for LW radiation and to module_radiation_surface::setalb()
+!! to set up surface albedo for SW radiation.
+!> @{
 !> \section arg_table_GFS_radiation_surface_init Argument Table
 !! \htmlinclude GFS_radiation_surface_init.html
 !!
@@ -189,7 +193,5 @@ subroutine GFS_radiation_surface_run (                            &
 
       end subroutine GFS_radiation_surface_run
 
-       subroutine GFS_radiation_surface_finalize ()
-       end subroutine GFS_radiation_surface_finalize
-!! @}
+!> @}
        end module GFS_radiation_surface

physics/GFS_rrtmg_post.F90

@@ -1,15 +1,20 @@
-!>\file GFS_rrtmg_post.f90
-!! This file contains
+!>\file GFS_rrtmg_post.F90
+!! This file contains the calculation of time averaged output quantities (including total-sky and
+!! clear-sky SW and LW fluxes at TOA and surface; conventional
+!! 3-domain cloud amount, cloud top and base pressure, and cloud top
+!! temperature; aerosols AOD, etc.), store computed results in
+!! corresponding slots of array fluxr with appropriate time weights. 
 
-!>\defgroup GFS_rrtmg_post_mod GFS RRTMG Scheme Post
        module GFS_rrtmg_post
        contains
 
-!> \section arg_table_GFS_rrtmg_post_init Argument Table
-!!
-       subroutine GFS_rrtmg_post_init ()
-       end subroutine GFS_rrtmg_post_init
-
+!>\defgroup GFS_rrtmg_post_mod GFS RRTMG Scheme Post
+!! This module calculate time averaged output quantities (including total-sky and
+!! clear-sky SW and LW fluxes at TOA and surface; conventional
+!! 3-domain cloud amount, cloud top and base pressure, and cloud top
+!! temperature; aerosols AOD, etc.), store computed results in
+!! corresponding slots of array fluxr with appropriate time weights.
+!> @{
 !> \section arg_table_GFS_rrtmg_post_run Argument Table
 !! \htmlinclude GFS_rrtmg_post_run.html
 !!
@@ -66,11 +71,11 @@ subroutine GFS_rrtmg_post_run (im, km, kmp1, lm, ltp, kt, kb, kd, nspc1, &
 
       if (.not. (lsswr .or. lslwr)) return
 
-!>  - For time averaged output quantities (including total-sky and
-!!    clear-sky SW and LW fluxes at TOA and surface; conventional
-!!    3-domain cloud amount, cloud top and base pressure, and cloud top
-!!    temperature; aerosols AOD, etc.), store computed results in
-!!    corresponding slots of array fluxr with appropriate time weights.
+!  - For time averaged output quantities (including total-sky and
+!    clear-sky SW and LW fluxes at TOA and surface; conventional
+!    3-domain cloud amount, cloud top and base pressure, and cloud top
+!    temperature; aerosols AOD, etc.), store computed results in
+!    corresponding slots of array fluxr with appropriate time weights.
 
 !  --- ...  collect the fluxr data for wrtsfc
 
@@ -205,8 +210,5 @@ subroutine GFS_rrtmg_post_run (im, km, kmp1, lm, ltp, kt, kb, kd, nspc1, &
       endif
 !
       end subroutine GFS_rrtmg_post_run
-
-      subroutine GFS_rrtmg_post_finalize ()
-      end subroutine GFS_rrtmg_post_finalize
-
+!> @}
       end module GFS_rrtmg_post