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: 7th subset of marked up files #862

Merged
merged 20 commits into from
Dec 16, 2022
Merged

Doxygen: 7th subset of marked up files #862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
5c70e89
w3snl1md.F90: add doxygen markup
MatthewMasarik-NOAA Nov 9, 2022
9e0018b
w3snl2md.F90: add doxygen markup
MatthewMasarik-NOAA Nov 9, 2022
7bf04fa
w3snl3md.F90: add doxygen markup
MatthewMasarik-NOAA Nov 9, 2022
c82880e
w3snl4md.F90: add doxygen markup
MatthewMasarik-NOAA Nov 12, 2022
51ac80c
Merge branch 'NOAA-EMC:develop' into doc/doxy7
MatthewMasarik-NOAA Nov 17, 2022
56bf31f
Merge branch 'NOAA-EMC:develop' into doc/doxy7
MatthewMasarik-NOAA Nov 22, 2022
a23d1c2
w3snl5md.F90: add doxygen markup
MatthewMasarik-NOAA Dec 6, 2022
4f4d471
w3snlsmd.F90: add doxygen markup
MatthewMasarik-NOAA Dec 6, 2022
1214974
w3sis2md.F90: add doxygen markup
MatthewMasarik-NOAA Dec 6, 2022
8bc8dfb
w3sis1md.F90: add doxygen markup
MatthewMasarik-NOAA Dec 7, 2022
1663a88
w3sic5md.F90: add doxygen markup
MatthewMasarik-NOAA Dec 7, 2022
a0890b8
w3sic4md.F90: add doxygen markup
MatthewMasarik-NOAA Dec 7, 2022
2969040
w3sic2md.F90: add doxygen markup
MatthewMasarik-NOAA Dec 7, 2022
7f8a574
w3sic1md.F90: add doxygen markup
MatthewMasarik-NOAA Dec 7, 2022
ca1a841
w3snl1md.F90: grammer fix
MatthewMasarik-NOAA Dec 7, 2022
b207572
w3snl3md.F90: spelling
MatthewMasarik-NOAA Dec 7, 2022
6d2d7dd
Merge branch 'NOAA-EMC:develop' into doc/doxy7
MatthewMasarik-NOAA Dec 12, 2022
ec706b2
Merge branch 'NOAA-EMC:develop' into doc/doxy7
MatthewMasarik-NOAA Dec 13, 2022
2f5ab8e
Merge branch 'NOAA-EMC:develop' into doc/doxy7
MatthewMasarik-NOAA Dec 14, 2022
e74f356
w3snl4md.F90: remove stray '\!' characters
MatthewMasarik-NOAA Dec 14, 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
35 changes: 35 additions & 0 deletions model/src/w3sic1md.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
!> @file
!> @brief Calculate ice source term S_{ice} according to simple methods.
!>
!> @author E. Rogers
!> @author S. Zieger
!> @date 11-Oct-2013
!>

#include "w3macros.h"
!/ ------------------------------------------------------------------- /
!>
!> @brief Calculate ice source term S_{ice} according to simple methods.
!>
!> @author E. Rogers
!> @author S. Zieger
!> @date 11-Oct-2013
!>
!> @copyright Copyright 2009-2022 National Weather Service (NWS),
JessicaMeixner-NOAA marked this conversation as resolved.
Show resolved Hide resolved
!> National Oceanic and Atmospheric Administration. All rights
!> reserved. WAVEWATCH III is a trademark of the NWS.
!> No unauthorized use without permission.
!>
MODULE W3SIC1MD
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -55,6 +75,21 @@ MODULE W3SIC1MD
!/
CONTAINS
!/ ------------------------------------------------------------------- /
!>
!> @brief S_{ice} source term using 5 parameters read from input files.
!>
!> @param[in] A Action density spectrum (1-D).
!> @param[in] DEPTH Local water depth.
!> @param[in] CG Group velocities.
!> @param[in] IX Grid index.
!> @param[in] IY Grid index.
!> @param[out] S Source term (1-D version).
!> @param[out] D Diagonal term of derivative (1-D version).
!>
!> @author E. Rogers
!> @author S. Zieger
!> @date 11-Oct-2013
!>
SUBROUTINE W3SIC1 (A, DEPTH, CG, IX, IY, S, D)
!/
!/ +-----------------------------------+
Expand Down
48 changes: 48 additions & 0 deletions model/src/w3sic2md.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
!> @file
!> @brief Calculate ice dissipation source term S_{ice}.
!>
!> @author E. Rogers
!> @author S. Zieger
!> @author F. Ardhuin
!> @author G. Boutin
!> @date 05-Jan-2018
!>

