Skip to content

doxygen documentation: 6th subset #841

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
JessicaMeixner-NOAA merged 22 commits into from
Nov 1, 2022
Merged

doxygen documentation: 6th subset #841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
319c846
ww3_outp.F90: add doxygen markup
MatthewMasarik-NOAA Oct 21, 2022
05ec7f9
ww3_outf.F90: add doxygen markup
MatthewMasarik-NOAA Oct 21, 2022
48e8297
ww3_gspl.F90: add doxygen markup
MatthewMasarik-NOAA Oct 21, 2022
78b5885
ww3_systrk.F90: finish adding doxygen. fixed previous "date" doxygen …
MatthewMasarik-NOAA Oct 24, 2022
625c11d
wmesmfmd.F90: try to fix missing documentation. not successful.
MatthewMasarik-NOAA Oct 25, 2022
0c0ffbb
w3updtmd.F90: add doxygen markup
MatthewMasarik-NOAA Oct 26, 2022
c596d51
w3uostmd.F90: add doxygen markup
MatthewMasarik-NOAA Oct 26, 2022
643e21e
w3triamd.F90: add doxygen markup
MatthewMasarik-NOAA Oct 26, 2022
e907a02
w3src3md.F90: add doxygen markup
MatthewMasarik-NOAA Oct 27, 2022
487305c
w3src4md.F90: add doxygen markup
MatthewMasarik-NOAA Oct 27, 2022
4deb777
w3src6md.F90: add doxygen markup
MatthewMasarik-NOAA Oct 27, 2022
8dacc34
w3srcemd.F90: add doxygen markup
MatthewMasarik-NOAA Oct 27, 2022
a1d4ccc
ww3_gspl.F90: fix spelling
MatthewMasarik-NOAA Oct 27, 2022
9a999be
w3updtmd.F90: fix doxygen tag, @attn -> @attention
MatthewMasarik-NOAA Oct 27, 2022
a1f379a
ww3_gspl.F90: fix spelling, intent attribute
MatthewMasarik-NOAA Oct 27, 2022
045eab4
ww3_gspl.F90: grammer fixes
MatthewMasarik-NOAA Oct 27, 2022
78ae22b
w3updtmd.F90: spelling fix
MatthewMasarik-NOAA Oct 27, 2022
e986e12
w3updtmd.F90: doxygen formatting correction
MatthewMasarik-NOAA Oct 27, 2022
9ca8170
w3uostmd.F90: spelling fix
MatthewMasarik-NOAA Oct 27, 2022
ebcd8b7
w3uostmd.F90: attempts to get subs/funcs to render in doxygen
MatthewMasarik-NOAA Oct 27, 2022
f0a870a
w3triamd.F90: spelling
MatthewMasarik-NOAA Oct 27, 2022
3ad2b88
w3src3md.F90: left of @brief for w3sin3()
MatthewMasarik-NOAA Oct 27, 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
158 changes: 158 additions & 0 deletions model/src/w3src3md.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
!> @file
!> @brief The 'WAM4+' source terms based on P.A.E.M. Janssen's work, with
!> extensions by him and by J.-R. Bidlot.
!>
!> @author F. Ardhuin
!> @author H. L. Tolman
!> @date 02-Sep-2012
!>

#include "w3macros.h"
!/ ------------------------------------------------------------------- /

!>
!> @brief The 'WAM4+' source terms based on P.A.E.M. Janssen's work, with
!> extensions by him and by J.-R. Bidlot.
!>
!> @details Converted from the original WAM codes by F. Ardhuin,
!> with further extensions to adapt to a saturation-based breaking
!> and observation-based swell dissipation.
!>
!> @author F. Ardhuin
!> @author H. L. Tolman
!> @date 02-Sep-2012
!>
!> @copyright Copyright 2009-2022 National Weather Service (NWS),
!> National Oceanic and Atmospheric Administration. All rights
!> reserved. WAVEWATCH III is a trademark of the NWS.
!> No unauthorized use without permission.
!>
MODULE W3SRC3MD
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -75,6 +102,35 @@ MODULE W3SRC3MD
!/
CONTAINS
!/ ------------------------------------------------------------------- /

