Skip to content

Doxygen in INITPOST.F, INITPOST_GFS_NEMS_MPIIO, INITPOST_NEMS.f and INITPOST_NETCDF.f. #473

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

Merged
WenMeng-NOAA merged 7 commits into from
Apr 26, 2022
Merged

Doxygen in INITPOST.F, INITPOST_GFS_NEMS_MPIIO, INITPOST_NEMS.f and INITPOST_NETCDF.f. #473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7b3e566
This is part of Issue #392.
kayeekayee Apr 6, 2022
edbf7fa
Minor fix.
kayeekayee Apr 6, 2022
58a0ea3
Merge branch 'NOAA-EMC:develop' into doxygen_INITPOST_INITPOST_GFS_NE…
kayeekayee Apr 21, 2022
eec7f14
Minor fix.
kayeekayee Apr 21, 2022
0f9c5cb
Further refinement from Ed's comments.
kayeekayee Apr 26, 2022
4c553fc
Minor bug fix.
kayeekayee Apr 26, 2022
87be95a
Merge branch 'NOAA-EMC:develop' into doxygen_INITPOST_INITPOST_GFS_NE…
kayeekayee Apr 26, 2022
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
64 changes: 22 additions & 42 deletions sorc/ncep_post.fd/INITPOST.F
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,26 @@
!> @file
!
!> SUBPROGRAM: INITPOST INITIALIZE POST FOR RUN
!! PRGRMMR: RUSS TREADON ORG: W/NP2 DATE: 93-11-10
!!
!! ABSTRACT: THIS ROUTINE INITIALIZES CONSTANTS AND
!! VARIABLES AT THE START OF AN ETA MODEL OR POST
!! PROCESSOR RUN.
!!
!! THIS ROUTINE ASSUMES THAT INTEGERS AND REALS ARE THE SAME SIZE
!!
!! PROGRAM HISTORY LOG:
!! 93-11-10 RUSS TREADON - ADDED DOCBLOC
!! 98-05-29 BLACK - CONVERSION OF POST CODE FROM 1-D TO 2-D
!! 99-01 20 TUCCILLO - MPI VERSION
!! 01-10-25 H CHUANG - MODIFIED TO PROCESS HYBRID MODEL OUTPUT
!! 02-06-19 MIKE BALDWIN - WRF VERSION
!! 02-08-15 H CHUANG - UNIT CORRECTION AND GENERALIZE PROJECTION OPTIONS
!! 21-03-11 Bo Cui - change local arrays to dimension (im,jsta:jend)
!!
!! USAGE: CALL INIT
!! INPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT FILES:
!! NONE
!!
!! SUBPROGRAMS CALLED:
!! UTILITIES:
!! NONE
!! LIBRARY:
!! COMMON - CTLBLK
!! LOOKUP
!! SOILDEPTH
!!
!!
!! ATTRIBUTES:
!! LANGUAGE: FORTRAN
!! MACHINE : CRAY C-90
!!
!> @brief initpost() initializes post for run.
Comment thread
kayeekayee marked this conversation as resolved.
!>
!> @author Russ Treadon W/NP2 @date 1993-11-10

!> This routine initializes constants and
!> variables at the start of an ETA model or post
!> processor run.
!>
!> This routine assumes that integers and reals are the same size.
!>
!> ### Program History Log
!> Date | Programmer | Comments
!> -----|------------|---------
!> 1993-11-10 | Russ Treadon | Initial. Added DOCBLOC
!> 1998-05-29 | T Black | Conversion from 1-D to 2-D
!> 1999-01-20 | Jim Tuccillo | MPI Version
!> 2001-10-25 | H CHuang | Modified to process hybrid model output
!> 2002-06-19 | Mike Baldwin | WRF Version
!> 2002-08-15 | H CHuang | Unit correction and generalize projection options
!> 2021-03-11 | Bo Cui | Change local arrays to dimension (im,jsta:jend)
!>
!> @author Russ Treadon W/NP2 @date 1993-11-10
SUBROUTINE INITPOST

