Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

some hiden subroutines documentation in RRTMG Aerosol module are fixed #65

Closed
wants to merge 3 commits into from
Closed

some hiden subroutines documentation in RRTMG Aerosol module are fixed #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa2f82e
display subroutines under aerosol models and change general/detailed …
mzhangw Apr 2, 2018
1010a0a
minor fix
mzhangw Apr 2, 2018
3481ed3
minor fix
mzhangw Apr 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions physics/gscond.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Zhao-Carr Grid-scale Condensation and Evaporation 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 Zhao-Carr Grid-scale Condensation and Evaporation Scheme Detailed Algorithm
!> @{
subroutine zhaocarr_gscond_run (im,ix,km,dt,dtf,prsl,ps,q,clw1 &
&, clw2, cwm, t, tp, qp, psp &
Expand Down
4 changes: 2 additions & 2 deletions physics/gwdc.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, &
Expand Down Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion physics/gwdps.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, &
Expand Down
2 changes: 1 addition & 1 deletion physics/mfdeepcnv.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, &
Expand Down
4 changes: 2 additions & 2 deletions physics/mfpbl.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@
!! \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$)
!!
!! \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, &
Expand Down
2 changes: 1 addition & 1 deletion physics/mfshalcnv.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, &
Expand Down
2 changes: 1 addition & 1 deletion physics/moninedmf.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,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 HEDMF PBL Scheme Detailed Algorithm
!! @{
subroutine edmf_run (ix,im,km,ntrac,ntcw,dv,du,tau,rtg, &
& u1,v1,t1,q1,swh,hlw,xmu, &
Expand Down
4 changes: 2 additions & 2 deletions physics/precpd.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Zhao-Carr Precipitation Production Scheme General Algorithm
!! The following two equations can be used to calculate the
!! precipitation rates of rain and snow at each module level:
!!\f[
Expand All @@ -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 Zhao-Carr Precipitation Production Scheme Detailed Algorithm
!! @{
subroutine zhaocarr_precpd_run (im,ix,km,dt,del,prsl,q,cwm,t,rn &
&, sr,rainp,u00k,psautco,prautco,evpco,wminco &
Expand Down
40 changes: 25 additions & 15 deletions physics/radiation_aerosols.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ module module_radiation_aerosols !
! =KCM1+KCM2 (set in subr set_aerspc)
integer, save :: KCM

real (kind=kind_phys), dimension(KRHLEV) :: rhlev_grt &
real (kind=kind_phys), dimension(KRHLEV) :: rhlev_grt
data rhlev_grt (:)/ .00, .05, .10, .15, .20, .25, .30, .35, &
& .40, .45, .50, .55, .60, .65, .70, .75, .80, .81, .82, &
& .83, .84, .85, .86, .87, .88, .89, .90, .91, .92, .93, &
Expand Down Expand Up @@ -675,7 +675,7 @@ module module_radiation_aerosols !
!!
!>\param NLAY number of model vertical layers (not used)
!>\param me print message control flag
!>\section gen_al General Algorithm
!>\section aer_init_gen_al AER_INIT General Algorithm
!! @{
!-----------------------------------
subroutine aer_init &
Expand Down Expand Up @@ -925,7 +925,7 @@ end subroutine wrt_aerlog
!> This subroutine defines the one wavenumber solar fluxes based on toa
!! solar spectral distribution, and define the one wavenumber IR fluxes
!! based on black-body emission distribution at a predefined temperature.
!>\section gel_set_spec General Algorithm
!>\section gel_set_spec SET_SPECTRUM General Algorithm
!! @{
!--------------------------------
subroutine set_spectrum
Expand Down Expand Up @@ -1074,7 +1074,7 @@ end subroutine aer_init
!! \f$(w/m^2)\f$
!!\param me print message control flag
!!
!!\section gen_clim_aerinit General Algorithm
!!\section gen_clim_aerinit CLIM_AERINIT General Algorithm
!!@{
!-----------------------------------
subroutine clim_aerinit &
Expand Down Expand Up @@ -1166,7 +1166,7 @@ subroutine clim_aerinit &
!> The initialization program for climatological aerosols. The program
!! reads and maps the pre-tabulated aerosol optical spectral data onto
!! corresponding SW radiation spectral bands.
!!\section det_set_aercoef General Algorithm
!!\section det_set_aercoef SET_AERCOEF General Algorithm
!! @{
!--------------------------------
subroutine set_aercoef
Expand Down Expand Up @@ -1796,11 +1796,10 @@ end subroutine clim_aerinit
!>\ingroup module_radiation_aerosols
!> This subroutine checks and updates time varying climatology aerosol
!! data sets.
!!
!>\param iyear 4-digit calender year
!!\param imon month of the year
!!\param me print message control flag
!>\section gen_aer_upd General Algorithm
!>\section gen_aer_upd AER_UPDATE General Algorithm
!! @{
!-----------------------------------
subroutine aer_update &
Expand Down Expand Up @@ -2153,6 +2152,7 @@ end subroutine aer_update
!! @}


!>\ingroup module_radiation_aerosols
!> This subroutine computes aerosols optical properties.
!>\param prsi (IMAX,NLP1), pressure at interface in mb
!!\param prsl (IMAX,NLAY), layer mean pressure in mb
Expand All @@ -2177,7 +2177,7 @@ end subroutine aer_update
!!\n (:,:,:,2): single scattering albedo
!!\n (:,:,:,3): asymmetry parameter
!!\param aerodp (IMAX,NSPC1), vertically integrated optical depth
!>\section general_setaer General Algorithm
!>\section general_setaer SETAER General Algorithm
!> @{
!-----------------------------------
subroutine setaer &
Expand Down Expand Up @@ -2739,6 +2739,7 @@ end subroutine setaer
!> @}


!>\ingroup module_radiation_aerosols
!> This subroutine maps the 5 degree global climatological aerosol data
!! set onto model grids, and compute aerosol optical properties for SW
!! and LW radiations.
Expand All @@ -2765,7 +2766,7 @@ end subroutine setaer
!!\n (:,:,:,2): single scattering albedo
!!\n (:,:,:,3): asymmetry parameter
!!\param aerodp (IMAX,NSPC+1), vertically integrated aer-opt-depth
!!\section gel_aer_pro General Algorithm
!!\section gel_aer_pro AER_PROPERTY General Algorithm
!> @{
!-----------------------------------
subroutine aer_property &
Expand Down Expand Up @@ -3192,6 +3193,7 @@ subroutine aer_property &
contains
! =================

!>\ingroup module_radiation_aerosols
!> This subroutine computes aerosols optical properties in NSWLWBD
!! bands. there are seven different vertical profile structures. in the
!! troposphere, aerosol distribution at each grid point is composed
Expand Down Expand Up @@ -3506,6 +3508,7 @@ end subroutine aer_property
!! gocart_init : set_aerspc, rd_gocart_clim, rd_gocart_luts, optavg_grt
!! setgocartaer: aeropt_grt, map_aermr

!>\ingroup module_radiation_aerosols
!> The initialization program for gocart aerosols
!! - determine weight and index for aerosol composition/luts
!! - read in monthly global distribution of gocart aerosols
Expand All @@ -3524,9 +3527,9 @@ end subroutine aer_property
!!\param NSWLWBD total num of bands calc for sw+lw aeros opt prop
!!\param imon month of the year
!!\param me print message control flag
!!\param raddt
!!\param raddt radiation time step
!!\param fdaer
!>\section gel_go_ini General Algorithm
!>\section gel_go_ini GOCART_INIT General Algorithm
!! @{
!-----------------------------------
subroutine gocart_init &
Expand Down Expand Up @@ -3843,8 +3846,11 @@ subroutine gocart_init &
contains
! =================

!>\ingroup module_radiation_aerosols
!> This subroutine determines merging coefficients ctaer; setup aerosol
!! specification.
!! specification. The current version only supports prognostic aerosols
!! (from GOCART in-line calculations) and climo aerosols (from GEOS-GOCART
!! runs).
!-----------------------------
subroutine set_aerspc(raddt,fdaer)
!.............................
Expand Down Expand Up @@ -4143,6 +4149,7 @@ subroutine set_aerspc(raddt,fdaer)
end subroutine set_aerspc

!-----------------------------------
!>\ingroup module_radiation_aerosols
!> This subroutine reads input gocart aerosol optical data from Mie
!! code calculations.
!-----------------------------
Expand Down Expand Up @@ -4318,6 +4325,7 @@ subroutine rd_gocart_luts
end subroutine rd_gocart_luts
!-----------------------------------
! !
!>\ingroup module_radiation_aerosols
!> This subroutine computes mean aerosols optical properties over each
!! SW/LW radiation spectral band for each of the species components.
!! This program follows GFDL's approach for thick cloud optical property
Expand Down Expand Up @@ -4536,6 +4544,7 @@ subroutine optavg_grt
end subroutine optavg_grt
!--------------------------------
!
!>\ingroup module_radiation_aerosols
!> This subroutine:
!! - 1. read in aerosol dry mass and surface pressure from GEOS3-GOCART
!! C3.1 2000 monthly dataset or aerosol mixing ratio and surface
Expand Down Expand Up @@ -4862,6 +4871,7 @@ end subroutine gocart_init
!-----------------------------------
!! @}

!>\ingroup module_radiation_aerosols
!> This subroutine computes SW + LW aerosol optical properties for
!! gocart aerosol species (merged from fcst and clim fields).
!!
Expand Down Expand Up @@ -4889,7 +4899,7 @@ end subroutine gocart_init
!!\n (:,:,:,1): optical depth
!!\n (:,:,:,2): single scattering albedo
!!\n (:,:,:,3): asymmetry parameter
!>\section gen_setgo General Algorithm
!>\section gen_setgo SETGOCARTAER General Algorithm
!!@{
!-----------------------------------
subroutine setgocartaer &
Expand Down Expand Up @@ -5167,7 +5177,7 @@ subroutine setgocartaer &
contains
! =================

!>\ingroup setaer
!>\ingroup module_radiation_aerosols
!> This subroutine maps input tracer fields (trcly) to local tracer
!! array (aermr).
!-----------------------------
Expand Down Expand Up @@ -5254,7 +5264,7 @@ end subroutine map_aermr
!-----------------------------------


!>\ingroup setaer
!>\ingroup module_radiation_aerosols
!! This subroutine computes aerosols optical properties in NSWLWBD
!! SW/LW bands. Aerosol distribution at each grid point is composed
!! from up to NMXG aerosol species (from NUM_GRIDCOMP components).
Expand Down
2 changes: 1 addition & 1 deletion physics/radiation_astronomy.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ end subroutine sol_init
!!\param sdec, cdec sin and cos of the solar declination angle
!!\param solcon sun-earth distance adjusted solar constant
!! \f$(w/m^2)\f$
!>\section gen_sol_update General Algorithm
!>\section gen_sol_update SOL_UPDATE General Algorithm
!! @{
!-----------------------------------
subroutine sol_update &
Expand Down
16 changes: 8 additions & 8 deletions physics/radiation_clouds.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
!! - gethml():get diagnostic hi, mid, low,total,BL clouds
!! - rhtable():rh lookup table for diag cloud scheme
!!
!> \section gen_al_clouds General Algorithm
!> \section gen_al_clouds RRTMG Clouds Module General Algorithm
!! @{
!! -# Cloud Liquid/Ice Water Path (LWP,IWP)
!!\n We define the fraction of liquid and ice cloud as:
Expand Down Expand Up @@ -333,7 +333,7 @@ module module_radiation_clouds !
!!\param si model vertical sigma layer interface
!!\param NLAY vertical layer number
!!\param me print control flag
!!\section gen_cld_init General Algorithm
!!\section gen_cld_init CLD_INIT General Algorithm
!> @{
subroutine cld_init &
& ( si, NLAY, me ) ! --- inputs
Expand Down Expand Up @@ -483,7 +483,7 @@ end subroutine cld_init
!!\param clds (IX,5), fraction of clouds for low, mid, hi, tot, bl
!!\param mtop (IX,3), vertical indices for low, mid, hi cloud tops
!!\param mbot (IX,3), vertical indices for low, mid, hi cloud bases
!>\section gen_progcld1 General Algorithm
!>\section gen_progcld1 PROGCLD1 General Algorithm
!> @{
subroutine progcld1 &
& ( plyr,plvl,tlyr,tvly,qlyr,qstl,rhly,clw, & ! --- inputs:
Expand Down Expand Up @@ -940,7 +940,7 @@ end subroutine progcld1
!!\param clds (IX,5), fraction of clouds for low, mid, hi, tot, bl
!!\param mtop (IX,3), vertical indices for low, mid, hi cloud tops
!!\param mbot (IX,3), vertical indices for low, mid, hi cloud bases
!>\section gen_progcld2 General Algorithm
!>\section gen_progcld2 PROGCLD2 General Algorithm
!> @{
subroutine progcld2 &
& ( plyr,plvl,tlyr,tvly,qlyr,qstl,rhly,clw, & ! --- inputs:
Expand Down Expand Up @@ -1439,7 +1439,7 @@ end subroutine progcld2
!!\param clds (ix,5), fraction of clouds for low, mid, hi, tot, bl
!!\param mtop (ix,3), vertical indices for low, mid, hi cloud tops
!!\param mbot (ix,3), vertical indices for low, mid, hi cloud bases
!!\section gen_progcld3 General Algorithm
!!\section gen_progcld3 PROGCLD3 General Algorithm
!> @{
subroutine progcld3 &
& ( plyr,plvl,tlyr,tvly,qlyr,qstl,rhly,clw,cnvw,cnvc, & ! --- inputs:
Expand Down Expand Up @@ -1867,7 +1867,7 @@ end subroutine progcld3
!!\param clds (IX,5), fraction of clouds for low, mid, hi, tot, bl
!!\param mtop (IX,3), vertical indices for low, mid, hi cloud tops
!!\param mbot (IX,3), vertical indices for low, mid, hi cloud bases
!>\section gen_progclduni General Algorithm
!>\section gen_progclduni PROGCLDUNI General Algorithm
!> @{
subroutine progclduni &
& ( plyr,plvl,tlyr,tvly,clw,ciw, & ! --- inputs:
Expand Down Expand Up @@ -2189,7 +2189,7 @@ end subroutine progclduni
!!\param clds (IX,5), fraction of clouds for low, mid, hi, tot, bl
!!\param mtop (IX,3), vertical indices for low, mid, hi cloud tops
!!\param mbot (IX,3), vertical indices for low, mid, hi cloud bases
!!\section gen_diagcld1 General Algorithm
!!\section gen_diagcld1 DIAGCLD1 General Algorithm
!> @{
subroutine diagcld1 &
& ( plyr,plvl,tlyr,rhly,vvel,cv,cvt,cvb, & ! --- inputs:
Expand Down Expand Up @@ -2805,7 +2805,7 @@ end subroutine diagcld1
!> \param mtop (IX,3),vertical indices for low, mid, hi cloud tops
!> \param mbot (IX,3),vertical indices for low, mid, hi cloud bases
!!
!>\section detail Detailed Algorithm
!>\section detail GETHML Detailed Algorithm
!! @{
subroutine gethml &
& ( plyr, ptop1, cldtot, cldcnv, & ! --- inputs:
Expand Down
2 changes: 1 addition & 1 deletion physics/radiation_gases.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ end subroutine gas_init
!!\param loz1st clim ozone 1st time update control flag
!!\param ldoco2 co2 update control flag
!!\param me print message control flag
!>\section gen_gas_update General Algorithm
!>\section gen_gas_update GAS_UPDATE General Algorithm
!! @{
!-----------------------------------
subroutine gas_update &
Expand Down
Loading