!>
!> @brief Calculate mean wave parameters for the use in the source term
!> routines.
!>
!> @param[in] A Action density spectrum.
!> @param[in] CG Group velocities.
!> @param[in] WN Wavenumbers.
!> @param[out] EMEAN Energy.
!> @param[out] FMEAN Mean frequency for determination of tail.
!> @param[out] FMEANS Mean frequency for dissipation source term.
!> @param[out] WNMEAN Mean wavenumber.
!> @param[out] AMAX Maximum of action spectrum.
!> @param[in] U Wind speed.
!> @param[in] UDIR Wind direction.
!> @param[inout] USTAR Friction velocity
!> @param[inout] USDIR Wind stress direction.
!> @param[in] TAUWX Component of wave-supported stress.
!> @param[in] TAUWY Component of wave-supported stress.
!> @param[out] CD Drag coefficient at wind level ZWND.
!> @param[out] Z0 Corresponding z0.
!> @param[out] CHARN
!> @param[in] LLWS Wind sea true/false array for each component.
!> @param[out] FMEANWS Mean frequency of wind sea, used for tail.
!>
!> @author F. Ardhuin
!> @author H. L. Tolman
!> @date 17-Oct-2007
!>
SUBROUTINE W3SPR3 (A, CG, WN, EMEAN, FMEAN, FMEANS, WNMEAN, &
AMAX, U, UDIR, USTAR, USDIR, TAUWX, TAUWY, CD, Z0,&
CHARN, LLWS, FMEANWS)
Expand Down Expand Up @@ -290,6 +346,41 @@ SUBROUTINE W3SPR3 (A, CG, WN, EMEAN, FMEAN, FMEANS, WNMEAN, &
!/
END SUBROUTINE W3SPR3
!/ ------------------------------------------------------------------- /

!>
!> @brief Calculate diagonal and input source term for WAM4+ approach.
!>
!> @verbatim
!> WAM-4 : Janssen et al.
!> WAM-"4.5" : gustiness effect (Cavaleri et al. )
!> SWELLF: damping coefficient (=1) for Janssen (2004) theory
!> @endverbatim
!>
!> @param[in] A Action density spectrum (1-D).
!> @param[in] CG Group speed.
!> @param[in] K Wavenumber for entire spectrum.
!> @param[in] U Wind speed.
!> @param[in] USTAR Friction velocity.
!> @param[in] DRAT Air/water density ratio.
!> @param[in] AS Air-sea temperature difference.
!> @param[in] USDIR Wind stress direction.
!> @param[in] Z0 Air-sea roughness length.
!> @param[in] CD Wind drag coefficient.
!> @param[out] TAUWX Component of the wave-supported stress.
!> @param[out] TAUWY Component of the wave-supported stress.
!> @param[out] TAUWNX Component of the negative wave-supported stress.
!> @param[out] TAUWNY Component of the negative wave-supported stress.
!> @param[in] ICE Sea ice fraction.
!> @param[out] S Source term (1-D version).
!> @param[out] D Diagonal term of derivative.
!> @param[out] LLWS Wind sea true/false array for each component.
!> @param[in] IX
!> @param[in] IY
!>
!> @author F. Ardhuin
!> @author H. L. Tolman
!> @date 02-Sep-2012
!>
SUBROUTINE W3SIN3 (A, CG, K, U, USTAR, DRAT, AS, USDIR, Z0, CD, &
TAUWX, TAUWY, TAUWNX, TAUWNY, ICE, S, D, LLWS, IX, IY)
!/
Expand Down Expand Up @@ -625,6 +716,13 @@ SUBROUTINE W3SIN3 (A, CG, K, U, USTAR, DRAT, AS, USDIR, Z0, CD, &
!/
END SUBROUTINE W3SIN3
!/ ------------------------------------------------------------------- /

!>
!> @brief Initialization for source term routine.
!>
!> @author F. Ardhuin
!> @date 23-Jul-2009
!>
SUBROUTINE INSIN3
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -714,6 +812,13 @@ SUBROUTINE INSIN3
!/
END SUBROUTINE INSIN3
! ----------------------------------------------------------------------

!>
!> @brief To generate the friction velocity table, TAUT(TAUW,U10)=SQRT(TAU).
!>
!> @author F. Ardhuin
!> @date 17-Oct-2007
!>
SUBROUTINE TABU_STRESS
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -837,6 +942,19 @@ SUBROUTINE TABU_STRESS
RETURN
END SUBROUTINE TABU_STRESS
!/ ------------------------------------------------------------------- /

!>
!> @brief Tabulation of the high-frequency wave-supported stress.
!>
!> @details SEE REFERENCE FOR WAVE STRESS CALCULATION.
!> FOR QUASILINEAR EFFECT SEE PETER A.E.M. JANSSEN,1990.
!> See tech. Memo ECMWF 03 december 2003 by Bidlot & Janssen.
!>
!> @param[in] FRMAX Maximum frequency.
!>
!> @author F. Ardhuin
!> @date 14-Aug-2006
!>
SUBROUTINE TABU_TAUHF(FRMAX)
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -999,6 +1117,21 @@ END SUBROUTINE TABU_TAUHF
!/ ------------------------------------------------------------------- /

!/ ------------------------------------------------------------------- /

!>
!> @brief Compute friction velocity based on wind speed U10.
!>
!> @details Computation of u* based on Quasi-linear theory.
!>
!> @param[in] WINDSPEED 10-m wind speed ... should be NEUTRAL
!> @param[in] TAUW Wave-supported stress.
!> @param[out] USTAR Friction velocity.
!> @param[out] Z0 Air-side roughness length.
!> @param[out] CHARN
!>
!> @author F. Ardhuin
!> @date 14-Aug-2006
!>
SUBROUTINE CALC_USTAR(WINDSPEED,TAUW,USTAR,Z0,CHARN)
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -1093,6 +1226,31 @@ SUBROUTINE CALC_USTAR(WINDSPEED,TAUW,USTAR,Z0,CHARN)
RETURN
END SUBROUTINE CALC_USTAR
!/ ------------------------------------------------------------------- /

!>
!> @brief Calculate whitecapping source term and diagonal term of derivative.
!>
!> @details WAM-Cycle 4 and following.
!> The last update (09-May-2005) follows the redefinition of
!> the mean wavenumber as in Bidlot et al. (2005).
!>
!> @param[in] A Action density spectrum (1-D).
!> @param[in] K Wavenumber for entire spectrum.
!> @param[in] CG
!> @param[in] EMEAN Mean wave energy.
!> @param[in] FMEAN Mean wave frequency.
!> @param[in] WNMEAN Mean wavenumber.
!> @param[in] USTAR Friction velocity.
!> @param[in] USDIR Wind stress direction.
!> @param[in] DEPTH Water depth.
!> @param[out] S Source term (1-D version).
!> @param[out] D Diagonal term of derivative.
!> @param[in] IX
!> @param[in] IY
!>
!> @author F. Ardhuin
!> @date 23-Jul-2009
!>
SUBROUTINE W3SDS3 (A, K, CG, EMEAN, FMEAN, WNMEAN, USTAR, USDIR, &
DEPTH, S, D, IX, IY)
!/
Expand Down
Loading