use vrbls4d, only: dust, smoke
Expand Down
74 changes: 27 additions & 47 deletions sorc/ncep_post.fd/INITPOST_GFS_NEMS_MPIIO.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,31 @@
!> @file
! . . .
!> SUBPROGRAM: INITPOST_GFS_NEMS_MPIIO INITIALIZE POST FOR RUN
!! PRGRMMR: Hui-Ya Chuang DATE: 2016-03-04
!!
!! ABSTRACT: THIS ROUTINE INITIALIZES CONSTANTS AND
!! VARIABLES AT THE START OF GFS MODEL OR POST
!! PROCESSOR RUN.
!!
!! REVISION HISTORY
!! 2011-02-07 Jun Wang add grib2 option
!! 2011-12-14 Sarah Lu add aer option
!! 2012-01-07 Sarah Lu compute air density
!! 2012-12-22 Sarah Lu add aerosol zerout option
!! 2015-03-16 S. Moorthi adding gocart_on option
!! 2015-03-18 S. Moorthi Optimization including threading
!! 2015-08-17 S. Moorthi Add TKE for NEMS/GSM
!! 2016-03-04 H CHUANG Add MPI IO option to read GFS nems output
!! 2016-05-16 S. KAR Add computation of omega
!! 2016-07-21 S. Moorthi Convert input upper air data from reduced to full grid
!! and reduce memory in divergence calculatiom
!! 2016-07-21 Jun Wang change averaged field name with suffix
!! 2019-07-24 Li(Kate) Zhang - Merge and update NGAC UPP into FV3-Chem
!! 2021-03-11 Bo Cui change local arrays to dimension (im,jsta:jend)
!!
!! USAGE: CALL INIT
!! INPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT FILES:
!! NONE
!!
!! SUBPROGRAMS CALLED:
!! UTILITIES:
!! NONE
!! LIBRARY:
!! COMMON - CTLBLK
!! LOOKUP
!! SOILDEPTH
!!
!!
!! ATTRIBUTES:
!! LANGUAGE: FORTRAN
!! MACHINE : CRAY C-90
!!
!> @brief initpost_gfs_nems_mpiio() initializes post for run.
Comment thread
kayeekayee marked this conversation as resolved.
!>
!> @author Hui-Ya Chuang @date 2007-03-04

!> This routine initializes constants and
!> variables at the start of GFS model or post
!> processor run.
!>
!> ### Program History Log
!> Date | Programmer | Comments
!> -----|------------|---------
!> 2007-03-04 | Hui-Ya Chuang | Initial
!> 2011-02-07 | Jun Wang | Add grib2 option
!> 2011-12-14 | Sarah Lu | Add aer option
!> 2012-01-07 | Sarah Lu | Compute air density
!> 2012-12-22 | Sarah Lu | Add aerosol zerout option
!> 2015-03-16 | S. Moorthi | Adding gocart_on option
!> 2015-03-18 | S. Moorthi | Optimization including threading
!> 2015-08-17 | S. Moorthi | Add TKE for NEMS/GSM
!> 2016-03-04 | H Chuang | Add MPI IO option to read GFS nems output
!> 2016-05-16 | S. Kar | Add computation of omega
!> 2016-07-21 | S. Moorthi | Convert input upper air data from reduced to full grid and reduce memory in divergence calculatiom
!> 2016-07-21 | Jun Wang | Change averaged field name with suffix
!> 2019-07-24 | Li(Kate) Zhang | Merge and update NGAC UPP into FV3-Chem
!> 2021-03-11 | Bo Cui | Change local arrays to dimension (im,jsta:jend)
!>
!> @author Hui-Ya Chuang @date 2007-03-04
SUBROUTINE INITPOST_GFS_NEMS_MPIIO(iostatusAER)


