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 CALDRG.f #424

Merged
merged 4 commits into from
Dec 27, 2021
Merged

Doxygen CALDRG.f #424

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cfda600
Doxygen for CALDRG.f
kayeekayee Dec 23, 2021
575cd93
Delete CALDWP.f
kayeekayee Dec 23, 2021
879dcca
Revert "Delete CALDWP.f"
kayeekayee Dec 23, 2021
2f925b1
Merge branch 'NOAA-EMC:develop' into doxygen_CALDRG
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
54 changes: 16 additions & 38 deletions sorc/ncep_post.fd/CALDRG.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,20 @@
!> @file
!
!> SUBPROGRAM: CALDRG COMPUTE DRAG COEFFICIENT
!! PRGRMMR: TREADON ORG: W/NP2 DATE: 93-09-01
!!
!! ABSTRACT: THIS ROUTINE COMPUTES A SURFACE LAYER DRAG
!! COEFFICIENT USING EQUATION (7.4.1A) IN "AN INTRODUCTION
!! TO BOUNDARY LAYER METEOROLOGY" BY STULL (1988, KLUWER
!! ACADEMIC PUBLISHERS).
!!
!! PROGRAM HISTORY LOG:
!! 93-09-01 RUSS TREADON
!! 98-06-15 T BLACK - CONVERSION FROM 1-D TO 2-D
!! 00-01-04 JIM TUCCILLO - MPI VERSION
!! 02-01-15 MIKE BALDWIN - WRF VERSION
!! 05-02-22 H CHUANG - ADD WRF NMM COMPONENTS
!!
!! USAGE: CALL CALDRG(DRAGCO)
!! INPUT ARGUMENT LIST:
!! NONE
!!
!! OUTPUT ARGUMENT LIST:
!! DRAGCO - SURFACE LAYER DRAG COEFFICIENT
!!
!! OUTPUT FILES:
!! NONE
!!
!! SUBPROGRAMS CALLED:
!! UTILITIES:
!! NONE
!! LIBRARY:
!! COMMON - LOOPS
!! SRFDSP
!! PVRBLS
!!
!! ATTRIBUTES:
!! LANGUAGE: FORTRAN 90
!! MACHINE : CRAY C-90
!!
!> @brief Subroutine that computes drag cofficient.
Copy link
Collaborator

Choose a reason for hiding this comment

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

On the NCEPLIBS documentation, we put an author for every file, and for every subroutine in the file.

!
!> This rountine computes a surface layer drag coefficient using
!> equation (7.4.1A) in "An introduction to boundary layer
!> meteorology" by Stull (1988, Kluwer Academic Publishers).
!>
Copy link
Collaborator

Choose a reason for hiding this comment

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

FYI you can also include links in the documentation. For example:

!> This rountine computes a surface layer drag coefficient using
!> equation (7.4.1A) in ["An introduction to boundary layer
!> meteorology" by Stull (1988, Kluwer Academic 
!> Publishers)](https://link.springer.com/book/10.1007/978-94-009-3027-8).

!> @param[out] DRAGCO surface layer drag coefficient
!>
!> Program history
!> - 93-09-01 Russ Treadon
!> - 98-06-15 T Black - Conversion from 1-D to 2-D
!> - 00-01-04 Jim Tuccillo - MPI version
!> - 02-01-15 Mike Baldwin - WRF version
!> - 05-02-22 H Chuang - Add WRF NMM components
!>
!> @author Russ Treadon W/NP2 @date 1993-09-01
SUBROUTINE CALDRG(DRAGCO)

!
Expand Down