Skip to content

Doxygen in BOUND.f #487

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 1 commit into from
Apr 27, 2022
Merged

Doxygen in BOUND.f #487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 25 additions & 40 deletions sorc/ncep_post.fd/BOUND.f
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,30 @@
!> @file
!
!> @brief bound() clips data in passed array.
!>
!> @author Russ Treadon W/NP2 @date 1993-01-18

!> This routine bounds data in the passed array
!> FLD (im x jm elements long) and clips data values such
!> that on exiting the routine
!> @code
!> FMIN <= FLD(I,J) <= FMAX
!> @endcode
!> for all points.
!>
!> @param[in] FMIN Lower (inclusive) bound for data.
!> @param[in] FMAX Upper (inclusive) bound for data.
!> @param[out] FLD Array whose elements are bounded by [FMIN,FMAX].
!>
!> ### Program History Log
!> Date | Programmer | Comments
!> -----|------------|---------
!> 1993-01-18 | Russ Treadon | Initial
!> 1993-05-07 | Russ Treadon | Added DOCBLOC
!> 1998-05-29 | T Black | Conversion from 1-D to 2-D
!> 2000-01-04 | Jim Tuccillo | MPI Version
!> 2002-04-24 | Mike Baldwin | WRF Version
!>
!! . . .
!! SUBPROGRAM: BOUND CLIPS DATA IN PASSED ARRAY
!! PRGRMMR: TREADON ORG: W/NP2 DATE: 93-01-18
!!
!! ABSTRACT: THIS ROUTINE BOUNDS DATA IN THE PASSED ARRAY
!! FLD (IMxJM ELEMENTS LONG) AND CLIPS DATA VALUES SUCH
!! THAT ON EXITING THE ROUTINE
!! FMIN <= FLD(I,J) <= FMAX
!! FOR ALL POINTS.
!!
!!
!! PROGRAM HISTORY LOG:
!! 93-01-18 RUSS TREADON
!! 93-05-07 RUSS TREADON - ADDED DOCBLOC
!! 98-05-29 BLACK - CONVERSION FROM 1-D TO 2-D
!! 00-01-04 JIM TUCCILLO - MPI VERSION
!! 02-04-24 MIKE BALDWIN - WRF VERSION
!!
!! USAGE: CALL bound(fld,fmin,fmax)
!! INPUT ARGUMENT LIST:
!! FMIN - LOWER (INCLUSIVE) BOUND FOR DATA.
!! FMAX - UPPER (INCLUSIVE) BOUND FOR DATA.
!!
!! OUTPUT ARGUMENT LIST:
!! FLD - ARRAY WHOSE ELEMENTS ARE BOUNDED BY [FMIN,FMAX].
!!
!! OUTPUT FILES:
!! NONE
!!
!! SUBPROGRAMS CALLED:
!! UTILITIES:
!! NONE
!! LIBRARY:
!! NONE
!!
!! ATTRIBUTES:
!! LANGUAGE: FORTRAN 90
!! MACHINE : CRAY C-90
!!
!> @author Russ Treadon W/NP2 @date 1993-01-18
SUBROUTINE BOUND(FLD,FMIN,FMAX)

!
Expand Down