#include "w3macros.h"
!/ ------------------------------------------------------------------- /
!>
!> @brief Calculate ice dissipation source term S_{ice}.
!>
!> @author E. Rogers
!> @author S. Zieger
!> @author F. Ardhuin
!> @author G. Boutin
!> @date 05-Jan-2018
!>
!> @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 W3SIC2MD
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -69,6 +93,30 @@ MODULE W3SIC2MD
!/
CONTAINS
!/ ------------------------------------------------------------------- /
!>
!> @brief S_{ice} source term using 5 parameters read from input files.
!>
!> @param[in] A Action density spectrum (1-D).
!> @param[in] DEPTH Local water depth.
!> @param[in] ICEH Ice thickness.
!> @param[in] ICEF Ice Floe diameter.
!> @param[in] CG Group velocities.
!> @param[in] WN Wavenumbers.
!> @param[in] IX Grid index.
!> @param[in] IY Grid index.
!> @param[out] S Source term (1-D version).
!> @param[out] D Diagonal term of derivative (1-D version).
!> @param[in] WN_R Wavenumbers in ice.
!> @param[in] CG_ICE Group velocities in ice.
!> @param[in] ALPHA Exponential decay rate of energy.
!> @param[in] R Ratio of energy to wave energy without ice.
!>
!> @author E. Rogers
!> @author S. Zieger
!> @author F. Ardhuin
!> @author G. Boutin
!> @date 04-Jan-2018
!>
SUBROUTINE W3SIC2 (A, DEPTH, ICEH, ICEF, CG, WN, IX, IY, S, D, WN_R, &
CG_ICE, ALPHA, R)
!/
Expand Down
39 changes: 39 additions & 0 deletions model/src/w3sic4md.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
!> @file
!> @brief Calculate ice source term S_{ice} according to simple methods.
!>
!> @author C. Collins
!> @author E. Rogers
!> @date 21-Jan-2015
!>

#include "w3macros.h"
!/ ------------------------------------------------------------------- /
!>
!> @brief Calculate ice source term S_{ice} according to simple methods.
!>
!> @details Attenuation is a function of frequency and specified directly
!> by the user. Example: a function is based on an exponential fit to
!> the empirical data of Wadhams et al. (1988).
!>
!> @author C. Collins
!> @author E. Rogers
!> @date 21-Jan-2015
!>
!> @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 W3SIC4MD
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -70,6 +94,21 @@ MODULE W3SIC4MD
!/
CONTAINS
!/ ------------------------------------------------------------------- /
!>
!> @brief S_{ice} source term using 5 parameters read from input files.
!>
!> @param[in] A Action density spectrum (1-D).
!> @param[in] DEPTH Local water depth.
!> @param[in] CG Group velocities.
!> @param[in] IX Grid index.
!> @param[in] IY Grid index.
!> @param[out] S Source term (1-D version).
!> @param[out] D Diagonal term of derivative (1-D version).
!>
!> @author C. Collins
!> @author E. Rogers
!> @date 24-Feb-2017
!>
SUBROUTINE W3SIC4 (A, DEPTH, CG, IX, IY, S, D)
!/
!/ +-----------------------------------+
Expand Down
Loading