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

Update documentation for MSFPS.f, NGMFLD.f, OTLFT.f, OTLIFT.f, and ZENSUN.f #681

Merged
merged 11 commits into from
Apr 3, 2023
Merged

Update documentation for MSFPS.f, NGMFLD.f, OTLFT.f, OTLIFT.f, and ZENSUN.f #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a5a0ab3
generate html docs
gspetro-NOAA Mar 14, 2023
23b580b
fix warnings on GFSPOSTSIG.F
gspetro Mar 16, 2023
76961c0
fix formatting
gspetro Mar 16, 2023
0c26a60
add data types for 3 vars
gspetro Mar 16, 2023
9c479de
Merge branch 'develop' of https://github.com/gspetro-NOAA/UPP into de…
gspetro-NOAA Mar 17, 2023
36cc0a2
Merge branch 'develop' of github.com:gspetro-NOAA/UPP into text/dox7.5
gspetro Mar 31, 2023
f8ad9b3
update ZENSUN.f
gspetro Mar 31, 2023
4413734
fix file warnings for OTLIFT.f, OTLFT.f, NGMFLD.f, and MSFPS.f
gspetro Mar 31, 2023
79285a4
Merge branch 'NOAA-EMC:develop' into text/dox7.5
gspetro-NOAA Apr 1, 2023
ca6b411
revert accidental changes to compile_upp.sh
gspetro Apr 1, 2023
084e43d
edit typos
gspetro Apr 1, 2023
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
10 changes: 10 additions & 0 deletions sorc/ncep_post.fd/MSFPS.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@
!> 2006-11-01 | Rozumalski | Swiped from WRF si package
!>
!> @author Rozumalski @date 2006-11-01

! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
!> msfps() computes the map scale factor for a polar stereographic grid at a give latitude.
!>
!> This subroutine computes the map scale factor for a polar stereographic grid at a give latitude.
!>
!> @param[in] LAT Latitude at which map factor is valid.
!> @param[in] TRUELAT1 TRUELAT 1.
!> @param[out] MSF Map scale factor.

SUBROUTINE MSFPS(LAT,TRUELAT1,MSF)


Expand Down
15 changes: 14 additions & 1 deletion sorc/ncep_post.fd/NGMFLD.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
!> This routine computes a handful of NGM layer mean
!> fields. This is done to provide a fully complete
!> ETA NGM look-alike output file.
!> ### The sigma (layer) fields computed bu this routine are tabulated below.
!> ### The sigma (layer) fields computed by this routine are tabulated below.
!> Sigma (layer) | Field(s) |
!> --------------|----------|
!> 0.47191 - 1.00000 | RH |
Expand Down Expand Up @@ -43,6 +43,19 @@
!> 2021-09-30 | JESSE MENG | 2D DECOMPOSITION
!>
!> @author Russ Treadon W/NP2 @date 1992-12-22

!- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
!> ngmfld() computes layer mean NGM fields
!>
!> This routine computes a handful of NGM layer mean
!> fields.
!>
!> @param[out] RH4710 Sigma layer 0.47-1.00 mean relative humidity.
!> @param[out] RH4796 Sigma layer 0.47-0.96 mean relative humidity.
!> @param[out] RH1847 Sigma layer 0.18-0.47 mean relative humidity.
!> @param[out] RH8498 Sigma layer 0.84-0.98 mean relative humidity.
!> @param[out] QM8510 Sigma layer 0.85-1.00 mean moisture convergence.

SUBROUTINE NGMFLD(RH4710,RH4796,RH1847,RH8498,QM8510)

!
Expand Down
20 changes: 18 additions & 2 deletions sorc/ncep_post.fd/OTLFT.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
!> @file
!> @brief otlft() computes lifted index.
!>
!> This routine computes lifts a parcel specified by the
!> This routine lifts a parcel specified by the
!> passed pressure, temperature, and specific humidity to
!> 500mb and then computes a lifted index. This lifted
!> 500mb and then computes a lifted index. This
!> lifted index is the difference between the lifted
!> parcel's temperature at 500mb and the ambient 500mb
!> temperature.
Expand All @@ -25,6 +25,22 @@
!> 2021-09-30 | JESSE MENG | 2D DECOMPOSITION
!>
!> @author Russ Treadon W/NP2 @date 1993-03-10

! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
!> otlft() computes lifted index.
!>
!> This routine lifts a parcel specified by the
!> passed pressure, temperature, and specific humidity to
!> 500mb and then computes a lifted index. This
!> lifted index is the difference between the lifted
!> parcel's temperature at 500mb and the ambient 500mb
!> temperature.
!>
!> @param[in] PBND Parcel pressure.
!> @param[in] TBND Parcel temperature.
!> @param[in] QBND Parcel specific humidity.
!> @param[out] SLINDX Lifted index.

SUBROUTINE OTLFT(PBND,TBND,QBND,SLINDX)

!
Expand Down
14 changes: 13 additions & 1 deletion sorc/ncep_post.fd/OTLIFT.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
!> @brief otlift() computes SFC to 500mb lifted index.
!>
!> This routine computes a surface to 500mb lifted index.
!> The lifted parcel is from the first atmpspheric ETA
!> The lifted parcel is from the first atmospheric ETA
!> layer (ie, the ETA layer closest to the model ground).
!> The lifted index is the difference between this parcel's
!> temperature at 500mb and the ambient 500mb temperature.
Expand All @@ -23,6 +23,18 @@
!> 2021-09-30 | JESSE MENG | 2D DECOMPOSITION
!>
!> @author Russ Treadon W/NP2 @date 1993-03-10

! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
!> otlift() computes SFC to 500mb lifted index.
!>
!> This routine computes a surface to 500mb lifted index.
!> The lifted parcel is from the first atmospheric ETA
!> layer (ie, the ETA layer closest to the model ground).
!> The lifted index is the difference between this parcel's
!> temperature at 500mb and the ambient 500mb temperature.
!>
!> @param[out] SLINDX lifted index.

SUBROUTINE OTLIFT(SLINDX)

!
Expand Down
13 changes: 7 additions & 6 deletions sorc/ncep_post.fd/ZENSUN.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,13 @@
!> This data is characterized by 74 points.
!>
!>
!> @param[in] day Julian day (positive scalar or vector), (spring equinox = 80), (summer solstice= 171), (fall equinox = 266), (winter solstice= 356).
!> @param[in] time Universal Time in hours (scalar or vector).
!> @param[in] lat Geographic latitude of point on earth's surface (degrees).
!> @param[in] lon Geographic longitude of point on earth's surface (degrees).
!> @param[out] sun_zenith - solar zenith angle.
!> @param[out] sun_azimuth - solar azimuth angle.
!> @param[in] day integer Julian day (positive scalar or vector), (spring equinox = 80), (summer solstice= 171), (fall equinox = 266), (winter solstice= 356).
!> @param[in] time real Universal Time in hours (scalar or vector).
!> @param[in] lat real Geographic latitude of point on earth's surface (degrees).
!> @param[in] lon real Geographic longitude of point on earth's surface (degrees).
!> @param[in] pi real The mathematical constant pi.
!> @param[out] sun_zenith real Solar zenith angle.
!> @param[out] sun_azimuth real Solar azimuth angle.
!>
!> ### Program history log:
!> Date | Programmer | Comments
Expand Down