Doxygen marked files. Forth subset.

model/src/w3idatmd.F90

@@ -1,4 +1,17 @@
+!> @file
+!> @brief Define data structures to set up wave model input data for
+!>  several models simultaneously.
+!> 
+!> @author H. L. Tolman @date 22-Mar-2021
+!>
+
 #include "w3macros.h"
+
+!> @brief Define data structures to set up wave model input data for
+!>  several models simultaneously.
+!> 
+!> @author H. L. Tolman @date 22-Mar-2021
+!>
 !/ ------------------------------------------------------------------- /
       MODULE W3IDATMD
 !/
@@ -257,6 +270,16 @@ MODULE W3IDATMD
 !/
       CONTAINS
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Set up the number of grids to be used.
+!>
+!> @details Use data stored in NGRIDS in W3GDATMD.
+!>
+!> @param[in] NDSE  Error output unit number.
+!> @param[in] NDST  Test output unit number.
+!>
+!> @author H. L. Tolman  @date 22-Mar-2021
+!>        
       SUBROUTINE W3NINP ( NDSE, NDST )
 !/
 !/                  +-----------------------------------+
@@ -399,6 +422,19 @@ SUBROUTINE W3NINP ( NDSE, NDST )
 !/
       END SUBROUTINE W3NINP
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Initialize an individual data grid at the proper dimensions.
+!>
+!> @details Allocate directly into the structure array. Note that
+!>  this cannot be done through the pointer alias!
+!>
+!> @param[in] IMOD Model number to point to.
+!> @param[in] NDSE Error output unit number.
+!> @param[in] NDST Test output unit number.
+!> @param[in] FLAGSTIDEIN 
+!>
+!> @author H. L. Tolman  @date 22-Mar-2021
+!>      
       SUBROUTINE W3DIMI  ( IMOD, NDSE, NDST, FLAGSTIDEIN )
 !/
 !/                  +-----------------------------------+
@@ -774,6 +810,18 @@ SUBROUTINE W3DIMI  ( IMOD, NDSE, NDST, FLAGSTIDEIN )
 !/
       END SUBROUTINE W3DIMI
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Select one of the WAVEWATCH III grids / models.
+!>
+!> @details Point pointers to the proper variables in the proper element of
+!>  the GRIDS array.
+!>
+!> @param[in] IMOD  Model number to point to.
+!> @param[in] NDSE  Error output unit number.
+!> @param[in] NDST  Test output unit number.
+!>
+!> @author H. L. Tolman  @date 22-Mar-2021
+!>      
       SUBROUTINE W3SETI ( IMOD, NDSE, NDST )
 !/
 !/                  +-----------------------------------+

model/src/w3igcmmd.F90

@@ -1,4 +1,16 @@
+!> @file
+!> @brief Module used for coupling applications between ice model and WW3 with OASIS3-MCT.
+!> 
+!> @author G. Boutin  @date Aug-2016
+!>
+
 #include "w3macros.h"
+
+!>
+!> @brief Module used for coupling applications between ice model and WW3 with OASIS3-MCT. 
+!> 
+!> @author G. Boutin @date Aug-2016
+!>
 !/ ------------------------------------------------------------------- /
       MODULE W3IGCMMD
 !/
@@ -56,6 +68,11 @@ MODULE W3IGCMMD
 !
       CONTAINS
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Send coupling fields to ice model.
+!>
+!> @author G. Boutin  @date Aug-2016
+!>
       SUBROUTINE SND_FIELDS_TO_ICE()
 !/
 !/                  +-----------------------------------+
@@ -149,6 +166,17 @@ SUBROUTINE SND_FIELDS_TO_ICE()
 !/ ------------------------------------------------------------------- /
       END SUBROUTINE SND_FIELDS_TO_ICE
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Receive coupling fields from ice model.
+!>
+!> @param[in] ID_LCOMM  MPI communicator.
+!> @param[in] IDFLD  Name of the exchange fields.
+!> @param[inout] FXN  First exchange field.
+!> @param[inout] FYN  Second exchange field.
+!> @param[inout] FAN  Third exchange field.
+!>
+!> @author G. Boutin  @date Apr-2016
+!>      
       SUBROUTINE RCV_FIELDS_FROM_ICE(ID_LCOMM, IDFLD, FXN, FYN, FAN)
 !/
 !/                  +-----------------------------------+

model/src/w3initmd.F90

@@ -1,4 +1,15 @@
+!> @file
+!> @brief Contains module W3INITMD.
+!> 
+!> @author H. L. Tolman  @date 22-Mar-2021
+!>
+
 #include "w3macros.h"
+!> 
+!> @brief Contains module W3INITMD.
+!> 
+!> @author H. L. Tolman  @date 22-Mar-2021
+!>
 !/ ------------------------------------------------------------------- /
       MODULE W3INITMD
 !/
