CCPP sci documentation updates

physics/gscond.f

@@ -52,14 +52,14 @@ end subroutine zhaocarr_gscond_finalize
 !! | errmsg         | error_message                                              | error message for error handling in CCPP                 | none    |    0 | character | len=*     | out    | F        |
 !! | errflg         | error_flag                                                 | error flag for error handling in CCPP                    | flag    |    0 | integer   |           | out    | F        |
 !!
-!> \section general_gscond Zhao-Carr Grid-scale Condensation and Evaporation Scheme General Algorithm
+!> \section general_gscond GFS gscond Scheme General Algorithm
 !! -# Calculate ice-water identification number \f$IW\f$ in order to make a distinction betwee
 !! cloud water and cloud ice (table2 of \cite zhao_and_carr_1997).
 !! -# Calculate the changes in \f$t\f$, \f$q\f$ and \f$p\f$ due to all the processes except microphysics.
 !! -# Calculate cloud evaporation rate (\f$E_c\f$, eq. 19 of \cite zhao_and_carr_1997)
 !! -# Calculate cloud condensation rate (\f$C_g\f$, eq.8 of \cite zhao_and_carr_1997) 
 !! -# update t,q,cwm due to cloud evaporation and condensation process
-!> \section Zhao-Carr_cond_detailed Detailed Algorithm
+!> \section Zhao-Carr_cond_detailed GFS gscond Scheme Detailed Algorithm
 !> @{
         subroutine zhaocarr_gscond_run (im,ix,km,dt,dtf,prsl,ps,q,clw1  &
      &,                  clw2, cwm, t, tp, qp, psp                      &

physics/gwdc.f

@@ -180,7 +180,7 @@ end subroutine gwdc_init
 !! Richardson number including wave impact is similar to that in the mountain
 !! wave case.
 !!
-!> \section al_gwdc Detailed Algorithm
+!> \section al_gwdc GFS Convective GWD Scheme Detailed Algorithm
 !> @{
       subroutine gwdc_run (im,ix,km,lat,u1,v1,t1,q1,deltim,             &
      &           pmid1,pint1,dpmid1,qmax,ktop,kbot,kcnv,cldf,           &
@@ -904,7 +904,7 @@ subroutine gwdc_run (im,ix,km,lat,u1,v1,t1,q1,deltim,             &
 !!      level just below the interface level in which cloud top wave
 !!      stress is defined.
 !! The parameter \f$\mu\f$ is the nonlinearity factor of thermally
-!! induced internal gravity waves defined by eq.(17) in \cite chun_and_baik_1998:
+!! induced internal gravity waves defined by eq.(17) in \cite chun_and_baik_1998 :
 !! \f[
 !!  \mu=\frac{gQ_{0}a_{1}}{c_{p}T_{0}NU^{2}}
 !! \f]

physics/gwdps.f

@@ -184,7 +184,7 @@ end subroutine gwdps_init
 !> \section gen_gwdps GFS Orographic GWD Scheme General Algorithm
 !! -# Calculate subgrid mountain blocking
 !! -# Calculate orographic wave drag
-!> \section det_gwdps Detailed Algorithm
+!> \section det_gwdps GFS Orographic GWD Scheme Detailed Algorithm
 !> @{
       subroutine gwdps_run(                                             &
      &           IM,IX,KM,A,B,C,U1,V1,T1,Q1,KPBL,                       &

physics/mfdeepcnv.f

@@ -106,7 +106,7 @@ end subroutine sasas_deep_finalize
 !!  -# For the "feedback control", calculate updated values of the state
 !! variables by multiplying the cloud base mass flux and the tendencies
 !! calculated per unit cloud base mass flux from the static control.
-!!  \section detailed_deep Detailed Algorithm
+!!  \section detailed_deep GFS SAMF Deep Convection Scheme Detailed Algorithm
 !!  @{
       subroutine sasas_deep_run(im,ix,km,delt,delp,prslp,psp,phil,ql1,  &
      &     ql2,q1,t1,u1,v1,cldwrk,rn,kbot,ktop,kcnv,islimsk,garea,      &

physics/mfpbl.f

@@ -5,35 +5,35 @@
 !!  \brief This subroutine is used for calculating the mass flux and updraft properties.
 !!
 !!  The mfpbl routines works as follows: if the PBL is convective, first, the ascending parcel entrainment rate is calculated as a function of height. Next, a surface parcel is initiated according to surface layer properties and the updraft buoyancy is calculated as a function of height. Next, using the buoyancy and entrainment values, the parcel vertical velocity is calculated using a well known steady-state budget equation. With the profile of updraft vertical velocity, the PBL height is recalculated as the height where the updraft vertical velocity returns to 0, and the entrainment profile is updated with the new PBL height. Finally, the mass flux profile is calculated using the updraft vertical velocity and assumed updraft fraction and the updraft properties are calculated using the updated entrainment profile, surface values, and environmental profiles.
-!!  \param[in] im number of used points
-!!  \param[in] ix horizontal dimension
-!!  \param[in] km vertical layer dimension
-!!  \param[in] ntrac number of tracers
-!!  \param[in] delt physics time step
-!!  \param[in] cnvflg flag to denote a strongly unstable (convective) PBL
-!!  \param[in] zl height of grid centers
-!!  \param[in] zm height of grid interfaces
-!!  \param[in] thvx virtual potential temperature at grid centers (\f$ K \f$)
-!!  \param[in] q1 layer mean tracer concentration (units?)
-!!  \param[in] t1 layer mean temperature (\f$ K \f$)
-!!  \param[in] u1 u component of layer wind (\f$ m s^{-1} \f$)
-!!  \param[in] v1 v component of layer wind (\f$ m s^{-1} \f$)
-!!  \param[in,out] hpbl PBL top height (m)
-!!  \param[in,out] kpbl PBL top index
-!!  \param[in] sflx total surface heat flux (units?)
-!!  \param[in] ustar surface friction velocity
-!!  \param[in] wstar convective velocity scale
-!!  \param[out] xmf updraft mass flux
-!!  \param[in,out] tcko updraft temperature (\f$ K \f$)
-!!  \param[in,out] qcko updraft tracer concentration (units?)
-!!  \param[in,out] ucko updraft u component of horizontal momentum (\f$ m s^{-1} \f$)
-!!  \param[in,out] vcko updraft v component of horizontal momentum (\f$ m s^{-1} \f$)
+!!  \param[in] im      integer, number of used points
+!!  \param[in] ix      integer, horizontal dimension
+!!  \param[in] km      integer, vertical layer dimension
+!!  \param[in] ntrac   integer, number of tracers
+!!  \param[in] delt    real, physics time step
+!!  \param[in] cnvflg  logical, im, flag to denote a strongly unstable (convective) PBL
+!!  \param[in] zl      real, (im, km), height of grid centers
+!!  \param[in] zm      real, (im, km+1), height of grid interfaces
+!!  \param[in] thvx    real, (im, km), virtual potential temperature at grid centers (\f$ K \f$)
+!!  \param[in] q1      real, (ix, km, ntrac), layer mean tracer concentration (units?)
+!!  \param[in] t1      real, (ix, km), layer mean temperature (\f$ K \f$)
+!!  \param[in] u1      real, (ix, km), u component of layer wind (\f$ m s^{-1} \f$)
+!!  \param[in] v1      real, (ix, km), v component of layer wind (\f$ m s^{-1} \f$)
+!!  \param[in,out] hpbl  real, im, PBL top height (m)
+!!  \param[in,out] kpbl  integer, im, PBL top index
+!!  \param[in] sflx      real, im, total surface heat flux (units?)
+!!  \param[in] ustar   real, im, surface friction velocity
+!!  \param[in] wstar   real, im, convective velocity scale
+!!  \param[out] xmf    real, (im, km), updraft mass flux
+!!  \param[in,out] tcko  real, (im, km), updraft temperature (\f$ K \f$)
+!!  \param[in,out] qcko  real, (im, km, ntrac), updraft tracer concentration (units?)
+!!  \param[in,out] ucko  real, (im, km), updraft u component of horizontal momentum (\f$ m s^{-1} \f$)
+!!  \param[in,out] vcko  real, (im, km), updraft v component of horizontal momentum (\f$ m s^{-1} \f$)
 !!
-!!  \section general_mfpbl General Algorithm
+!!  \section general_mfpbl mfpbl General Algorithm
 !!  -# Determine an updraft parcel's entrainment rate, buoyancy, and vertical velocity.
 !!  -# Recalculate the PBL height (previously calculated in moninedmf) and the parcel's entrainment rate.
 !!  -# Calculate the mass flux profile and updraft properties.
-!!  \section detailed_mfpbl Detailed Algorithm
+!!  \section detailed_mfpbl mfpbl Detailed Algorithm
 !!  @{
       subroutine mfpbl(im,ix,km,ntrac,delt,cnvflg,                      &
      &   zl,zm,thvx,q1,t1,u1,v1,hpbl,kpbl,                              &

physics/mfshalcnv.f

@@ -142,7 +142,7 @@ end subroutine sasas_shal_init
 !!  variables by multiplying the cloud base mass flux and the tendencies
 !! calculated per unit cloud base mass flux from the static control.
 !!
-!!  \section detailed_mfshal Detailed Algorithm
+!!  \section detailed_mfshal GFS SAMF Shallow Convection Scheme Detailed Algorithm
 !!  @{
       subroutine sasas_shal_run (im,ix,km,delt,delp,prslp,psp,phil,ql1, &
      &     ql2,q1,t1,u1,v1,rn,kbot,ktop,kcnv,islimsk,garea,             &

physics/moninedmf.f

@@ -13,9 +13,7 @@ end subroutine edmf_init
       subroutine edmf_finalize ()
       end subroutine edmf_finalize
 
-! \defgroup HEDMF GFS Hybrid Eddy-Diffusivity Mass-Flux PBL and Free Atmospheric Turbulence
-!  @{
-!>\defgroup GFS_edmf_main GFS HEDMF Main
+!>\defgroup GFS_edmf_main GFS moninedmf Main
 !!  \brief The Hybrid EDMF scheme is a first-order turbulent transport 
 !! scheme used for subgrid-scale vertical turbulent mixing in the PBL 
 !! and above. It blends the traditional first-order approach that has 
@@ -118,7 +116,7 @@ end subroutine edmf_finalize
 !! | errmsg         | error_message                                                               | error message for error handling in CCPP              | none          |    0 | character | len=*     | out    | F        |
 !! | errflg         | error_flag                                                                  | error flag for error handling in CCPP                 | flag          |    0 | integer   |           | out    | F        |
 !!
-!!  \section general_edmf GFS HEDMF PBL Scheme General Algorithm
+!!  \section general_edmf GFS moninedmf PBL Scheme General Algorithm
 !!  -# Compute preliminary variables from input arguments.
 !!  -# Calculate the first estimate of the PBL height ("Predictor step").
 !!  -# Calculate Monin-Obukhov similarity parameters.
@@ -132,7 +130,7 @@ end subroutine edmf_finalize
 !!  -# Solve for the temperature and moisture tendencies due to vertical mixing.
 !!  -# Calculate heating due to TKE dissipation and add to the tendency for temperature.
 !!  -# Solve for the horizontal momentum tendencies and add them to output tendency terms.
-!!  \section detailed_edmf Detailed Algorithm
+!!  \section detailed_edmf GFS moninedmf PBL Scheme Detailed Algorithm
 !!  @{
       subroutine edmf_run (ix,im,km,ntrac,ntcw,dv,du,tau,rtg,           &
      &   u1,v1,t1,q1,swh,hlw,xmu,                                       &

physics/precpd.f

@@ -43,7 +43,7 @@ end subroutine zhaocarr_precpd_init
 !! | errmsg         | error_message                                                 | error message for error handling in CCPP                          | none        |    0 | character | len=*     | out    | F        |
 !! | errflg         | error_flag                                                    | error flag for error handling in CCPP                             | flag        |    0 | integer   |           | out    | F        |
 !!
-!> \section general_precpd Zhao-Carr Precipitation Production Scheme General Algorithm
+!> \section general_precpd GFS precpd Scheme General Algorithm
 !! The following two equations can be used to calculate the
 !! precipitation rates of rain and snow at each module level:
 !!\f[
@@ -66,7 +66,7 @@ end subroutine zhaocarr_precpd_init
 !! -# Calculate melting of snow (\f$P_{sm1}\f$ and \f$P_{sm2}\f$, \f$P_{sacw}\f$).
 !! -# Update t and q due to precipitation (snow or rain) production.
 !! -# Calculate precipitation at surface (\f$rn\f$) and fraction of frozen precipitation (\f$sr\f$).
-!! \section Zhao-Carr_precip_detailed Detailed Algorithm
+!! \section Zhao-Carr_precip_detailed GFS precpd Scheme Detailed Algorithm
 !! @{
        subroutine zhaocarr_precpd_run (im,ix,km,dt,del,prsl,q,cwm,t,rn  &
      &,                   sr,rainp,u00k,psautco,prautco,evpco,wminco    &