scidoc

NCAR · Aug 16, 2024 · 368877c · 368877c
1 parent 9085a24
commit 368877c
Show file tree

Hide file tree

Showing 13 changed files with 267 additions and 227 deletions.
diff --git a/physics/CONV/progsigma_calc.f90 b/physics/CONV/progsigma_calc.f90
@@ -1,5 +1,6 @@
 !>\file progsigma_calc.f90
-!! This file contains the subroutine that calculates the prognostic
+
+!> This module contains the subroutine that calculates the prognostic
 !! updraft area fraction that is used for closure computations in
 !! saSAS deep and shallow convection, based on a moisture budget
 !! as described in Bengtsson et al. 2022 \cite Bengtsson_2022.

diff --git a/physics/GWD/cires_ugwp_initialize.F90 b/physics/GWD/cires_ugwp_initialize.F90
@@ -226,6 +226,7 @@ end module ugwpv0_oro_init
 !  Part -3  init  wave solvers
 !===============================
 
+!> This module contains initialization of wave solvers for UGWP v0
   module ugwpv0_lsatdis_init
      implicit none
 
@@ -271,6 +272,7 @@ end subroutine initsolv_lsatdis_v0
   end module ugwpv0_lsatdis_init
 !
 !
+!>This module contains init-solvers for "broad" non-stationary multi-wave spectra
   module ugwpv0_wmsdis_init
 
     use ugwp_common_v0, only :   pi, pi2

diff --git a/physics/GWD/cires_ugwp_triggers.F90 b/physics/GWD/cires_ugwp_triggers.F90
@@ -1,6 +1,8 @@
 !>\file cires_ugwp_triggers.F90
 !!
 
+!> This module contains routines describing the the latitudinal shape of 
+!! vertical momentum flux function in UGWP v0.
       module cires_ugwp_triggers
       contains
 !

diff --git a/physics/GWD/cires_ugwpv1_initialize.F90 b/physics/GWD/cires_ugwpv1_initialize.F90
@@ -12,7 +12,7 @@
 ! Part-0   specifications of common constants, limiters and "criiical" values
 ! 
 !
-
+!> This module contains common constants, limiters and "critical" values in      
     module ugwp_common
 !
      use machine,  only : kind_phys

diff --git a/physics/GWD/ugwpv1_gsldrag.F90 b/physics/GWD/ugwpv1_gsldrag.F90
@@ -1,5 +1,7 @@
 !>  \file ugwpv1_gsldrag.F90
-!! This introduces two gravity wave drag schemes ugwpv1/CIRES and GSL/drag_suite.F90 under "ugwpv1_gsldrag" suite:
+
+!> This module introduces two gravity wave drag schemes: UGWPv1 and orographic drag scheme 
+!!
 !!      1) The "V1 CIRES UGWP" scheme as tested in the FV3GFSv16-127L atmosphere model and workflow, which includes:
 !!            a) the orograhic gravity wave drag, flow blocking scheme and TOFD (Beljaars et al, 2004).
 !!            b) the v1 CIRE ugwp non-stationary GW scheme, new revision that generate realistic climate of FV3GFS-127L
@@ -33,7 +35,6 @@
 !!       do_ugwp_v1_w_gsldrag -- activates V1 CIRES UGWP scheme with orographic drag of GSL
 !! Note that only one "large-scale" scheme can be activated at a time.
 !!
-
 module ugwpv1_gsldrag
 
     use machine, only: kind_phys

diff --git a/physics/MP/GFDL/GFDL_parse_tracers.F90 b/physics/MP/GFDL/GFDL_parse_tracers.F90
@@ -1,3 +1,7 @@
+!>\file GFDL_parse_tracers.F90
+!!
+
+!> This module contains code to parse tracers in GFDL MP
 module parse_tracers
 
   integer, parameter :: NO_TRACER = -99

diff --git a/physics/Radiation/RRTMG/rrtmg_lw_post.F90 b/physics/Radiation/RRTMG/rrtmg_lw_post.F90
@@ -1,5 +1,6 @@
 !>\file rrtmg_lw_post.F90
-!!This file contains GFS RRTMG scheme post.
+
+!> This module contains code executed after RRTMG-LW scheme
       module rrtmg_lw_post 
       contains
 

diff --git a/physics/Radiation/RRTMG/rrtmg_sw_post.F90 b/physics/Radiation/RRTMG/rrtmg_sw_post.F90
@@ -1,5 +1,6 @@
 !>\file rrtmg_sw_post.F90
-!! This file contains GFS RRTMG scheme post.
+
+!> This module contains RRTMG-SW scheme post
       module rrtmg_sw_post
       contains
 

diff --git a/physics/SFC_Models/Land/Noahmp/module_sf_noahmp_glacier.F90 b/physics/SFC_Models/Land/Noahmp/module_sf_noahmp_glacier.F90
@@ -3,6 +3,8 @@
 !!  This file contains the NoahMP Glacier scheme.
 
 !>\ingroup NoahMP_LSM
+
+!> This module contains the NoahMP Glacier scheme
 module noahmp_glacier_globals
 
   use machine ,   only : kind_phys
@@ -77,6 +79,8 @@ end module noahmp_glacier_globals
 !------------------------------------------------------------------------------------------!
 
 !>\ingroup NoahMP_LSM
+
+!> This module contains NoahMP glacier routines
 module noahmp_glacier_routines
   use noahmp_glacier_globals
 #ifndef CCPP
@@ -3489,6 +3493,7 @@ end subroutine noahmp_options_glacier
 end module noahmp_glacier_routines
 ! ==================================================================================================
 
+!> This module contains the interface of noahmp_glacier_routines and noahmp_glacier_globals
 module module_sf_noahmp_glacier
 
   use noahmp_glacier_routines

diff --git a/physics/SFC_Models/Land/RUC/module_soil_pre.F90 b/physics/SFC_Models/Land/RUC/module_soil_pre.F90
@@ -1,5 +1,6 @@
 !>\file module_soil_pre.F90
-!! This file contains subroutines that initialize RUC LSM levels, soil
+
+!> This module contains subroutines that initialize RUC LSM levels, soil
 !! temperature/moisture.
 module module_soil_pre
 

diff --git a/physics/SFC_Models/Land/RUC/set_soilveg_ruc.F90 b/physics/SFC_Models/Land/RUC/set_soilveg_ruc.F90
@@ -1,7 +1,7 @@
 !>\file set_soilveg_ruc.F90
-!! This file contains subroutine to specify vegetation and soil
-!! parameters for a given soild and land-use classification. 
 
+!> This module contains subroutine to specify vegetation and soil
+!! parameters for a given soild and land-use classification. 
       module set_soilveg_ruc_mod
 
       use machine ,   only : kind_phys