From 9fc5ac15ff2b7a4e822f68e592ddb4aa7d207832 Mon Sep 17 00:00:00 2001 From: Man Zhang Date: Wed, 11 Sep 2019 16:12:00 -0600 Subject: [PATCH] initialize Doxygen documentation in F-A scheme --- physics/docs/ccpp_doxyfile | 4 ++++ physics/module_MP_FER_HIRES.F90 | 35 +++++++++++++++++++++++++---- physics/module_mp_fer_hires_pre.F90 | 3 ++- physics/mp_fer_hires.F90 | 2 +- 4 files changed, 38 insertions(+), 6 deletions(-) diff --git a/physics/docs/ccpp_doxyfile b/physics/docs/ccpp_doxyfile index 91c80c221..b435664e3 100644 --- a/physics/docs/ccpp_doxyfile +++ b/physics/docs/ccpp_doxyfile @@ -245,6 +245,10 @@ INPUT = pdftxt/mainpage.txt \ ../module_mp_thompson.F90 \ ../module_mp_radar.F90 \ ../mp_thompson_post.F90 \ +### HAFS + ../module_MP_FER_HIRES.F90 \ + ../mp_fer_hires.F90 \ + ../module_mp_fer_hires_pre.F90 \ ### utils ../funcphys.f90 \ ../physparam.f \ diff --git a/physics/module_MP_FER_HIRES.F90 b/physics/module_MP_FER_HIRES.F90 index 37465527e..3b20ccba8 100644 --- a/physics/module_MP_FER_HIRES.F90 +++ b/physics/module_MP_FER_HIRES.F90 @@ -1,6 +1,6 @@ -! -!-- "Modified" fer_hires microphysics - 11 July 2016 version -! +!>\file module_MP_FER_HIRES.F90 +!! "Modified" fer_hires microphysics - 11 July 2016 version +!! ! (1) Ice nucleation: Fletcher (1962) replaces Meyers et al. (1992) ! (2) Cloud ice is a simple function of the number concentration from (1), and it ! is no longer a fractional function of the large ice. Thus, the FLARGE & @@ -232,7 +232,9 @@ MODULE MODULE_MP_FER_HIRES !----------------------------------------------------------------------- !&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& !----------------------------------------------------------------------- -!ZM SUBROUTINE FER_HIRES (itimestep,DT,RHgrd, & + +!>\ingroup hafs_famp +!! This is the driver scheme of Ferrier-Aligo microphysics scheme. SUBROUTINE FER_HIRES (DT,RHgrd, & & dz8w,rho_phy,p_phy,pi_phy,th_phy,t_phy, & & q,qt, & @@ -667,6 +669,31 @@ END SUBROUTINE FER_HIRES !############################################################################### !############################################################################### ! +!>\ingroup hafs_famp +!! This is the grid-scale microphysical processes of Ferrier-Aligo microphysics +!! scheme (i.e., condensation and precipitation). +!!\param arain accumulated rainfall at the surface (kg) +!!\param asnow accumulated snowfall at the surface (kg) +!!\param dtph physics time step (s) +!!\param rhc_col vertical column of threshold relative humidity for onset of +!! condensation (ratio) +!!\param i_index i index +!!\param j_index j index +!!\param lsfc Eta level of level above surface, ground +!!\param p_col vertical column of model pressure (Pa) +!!\param qi_col vertical column of model ice mixing ratio (kg/kg) +!!\param qr_col vertical column of model rain ratio (kg/kg) +!!\param q_col vertical column of model water vapor specific humidity (kg/kg) +!!\param qw_col +!!\param rimef_col +!!\param t_col +!!\param thick_col +!!\param wc_col +!!\param lm +!!\param pcond1d +!!\param pidep1d +!!\param piacw1d +!!\param piacwi1d SUBROUTINE EGCP01COLUMN_hr ( ARAIN, ASNOW, DTPH, RHC_col, & & I_index, J_index, LSFC, & & P_col, QI_col, QR_col, Q_col, QW_col, RimeF_col, T_col, & diff --git a/physics/module_mp_fer_hires_pre.F90 b/physics/module_mp_fer_hires_pre.F90 index 4ed65a23d..a52cec0c1 100644 --- a/physics/module_mp_fer_hires_pre.F90 +++ b/physics/module_mp_fer_hires_pre.F90 @@ -21,7 +21,8 @@ end subroutine mp_fer_hires_pre_init subroutine mp_fer_hires_pre_finalize () end subroutine mp_fer_hires_pre_finalize -!> \defgroup hafs_fa HAFS Ferrier-Aligo MP Scheme Update Water Module +!> \defgroup hafs_fa_update HAFS Ferrier-Aligo MP Scheme Update Water Module +!! \ingroup hafs_famp !! This subroutine is to update water array with CWM, F_RAIN, and F_ICE !! for Ferrier-Aligo MP scheme. !! \section arg_table_mp_fer_hires_pre_run Argument Table diff --git a/physics/mp_fer_hires.F90 b/physics/mp_fer_hires.F90 index 1a0000912..9aec8e728 100644 --- a/physics/mp_fer_hires.F90 +++ b/physics/mp_fer_hires.F90 @@ -95,7 +95,7 @@ subroutine mp_fer_hires_init(Model, imp_physics, & end subroutine mp_fer_hires_init - +!>\defgroup hafs_famp HAFS Ferrier-Aligo Cloud Microphysics Scheme !> This is the CCPP-compliant FER_HIRES driver module. !> \section arg_table_mp_fer_hires_run Argument Table !! | local_name | standard_name | long_name | units | rank | type | kind | intent | optional |