Skip to content

Commit

Permalink
Doxygen documentation added, 8th subset.(#1046)
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewMasarik-NOAA authored Aug 7, 2023
1 parent dcafc8c commit 2715a9e
Show file tree
Hide file tree
Showing 13 changed files with 1,303 additions and 106 deletions.
42 changes: 42 additions & 0 deletions model/src/gx_outf.F90
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
!> @file
!> @brief Generate GrADS input files from raw WAVEWATCH data file.
!>
!> @author H. L. Tolman
!> @author A. Chawla
!> @author J.H.G.M. Alves
!> @date 22-Mar-2021
!>
#include "w3macros.h"

!/ ------------------------------------------------------------------- /
!>
!> @brief Generate GrADS input files from raw WAVEWATCH data file.
!>
!> @details
!> Data is read from the grid output file out_grd.ww3 (raw data)
!> and from the file gx_outf.inp ( NDSI, output requests ).
!> Model definition and raw data files are read using WAVEWATCH III
!> subroutines.
!>
!> Output files are ww3.ctl and ww3.grads. The output files
!> contains a land-sea map, followed by requested fields. See the
!> control file for the names of the fields.
!>
!> @author H. L. Tolman
!> @author A. Chawla
!> @author J.H.G.M. Alves
!> @date 22-Mar-2021
!>
!> @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.
!>
PROGRAM GXOUTF
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -740,6 +772,16 @@ PROGRAM GXOUTF
!/
CONTAINS
!/ ------------------------------------------------------------------- /
!>
!> @brief Perform actual output for GrADS postprocessing.
!>
!> @param[in] NX Grid dimensions.
!> @param[in] NY Grid dimensions.
!> @param[in] NSEA Number of sea points.
!>
!> @author H. L. Tolman
!> @date 22-Mar-2021
!>
SUBROUTINE GXEXGO ( NX, NY, NSEA )
!/
!/ +-----------------------------------+
Expand Down
28 changes: 28 additions & 0 deletions model/src/gx_outp.F90
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
!> @file
!> @brief Post-processing of point output for GrADS post-processing.
!>
!> @author H. L. Tolman
!> @author J.H. Alves
!> @author F. Ardhuin
!> @date 27-Aug-2015
!>

#include "w3macros.h"
!/ ------------------------------------------------------------------- /
!>
!> @brief Post-processing of point output for GrADS post-processing.
!>
!> @author H. L. Tolman
!> @author J.H. Alves
!> @author F. Ardhuin
!> @date 27-Aug-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.
!>
PROGRAM GXOUTP
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -539,6 +561,12 @@ PROGRAM GXOUTP
!/
CONTAINS
!/ ------------------------------------------------------------------- /
!>
!> @brief Perform actual point output.
!>
!> @author H. L. Tolman
!> @date 16-Jul-2012
!>
SUBROUTINE GXEXPO
!/
!/ +-----------------------------------+
Expand Down
Loading

0 comments on commit 2715a9e

Please sign in to comment.