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

Doxygen for CALDWP.f #423

Merged
merged 2 commits into from
Dec 23, 2021
Merged

Doxygen for CALDWP.f #423

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a812f98
Doxygen for CALDWP.f
kayeekayee Dec 21, 2021
2d58e3a
Further refinement.
kayeekayee Dec 23, 2021
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
55 changes: 18 additions & 37 deletions sorc/ncep_post.fd/CALDWP.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,23 @@
!> @file
!> @brief Subroutine related to dewpoint temperature.
!
!> SUBPROGRAM: CALDWP COMPUTES
!! PRGRMMR: TREADON ORG: W/NP2 DATE: 92-12-22
!!
!! ABSTRACT: COMPUTES DEWPOINT FROM P, T, AND Q
!!
!! PROGRAM HISTORY LOG:
!! 92-12-22 RUSS TREADON
!! 93-10-04 RUSS TREADON - ADDED CHECK TO BOUND DEWPOINT
!! TEMPERATURE TO NOT EXCEED THE
!! AMBIENT TEMPERATURE.
!! 98-06-08 T BLACK - CONVERSION FROM 1-D TO 2-D
!! 00-01-04 JIM TUCCILLO - MPI VERSION
!! 21-07-23 Wen Meng - Retrict computation from undefined points
!!
!! USAGE: CALL CALDWP(P1D,Q1D,TDWP,T1D)
!! INPUT ARGUMENT LIST:
!! P1D - PRESSURE (PA)
!! Q1D - SPECIFIC HUMIDITY (KG/KG)
!! T1D - TEMPERATURE (K)
!!
!! OUTPUT ARGUMENT LIST:
!! TDWP - DEWPOINT TEMPERATURE (K)

!!
!! OUTPUT FILES:
!! NONE
!!
!! SUBPROGRAMS CALLED:
!! UTILITIES:
!! DEWPOINT - COMPUTES DEWPOINT GIVEN VAPOR PRESSURE.
!! LIBRARY:
!! NONE
!!
!! ATTRIBUTES:
!! LANGUAGE: FORTRAN 90
!! MACHINE : CRAY C-90
!!
!> Computes dewpoint from P, T, and Q
kayeekayee marked this conversation as resolved.
Show resolved Hide resolved
!>
!> @param[in] P1D Pressure (Pa)
!> @param[in] Q1D Specific humidity (kg/kg)
!> @param[in] T1D Temperature (K)
!> @param[out] TDWP Dewpoint temperature (K)
!>
!> Program history
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have been making these into tables instead of lists, and it looks nice. So something like this:

!> ### Program History Log
!> Date | Programmer | Comments
!> -----|------------|---------
!> 2003-06-06 | Gilbert | Initial
!> 2008-05-14 | Vuong | Added the option -m0 (No explicit missing values included within the datavalues, modified the options and help messages
!> 2010-12-02 | Vuong | Changed Master Table Version Number from 2 to 6. Add option -mastertable_ver_x where x is mater table version 2 to 10

You may choose to do the same, or keep on making it a list. The UPP team should get together and decide...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fossell @hertneky

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kayeekayee - I just looked at an example in NCEPLIBS and it looks quite nice as a table, much more readable. I recommend we do the same for UPP. Thanks for the suggestion @edwardhartnett.

!> - 92-12-22 Russ Treadon
!> - 93-10-04 Russ Treadon - Added check to bound dewpoint
!> temperature to not exceed the
!> ambient temperature.
!> - 98-06-08 T BLACK - Conversion from 1-D to 2-D
!> - 00-01-04 Jim Tuccillo - MPI version
!> - 21-07-23 Wen Meng - Retrict computation from undefined points
!>
!> @author Russ Treadon W/NP2 @date 1992-12-22
SUBROUTINE CALDWP(P1D,Q1D,TDWP,T1D)

!
Expand Down