Expand Down
53 changes: 18 additions & 35 deletions sorc/ncep_post.fd/INITPOST_NEMS.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,22 @@
!> @file
! . . .
!> SUBPROGRAM: INITPOST INITIALIZE POST FOR RUN
!! PRGRMMR: Hui-Ya Chuang DATE: 2008-03-26
!!
!! ABSTRACT: THIS ROUTINE INITIALIZES CONSTANTS AND
!! VARIABLES AT THE START OF AN NEMS MODEL OR POST
!! PROCESSOR RUN.
!!
!! REVISION HISTORY
!! 21-03-11 Bo Cui - change local arrays to dimension (im,jsta:jend)
!!
!! USAGE: CALL INITPOST_NEMS
!! INPUT ARGUMENT LIST:
!! NREC
!! NFILE
!!
!! OUTPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT FILES:
!! NONE
!!
!! SUBPROGRAMS CALLED:
!! UTILITIES:
!! NONE
!! LIBRARY:
!! COMMON - CTLBLK
!! LOOKUP
!! SOILDEPTH
!!
!!
!! ATTRIBUTES:
!! LANGUAGE: FORTRAN
!! MACHINE : CRAY C-90
!!
!> @brief initpost_nems() initializes post for run.
!>
!> @author Hui-Ya Chuang @date 2007-03-26

!> This routine initializes constants and
!> variables at the start of an NEMS model or post
!> processor run.
!>
!> @param[in] NREC.
!> @param[in] NFILE.
!>
!> ### Program History Log
!> Date | Programmer | Comments
!> -----|------------|---------
!> 2007-03-01 | Hui-Ya Chuang | Initial
!> 2021-03-11 | Bo Cui | Change local arrays to dimension (im,jsta:jend)
!>
!> @author Hui-Ya Chuang @date 2007-03-26
SUBROUTINE INITPOST_NEMS(NREC,nfile)

use vrbls3d, only: t, q, uh, vh, q2, cwm, f_ice, f_rain, f_rimef, cfr, pint,&
Expand Down
56 changes: 18 additions & 38 deletions sorc/ncep_post.fd/INITPOST_NETCDF.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,22 @@
!> @file
! . . .
!> SUBPROGRAM: INITPOST_NETCDF INITIALIZE POST FOR RUN
!! PRGRMMR: Hui-Ya Chuang DATE: 2016-03-04
!!
!! ABSTRACT: THIS ROUTINE INITIALIZES CONSTANTS AND
!! VARIABLES AT THE START OF GFS MODEL OR POST
!! PROCESSOR RUN.
!!
!! REVISION HISTORY
!! 2017-08-11 H Chuang start from INITPOST_GFS_NEMS_MPIIO.f
!! 2021-03-11 Bo Cui change local arrays to dimension (im,jsta:jend)
!! 2022-02-07 Wen Meng Changes for parallel netcdf read.
!! 2022-03-15 Wen Meng Unify regional and global interfaces.
!! 2022-03-22 Wen Meng Read PWAT from model.
!!
!! USAGE: CALL INITPOST_NETCDF
!! INPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT FILES:
!! NONE
!!
!! SUBPROGRAMS CALLED:
!! UTILITIES:
!! NONE
!! LIBRARY:
!! COMMON - CTLBLK
!! LOOKUP
!! SOILDEPTH
!!
!!
!! ATTRIBUTES:
!! LANGUAGE: FORTRAN
!! MACHINE : CRAY C-90
!!
!> @brief initpost_netcdf() initializes post for run.
!>
!> @author Hui-Ya Chuang @date 2016-03-04

!> This routine initializes constants and
!> variables at the start of GFS model or post
!> processor run.
!>
!> ### Program History Log
!> Date | Programmer | Comments
!> -----|------------|---------
!> 2007-03-01 | Hui-Ya Chuang | Initial. Start from INITPOST_GFS_NEMS_MPIIO.f
!> 2021-03-11 | Bo Cui | Change local arrays to dimension (im,jsta:jend)
!> 2022-02-07 | Wen Meng | Changes for parallel netcdf read
!> 2022-03-15 | Wen Meng | Unify regional and global interfaces
!> 2022-03-22 | Wen Meng | Read PWAT from model
!>
!> @author Hui-Ya Chuang @date 2016-03-04
SUBROUTINE INITPOST_NETCDF(ncid2d,ncid3d)


Expand Down