@@ -118,6 +129,33 @@ MODULE W3INITMD
 !/
       CONTAINS
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Initialize WAVEWATCH III.
+!>
+!> @details Initialize data structure and wave fields from data files.
+!>  Initialize grid from local and instantaneous data.
+!>
+!> @param[in] IMOD        Model number.
+!> @param[in] IsMulti  
+!> @param[in] FEXT        Extension of data files.
+!> @param[in] MDS         Array with dataset numbers saved as NDS in W3ODATMD.
+!> @param[in] MTRACE      Array with subroutine tracing information.
+!> @param[in] ODAT        Output data, five parameters per output type.
+!> @param[inout] FLGRD    Flags for gridded output.
+!> @param[inout] FLGR2    Flags for coupling output.
+!> @param[inout] FLGD     
+!> @param[inout] FLG2 
+!> @param[in] NPT           Number of output points.
+!> @param[inout] XPT        Coordinates of output points.
+!> @param[inout] YPT        Coordinates of output points.
+!> @param[in] PNAMES        Output point names.
+!> @param[in] IPRT          Partitioning grid info. 
+!> @param[inout] PRTFRM     Partitioning format flag.
+!> @param[in] MPI_COMM      MPI communicator to be used for model.
+!> @param[in] FLAGSTIDEIN
+!>
+!> @author H. L. Tolman  @date 03-Sep-2012
+!>        
       SUBROUTINE W3INIT ( IMOD, IsMulti, FEXT, MDS, MTRACE, ODAT      &
                           , FLGRD,                               &
                            FLGR2, FLGD, FLG2, NPT, XPT, YPT, PNAMES,   &
@@ -2039,6 +2077,19 @@ SUBROUTINE W3INIT ( IMOD, IsMulti, FEXT, MDS, MTRACE, ODAT      &
 !/
       END SUBROUTINE W3INIT
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Perform initializations for MPI version of model.
+!>  Data transpose only.
+!>
+!> @details Some derived data types are defined.  All communiction in
+!>  W3GATH, W3SCAT and W3WAVE are initialized so that all
+!>  communication can be performed with single MPI_STARTALL,
+!>  MPI_TESTALL and MPI_WAITALL calls.
+!>
+!> @param[in] IMOD  Model number.
+!>
+!> @author H. L. Tolman  @date 11-May-2007
+!>      
       SUBROUTINE W3MPII ( IMOD )
 !/
 !/                  +-----------------------------------+
@@ -2450,6 +2501,19 @@ SUBROUTINE W3MPII ( IMOD )
 !/
       END SUBROUTINE W3MPII
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Prepare MPI persistent communication needed for WAVEWATCH I/O
+!>  routines.
+!>
+!> @details Create handles as needed. The communication as set up 
+!>  in W3MPII uses tags with number ranging from 1 through NSPEC. 
+!>  New and unique tags for IO related communication are assigned 
+!>  here dynamically. No testing on IMOD, since only called by W3INIT.
+!>
+!> @param[in] IMOD  Model number.
+!>
+!> @author H. L. Tolman  @date 11-Nov-2015
+!>      
       SUBROUTINE W3MPIO ( IMOD )
 !/
 !/                  +-----------------------------------+
@@ -6832,6 +6896,16 @@ SUBROUTINE W3MPIO ( IMOD )
 !/
       END SUBROUTINE W3MPIO
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Prepare MPI persistent communication needed for WAVEWATCH I/O
+!>  routines.
+!>
+!> @details Create handles as needed.
+!>
+!> @param[in] IMOD  Model number.
+!>
+!> @author H. L. Tolman  @date 30-Oct-2009
+!>      
       SUBROUTINE W3MPIP ( IMOD )
 !/
 !/                  +-----------------------------------+

model/src/w3iobcmd.F90

@@ -1,5 +1,16 @@
+!> @file
+!> @brief Processing of boundary data output.
+!> 
+!> @author H. L. Tolman @date 01-Mar-2018
+!> 
+
 #include "w3macros.h"
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Processing of boundary data output.
+!> 
+!> @author H. L. Tolman @date 01-Mar-2018
+!>
       MODULE W3IOBCMD
 !/
 !/                  +-----------------------------------+
@@ -68,6 +79,22 @@ MODULE W3IOBCMD
 !/
       CONTAINS
 !/ ------------------------------------------------------------------- /
+!>
+!> @brief Write/read boundary conditions file(s).
+!>
+!> @details The file(s) are opened within the routine, the names are
+!>  pre-defined as nest.FILEXT for the input file and nest1.FILEXT
+!>  through nest9.FILEXT for up to 9 output files.
+!>
+!> @param[inout] INXOUT  Test string for read/write.
+!> @param[inout] NDSB    Data set unit number.
+!> @param[inout] TIME1   Present time (w), time of first field (r).
+!> @param[inout] TIME2   Time of second field.
+!> @param[inout] IOTST   Test indictor for reading.
+!> @param[inout] IMOD    Optional grid number, defaults to 1.
+!>
+!> @author H. L. Tolman  @date 20-Jan-2017
+!>        
       SUBROUTINE W3IOBC ( INXOUT, NDSB, TIME1, TIME2, IOTST, IMOD )
 !/
 !/                  +-----------------------------------+