Merge pull request #273 from grantfirl/ccppv3_scidoc

Ccppv3 scidoc
NCAR · Jun 17, 2019 · 4cd98fa · 4cd98fa
2 parents cf371b2 + cff5608
commit 4cd98fa
Show file tree

Hide file tree

Showing 57 changed files with 1,613 additions and 2,090 deletions.
diff --git a/physics/GFS_MP_generic.F90 b/physics/GFS_MP_generic.F90
@@ -84,7 +84,7 @@ module GFS_MP_generic_post
       subroutine GFS_MP_generic_post_init
       end subroutine GFS_MP_generic_post_init
 
-!>\defgroup gfs_calpreciptype GFS/GFDL calpreciptype Main
+!>\defgroup gfs_calpreciptype GFS Precipitation Type Diagnostics Module
 !! \brief If dominant precip type is requested (i.e., Zhao-Carr MP scheme), 4 more algorithms in calpreciptype()
 !! 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.

diff --git a/physics/aer_cloud.F b/physics/aer_cloud.F
@@ -158,10 +158,6 @@ end subroutine aer_cloud_init
 !!\param dpre_in          mass-weighted diameter of prexisting ice crystals (m)
 !!\param ccn_diagr8       array of supersaturations for CCN diagnostics (in-out)
 !!\param Ndropr8          Current droplet number concentration (\f$Kg^{-1}\f$)
-!!\param qc               Liquid water mixing ratio (Kg/Kg)
-!!\param use_average_v    .false. integrate over the updraft distribution. True: use the mean vertical velocity
-!!\param CCN_param        CCN activation parameterization. 1- Fountoukis and Nenes (2005), 2-Abdul_Razzak and Ghan (2002) (def = 2)
-!!\param IN_param         IN activation spectrum (default is 5)
 !!\param cdncr8           Activated cloud droplet number concentration (Kg-1)
 !!\param smaxliqr8        Maximum supersaturation w.r.t liquid during droplet activation
 !!\param incr8            Nucleated ice crystal concentration (Kg-1)
@@ -172,14 +168,20 @@ end subroutine aer_cloud_init
 !!\param Ncdepr8          Nucleated nc by deposition ice nucleation (Kg-1)
 !!\param Ncdhfr8          Nucleated nc by immersion in aerosol (Kg -1)
 !!\param sc_icer8         Critical saturation ratio in cirrus
-!!\param fdust_depr8      Fraction of deposition ice nuclei that are dust
 !!\param fdust_immr8      Fraction of immersion mixed-phase ice nuclei that are dust
+!!\param fdust_depr8      Fraction of deposition ice nuclei that are dust
 !!\param fdust_dhfr8      Fraction of immersion ice nuclei that are dust (not mixed-phase)
 !!\param nlimr8           Limiting ice nuclei concentration (m-3)
-
-!===================================================================================
-
-
+!!\param use_average_v    .false. integrate over the updraft distribution. True: use the mean vertical velocity
+!!\param CCN_param        CCN activation parameterization. 1- Fountoukis and Nenes (2005), 2-Abdul_Razzak and Ghan (2002) (def = 2)
+!!\param IN_param         IN activation spectrum (default is 5)
+!!\param fd_dust
+!!\param fd_soot
+!!\param pfrz_inc_r8
+!!\param sigma_nuc
+!!\param rhi_cell
+!!\param nccn
+!!
        subroutine aerosol_activate(tparc_in, pparc_in, sigwparc_in,     &
      & wparc_ls, Aer_Props, npre_in, dpre_in, ccn_diagr8, Ndropr8,      &
      & cdncr8, smaxliqr8, incr8, smaxicer8, nheticer8, INimmr8,         &

diff --git a/physics/cnvc90.f b/physics/cnvc90.f
@@ -12,7 +12,7 @@ module cnvc90
       subroutine cnvc90_init()
       end subroutine cnvc90_init
 
-!>\defgroup GFS_cnvc90 GFS cnvc90 Main
+!>\defgroup GFS_cnvc90 GFS Convective Cloud Diagnostics Module
 !> @{
 !! This module contains the calculation of fraction of convective cloud,
 !! pressure at bottom of convective cloud and at top of convective
@@ -37,7 +37,7 @@ end subroutine cnvc90_init
 !! | errmsg         | ccpp_error_message                                                    | error message for error handling in CCPP                | none  |    0 | character | len=*     | out    | F        |
 !! | errflg         | ccpp_error_flag                                                       | error flag for error handling in CCPP                   | flag  |    0 | integer   |           | out    | F        |
 !!
-!>\section gen_cnvc90_run GFS cnvc90_run General Algorithm
+! \section gen_cnvc_run GFS cnvc90_run General Algorithm
       SUBROUTINE cnvc90_run(CLSTP,IM,IX,RN,KBOT,KTOP,KM,PRSI,           &
      &                      ACV,ACVB,ACVT,CV,CVB,CVT,errmsg,errflg)
 

diff --git a/physics/cs_conv.F90 b/physics/cs_conv.F90
diff --git a/physics/cs_conv_aw_adj.F90 b/physics/cs_conv_aw_adj.F90
@@ -1,7 +1,7 @@
 !>  \file cs_conv_aw_adj.F90
 !! This file contains a subroutine to adjusts surface rainrate for conservation for CSAW.  
 
-!>\defgroup mod_cs_conv_aw_adj CPT cs_conv_aw_adj Module
+!>\defgroup mod_cs_conv_aw_adj CSAW adjustment Module
 !! This module adjusts surface rainrate for conservation.
 !> @{
 module cs_conv_aw_adj
@@ -48,7 +48,7 @@ end subroutine cs_conv_aw_adj_finalize
 !! | errmsg          | ccpp_error_message                                            | error message for error handling in CCPP                                         | none    |    0 | character | len=*     | out    | F        |
 !! | errflg          | ccpp_error_flag                                               | error flag for error handling in CCPP                                            | flag    |    0 | integer   |           | out    | F        |
 !!
-!>\section gen_cs_conv_aw_adj_run CPT cs_conv_aw_adj_run General Algorithm
+!\section gen_cs_conv_aw_adj_run CPT cs_conv_aw_adj_run General Algorithm
    subroutine cs_conv_aw_adj_run(im, levs, do_cscnv, do_aw, do_shoc, &
                 ntrac, ncld, ntcw, ntclamt, nncl, con_g, sigmafrac,  &
                 gt0, gq0, save_t, save_q, prsi, cldfrac, subcldfrac, &