From 967df8cddf66f66945006f5dffb727a7fba9834a Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 18 Jan 2024 08:00:54 -0700 Subject: [PATCH] more doxygen changes --- io/post_fv3.F90 | 84 +++++++++++++++++++++++++-------------- io/post_nems_routines.F90 | 82 ++++++++++++++++++++++---------------- 2 files changed, 102 insertions(+), 64 deletions(-) diff --git a/io/post_fv3.F90 b/io/post_fv3.F90 index 97962bdd9..beb445653 100644 --- a/io/post_fv3.F90 +++ b/io/post_fv3.F90 @@ -1,3 +1,26 @@ +!> @file Run post on write grid comp. +!> @brief ??? +!> @author Jun Wang @date Jul, 2019 + +!> @brief Run post on write grid comp. +!> +!> ## Module History +!> +!> Date | Programmer | Modification +!> -----|------------|------------- +!> Jul 2019 | J. Wang | create interface to run inline post for FV3 +!> Sep 2020 | J. Dong/J. Wang | create interface to run inline post for FV3-LAM +!> Apr 2021 | R. Sun | Added variables for Thomspon MP +!> Apr 2022 | W. Meng | 1)unify global and regional inline post interfaces +!> Apr 2022 | W. Meng | 2)add bug fix for dx/dy computation +!> Apr 2022 | W. Meng | 3)add reading pwat from FV3 +!> Apr 2022 | W. Meng | 4)remove some variable initializations +!> Apr 2022 | W. Meng | 5)read max/min 2m T from tmax_max2m/tmin_min2m for GFS, and from t02max/min for RRFS and HAFS. +!> Apr 2022 | W. Meng | 6)read 3D cloud fraction from cld_amt for GFDL MP, and from cldfra for other MPs. +!> Jun 2022 | J. Meng | 2D decomposition +!> Jul 2022 | W. Meng | 1)output lat/lon of four corner point for rotated lat-lon grid. 2)read instant model top logwave +!> +!> @author Jun Wang @date Jul, 2019 module post_fv3 use mpi @@ -10,35 +33,26 @@ module post_fv3 implicit none - public post_run_fv3 + public post_run_fv3 !< ??? contains + !> ??? + !> + !> @param[in] wrt_int_state ??? + !> @param[in] grid_id ??? + !> @param[in] mype ??? + !> @param[in] mpicomp ??? + !> @param[in] lead_write ??? + !> @param[in] itasks ??? + !> @param[in] jtasks ??? + !> @param[in] mynfhr ??? + !> @param[in] mynfmin ??? + !> @param[in] mynfsec + !> + !> @author Jun Wang @date Jul, 2019 subroutine post_run_fv3(wrt_int_state,grid_id,mype,mpicomp,lead_write, & itasks,jtasks,mynfhr,mynfmin,mynfsec) -! -! revision history: -! Jul 2019 J. Wang create interface to run inline post for FV3 -! Sep 2020 J. Dong/J. Wang create interface to run inline post for FV3-LAM -! Apr 2021 R. Sun Added variables for Thomspon MP -! Apr 2022 W. Meng 1)unify global and regional inline post interfaces -! 2)add bug fix for dx/dy computation -! 3)add reading pwat from FV3 -! 4)remove some variable initializations -! 5)read max/min 2m T from tmax_max2m/tmin_min2m -! for GFS, and from t02max/min for RRFS -! and HAFS. -! 6)read 3D cloud fraction from cld_amt for GFDL MP, -! and from cldfra for other MPs. -! Jun 2022 J. Meng 2D decomposition -! Jul 2022 W. Meng 1)output lat/lon of four corner point for rotated -! lat-lon grid. -! 2)read instant model top logwave -! -!----------------------------------------------------------------------- -!*** run post on write grid comp -!----------------------------------------------------------------------- -! use ctlblk_mod, only : komax,ifhr,ifmin,modelname,datapd,fld_info, & npset,grib,jsta, & jend,ista,iend, im, nsoil, filenameflat,numx @@ -215,9 +229,13 @@ subroutine post_run_fv3(wrt_int_state,grid_id,mype,mpicomp,lead_write, & call post_finalize('grib2') end subroutine post_run_fv3 -! -!----------------------------------------------------------------------- -! + + !> ??? + !> + !> @param[in] wrt_int_state ??? + !> @param[in] grid_id ??? + !> + !> @author Jun Wang @date Jul, 2019 subroutine post_getattr_fv3(wrt_int_state,grid_id) ! use esmf @@ -485,9 +503,15 @@ subroutine post_getattr_fv3(wrt_int_state,grid_id) enddo !end nfb ! end subroutine post_getattr_fv3 -! -!----------------------------------------------------------------------- -! + + !> ??? + !> + !> @param[in] wrt_int_state ??? + !> @param[in] grid_id ??? + !> @param[in] mype ??? + !> @param[in] mpicomp + !> + !> @author Jun Wang @date Jul 2019 subroutine set_postvars_fv3(wrt_int_state,grid_id,mype,mpicomp) ! ! revision history: diff --git a/io/post_nems_routines.F90 b/io/post_nems_routines.F90 index 337139b1d..4fc88d91c 100644 --- a/io/post_nems_routines.F90 +++ b/io/post_nems_routines.F90 @@ -1,19 +1,33 @@ -!----------------------------------------------------------------------- -!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -!----------------------------------------------------------------------- -! - subroutine post_alctvars(imi,jmi,lmi,mype,nwtlpes,lead_write, mpicomp, & - jts,jte,jtsgrp,jtegrp,its,ite,itsgrp,itegrp) -! -! -! revision history: -! Jul 2019 Jun Wang: allocate arrays for post processing -! Feb 2022 J. Meng/B. Cui: create interface to run inline post with post_2d_decomp -! -!----------------------------------------------------------------------- -!*** allocate post variables -!----------------------------------------------------------------------- -! +!> @file +!> @brief ??? +!> @author Jun Wang @date Oct 8, 2019 + +!> Allocate post variables. +!> +!> ## Subroutine History +!> Date | Programmer | Modification +!> Jul 2019 | Jun Wang | allocate arrays for post processing +!> Feb 2022 | J. Meng/B. Cui | create interface to run inline post with post_2d_decomp +!> +!> @param[in] imi ??? +!> @param[in] jmi ??? +!> @param[in] lmi ??? +!> @param[in] mype ??? +!> @param[in] nwtlpes ??? +!> @param[in] lead_write ??? +!> @param[in] mpicomp ??? +!> @param[in] jts ??? +!> @param[in] jte ??? +!> @param[in] jtsgrp ??? +!> @param[in] jtegrp ??? +!> @param[in] its ??? +!> @param[in] ite ??? +!> @param[in] itsgrp ??? +!> @param[in] itegrp ??? +!> +!> @author Jun Wang @date Oct 8 2019 +subroutine post_alctvars(imi,jmi,lmi,mype,nwtlpes,lead_write, mpicomp, & + jts,jte,jtsgrp,jtegrp,its,ite,itsgrp,itegrp) use vrbls4d use vrbls3d use vrbls2d @@ -215,11 +229,18 @@ subroutine post_alctvars(imi,jmi,lmi,mype,nwtlpes,lead_write, mpicomp, & end do end do end subroutine post_alctvars -! -!--------------------------------------------------------------------- -!&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& -!--------------------------------------------------------------------- -! + + !> Read post namelist. + !> + !> @param[in] kpo ??? + !> @param[in] kth ??? + !> @param[in] kpv ??? + !> @param[in] po ??? + !> @param[in] th ??? + !> @param[in] pv ??? + !> @param[in] post_namelist ??? + !> + !> @author Jun Wang @date Jul 2019 subroutine read_postnmlt(kpo,kth,kpv,po,th,pv,post_namelist) ! use ctlblk_mod, only : komax,fileNameD3D,lsm,lsmp1,spl,spldef, & @@ -228,10 +249,6 @@ subroutine read_postnmlt(kpo,kth,kpv,po,th,pv,post_namelist) isf_surface_physics,modelname,submodelname,& rdaod,d2d_chem,nasa_on,gccpp_on use upp_ifi_mod, only: write_ifi_debug_files -! -! revision history: -! Jul 2019 Jun Wang: read post namelist -! implicit none !--- character (len=*), intent(in) :: post_namelist @@ -335,16 +352,13 @@ subroutine read_postnmlt(kpo,kth,kpv,po,th,pv,post_namelist) 1000 continue end subroutine read_postnmlt -! -!--------------------------------------------------------------------- -!&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& -!--------------------------------------------------------------------- -! + + !> ??? + !> + !> @param[in] post_gribversion ??? + !> + !> @author Jun Wang @date Jul 2019 subroutine post_finalize(post_gribversion) -! -! revision history: -! Jul 2019 Jun Wang: finalize post step -! use grib2_module, only : grib_info_finalize ! character(*),intent(in) :: post_gribversion