From 3cfa5afc29726b25d18458ebde799eceb1a71634 Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Mon, 26 Sep 2022 18:46:54 -0400 Subject: [PATCH 01/10] w3agcmmd.F90: add doxygen markup --- model/src/w3agcmmd.F90 | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/model/src/w3agcmmd.F90 b/model/src/w3agcmmd.F90 index ddc40064e9..61d9768bc8 100644 --- a/model/src/w3agcmmd.F90 +++ b/model/src/w3agcmmd.F90 @@ -1,5 +1,25 @@ +!> @file +!> @brief Contains module used for coupling applications between atmospheric model +!> and WW3 with OASIS3-MCT. +!> +!> @author J. Pianezze +!> @date Mar-2021 +!> + #include "w3macros.h" !/ ------------------------------------------------------------------- / +!> +!> @brief Module used for coupling applications between atmospheric model +!> and WW3 with OASIS3-MCT. +!> +!> @author J. Pianezze +!> @date 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. +!> MODULE W3AGCMMD !/ !/ +-----------------------------------+ @@ -59,6 +79,13 @@ MODULE W3AGCMMD ! CONTAINS !/ ------------------------------------------------------------------- / + +!> +!> @brief Send coupling fields to atmospheric model. +!> +!> @author J. Pianezze +!> @date Apr-2016 +!> SUBROUTINE SND_FIELDS_TO_ATMOS() !/ !/ +-----------------------------------+ @@ -192,6 +219,19 @@ SUBROUTINE SND_FIELDS_TO_ATMOS() ! !/ ------------------------------------------------------------------- / END SUBROUTINE SND_FIELDS_TO_ATMOS + +!> +!> @brief Receive coupling fields from atmospheric 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 J. Pianezze +!> @date Mar-2021 +!> !/ ------------------------------------------------------------------- / SUBROUTINE RCV_FIELDS_FROM_ATMOS(ID_LCOMM, IDFLD, FXN, FYN, FAN) !/ From 2c7092832f8956e86eaf17f8547c57f481d8d0a9 Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Mon, 26 Sep 2022 19:22:42 -0400 Subject: [PATCH 02/10] w3bullmd.F90: add doxygen markup --- model/src/w3bullmd.F90 | 44 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/model/src/w3bullmd.F90 b/model/src/w3bullmd.F90 index 9bf9997a27..2d5b0352b8 100644 --- a/model/src/w3bullmd.F90 +++ b/model/src/w3bullmd.F90 @@ -1,5 +1,25 @@ +!> @file +!> @brief Contains module W3BULLMD. +!> +!> @author J. H. Alves +!> @author H. L. Tolman +!> @date 26-Dec-2012 +!> + #include "w3macros.h" !/ ------------------------------------------------------------------- / +!> +!> @brief Module W3BULLMD. +!> +!> @author J. H. Alves +!> @author H. L. Tolman +!> @date 26-Dec-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 W3BULLMD !/ !/ +-----------------------------------+ @@ -42,6 +62,30 @@ MODULE W3BULLMD !/ CONTAINS !/ ------------------------------------------------------------------- / +!> +!> @brief Read a WAVEWATCH-III version 1.17 point output data file and +!> produces a table of mean parameters for all individual wave +!> systems. +!> +!> @details Partitioning is made using the built-in module w3partmd. +!> Partitions are ranked and organized into coherent sequences that +!> are then written as tables to output files. Input options for generating +!> tables are defined in ww3_outp.inp. This module sorts the table +!> data, output to file is controlled by WW3_OUTP. +!> +!> @param[in] NPART +!> @param[in] XPART +!> @param[in] DIMXP +!> @param[in] UABS +!> @param[in] UD +!> @param IPNT +!> @param[in] IOUT +!> @param[inout] TIMEV +!> +!> @author J. H. Alves +!> @author H. L. Tolman +!> @date 11-Mar-2013 +!> SUBROUTINE W3BULL & ( NPART, XPART, DIMXP, UABS, UD, IPNT, IOUT, TIMEV ) !/ From 12b34e048455d0fcd4b3ba6bd71fae5b1af28d63 Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Mon, 26 Sep 2022 19:44:20 -0400 Subject: [PATCH 03/10] w3cspcmd.F90: add doxygen markup --- model/src/w3cspcmd.F90 | 43 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/model/src/w3cspcmd.F90 b/model/src/w3cspcmd.F90 index 15594b2aea..c4bbfc78ad 100644 --- a/model/src/w3cspcmd.F90 +++ b/model/src/w3cspcmd.F90 @@ -1,5 +1,23 @@ +!> @file +!> @brief Convert spectra to new discrete spectral grid. +!> +!> @author H. L. Tolman +!> @date 01-Nov-2012 +!> + #include "w3macros.h" !/ ------------------------------------------------------------------- / +!> +!> @brief Convert spectra to new discrete spectral grid. +!> +!> @author H. L. Tolman +!> @date 01-Nov-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 W3CSPCMD !/ !/ +-----------------------------------+ @@ -97,6 +115,31 @@ MODULE W3CSPCMD !/ CONTAINS !/ ------------------------------------------------------------------- / +!> +!> @brief Convert a set of spectra to a new spectral grid. +!> +!> @details Conservative distribution of input energies over new grid. +!> +!> @param[in] SP1 Input spectra. +!> @param[in] NFR1 Input number of frequencies. +!> @param[in] NTH1 Input number of directions. +!> @param[in] XF1 Input frequency increment factor. +!> @param[in] FR1 First input frequency. +!> @param[in] TH1 First input direction. +!> @param[out] SP2 Output spectra. +!> @param[in] NFR2 Output number of frequencies. +!> @param[in] NTH2 Output number of directions. +!> @param[in] XF2 Output frequency increment factor. +!> @param[in] FR2 First output frequency. +!> @param[in] TH2 First output direction. +!> @param[in] NSP Number of spectra. +!> @param[in] NDST Unit number for test output. +!> @param[in] NDSE Unit number for error output. +!> @param[in] FTL Factor for tail description = XF2**N. +!> +!> @author H. L. Tolman +!> @date 01-Nov-2012 +!> SUBROUTINE W3CSPC ( SP1, NFR1, NTH1, XF1, FR1, TH1, & SP2, NFR2, NTH2, XF2, FR2, TH2, & NSP, NDST, NDSE, FTL ) From fcb1964b6a096a2b02020c41560da2a275451090 Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Mon, 26 Sep 2022 19:54:06 -0400 Subject: [PATCH 04/10] w3flx1md.F90: add doxygen markup --- model/src/w3flx1md.F90 | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/model/src/w3flx1md.F90 b/model/src/w3flx1md.F90 index 4263843941..33502cf6cb 100644 --- a/model/src/w3flx1md.F90 +++ b/model/src/w3flx1md.F90 @@ -1,5 +1,23 @@ +!> @file +!> @brief Flux/stress computations according to Wu (1980). +!> +!> @author H. L. Tolman +!> @date 29-May-2009 +!> + #include "w3macros.h" !/ ------------------------------------------------------------------- / +!> +!> @brief Flux/stress computations according to Wu (1980). +!> +!> @author H. L. Tolman +!> @date 29-May-2009 +!> +!> @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 W3FLX1MD !/ !/ +-----------------------------------+ @@ -53,6 +71,20 @@ MODULE W3FLX1MD !/ CONTAINS !/ ------------------------------------------------------------------- / +!> +!> @brief FLux/stress computations according to Wu (1980). +!> +!> @param[inout] ZWND Wind height. +!> @param[inout] U10 Wind speed. +!> @param[inout] U10D Wind direction. +!> @param[inout] UST Friction velocity. +!> @param[inout] USTD Direction of friction velocity. +!> @param[inout] Z0 Z0 in profile law. +!> @param[inout] CD Drag coefficient. +!> +!> @author H. L. Tolman +!> @date 03-Jul-2006 +!> SUBROUTINE W3FLX1 ( ZWND, U10, U10D, UST, USTD, Z0, CD ) !/ !/ +-----------------------------------+ From 43a09bc4fcea0a4b3ca63ed99e83bc7b90b294fb Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Mon, 26 Sep 2022 20:02:32 -0400 Subject: [PATCH 05/10] w3flx2md.F90: add doxygen markup --- model/src/w3flx2md.F90 | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/model/src/w3flx2md.F90 b/model/src/w3flx2md.F90 index 825860fba6..4faf495b17 100644 --- a/model/src/w3flx2md.F90 +++ b/model/src/w3flx2md.F90 @@ -1,5 +1,23 @@ +!> @file +!> @brief FLux/stress computations according Tolman and Chalikov (1996). +!> +!> @author H. L. Tolman +!> @date 20-Apr-2010 +!> + #include "w3macros.h" !/ ------------------------------------------------------------------- / +!> +!> @brief FLux/stress computations according Tolman and Chalikov (1996). +!> +!> @author H. L. Tolman +!> @date 20-Apr-2020 +!> +!> @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 W3FLX2MD !/ !/ +-----------------------------------+ @@ -53,6 +71,22 @@ MODULE W3FLX2MD !/ CONTAINS !/ ------------------------------------------------------------------- / +!> +!> @brief FLux/stress computations according Tolman and Chalikov (1996). +!> +!> @param[in] ZWIND Height of wind. +!> @param[in] DEPTH Depth. +!> @param[in] FP Peak frequency. +!> @param[in] U Wind speed. +!> @param[in] UDIR Wind direction. +!> @param[inout] UST Friction velocity. +!> @param[out] USTD Direction of friction velocity. +!> @param[out] Z0 Z0 in profile law. +!> @param[out] CD Drag coefficient. +!> +!> @author H. L. Tolman +!> @date 10-Jan-2014 +!> SUBROUTINE W3FLX2 ( ZWIND, DEPTH, FP, U, UDIR, UST, USTD, Z0, CD ) !/ !/ +-----------------------------------+ From af8aba1fcd7173e5b38edef48398cf81c79545fa Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Tue, 27 Sep 2022 15:09:15 -0400 Subject: [PATCH 06/10] w3flx3md.F90: add doxygen markup --- model/src/w3flx3md.F90 | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/model/src/w3flx3md.F90 b/model/src/w3flx3md.F90 index 5f797460d9..61036ebde8 100644 --- a/model/src/w3flx3md.F90 +++ b/model/src/w3flx3md.F90 @@ -1,5 +1,25 @@ +!> @file +!> @brief FLux/stress computations according Tolman and Chalikov (1996). +!> +!> @author H. L. Tolman +!> @date 20-Apr-2010 +!> + #include "w3macros.h" !/ ------------------------------------------------------------------- / +!> +!> @brief FLux/stress computations according Tolman and Chalikov (1996). +!> +!> @details Cap on flux added compared to W3FLX2. +!> +!> @author H. L. Tolman +!> @date 20-Apr-2010 +!> +!> @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 W3FLX3MD !/ !/ +-----------------------------------+ @@ -54,6 +74,24 @@ MODULE W3FLX3MD !/ CONTAINS !/ ------------------------------------------------------------------- / +!> +!> @brief FLux/stress computations according Tolman and Chalikov (1996). +!> +!> @details Cap on flux added compared to W3FLX2. +!> +!> @param[in] ZWIND Height of wind. +!> @param[in] DEPTH Depth. +!> @param[in] FP Peak frequency. +!> @param[in] U Wind speed. +!> @param[in] UDIR Wind direction. +!> @param[inout] UST Friction velocity. +!> @param[out] USTD Direction of friction velocity. +!> @param[out] Z0 Z0 in profile law. +!> @param[out] CD Drag coefficient. +!> +!> @author H. L. Tolman +!> @date 10-Jan-2014 +!> SUBROUTINE W3FLX3 ( ZWIND, DEPTH, FP, U, UDIR, UST, USTD, Z0, CD ) !/ !/ +-----------------------------------+ From d98f361bb05610b8e70a49cb083fd447eedbba5f Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Tue, 27 Sep 2022 16:06:45 -0400 Subject: [PATCH 07/10] w3flx4md.F90: add doxygen markup --- model/src/w3flx4md.F90 | 43 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/model/src/w3flx4md.F90 b/model/src/w3flx4md.F90 index ee23cebef3..9b2afb234c 100644 --- a/model/src/w3flx4md.F90 +++ b/model/src/w3flx4md.F90 @@ -1,5 +1,29 @@ +!> @file +!> @brief Flux/stress computations according to Hwang (2011). +!> +!> @author H. L. Tolman +!> @author S. Zieger +!> @author Q. Liu +!> @date 24-Nov-2017 +!> + #include "w3macros.h" !/ ------------------------------------------------------------------- / +!> +!> @brief Flux/stress computations according to Hwang ( 2011). +!> +!> @details Hwang 2011: J Atmos Ocean Tech 28(3) 436-443. +!> +!> @author H. L. Tolman +!> @author S. Zieger +!> @author Q. Liu +!> @date 24-Nov-2017 +!> +!> @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 W3FLX4MD !/ !/ +-----------------------------------+ @@ -59,6 +83,25 @@ MODULE W3FLX4MD !/ CONTAINS !/ ------------------------------------------------------------------- / +!> +!> @brief Flux/stress computations according to Hwang (JTECH, 2011). +!> +!> @verbatim +!> CD = 1E-4 ( -0.016 U10**2 + 0.967U10 + 8.058) +!> USTAR = U10 * SQRT( U10 ) +!> @endverbatim +!> +!> @param[in] ZWND Wind height. +!> @param[in] U10 Wind speed. +!> @param[in] U10D Wind direction. +!> @param[out] UST Friction velocity. +!> @param[out] USTD Direction of friction velocity. +!> @param[out] Z0 Z0 in profile law. +!> @param[out] CD Drag coefficient. +!> +!> @author H. L. Tolman +!> @date 03-Jul-2006 +!> SUBROUTINE W3FLX4 ( ZWND, U10, U10D, UST, USTD, Z0, CD ) !/ !/ +-----------------------------------+ From 7aa8513b5fbc8a29cb460579fbb890a9d5bc7a3e Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Tue, 27 Sep 2022 16:32:13 -0400 Subject: [PATCH 08/10] w3sbs1md.F90: add doxygen markup --- model/src/w3sbs1md.F90 | 49 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/model/src/w3sbs1md.F90 b/model/src/w3sbs1md.F90 index 31f82a7b7c..2e72fdb46e 100644 --- a/model/src/w3sbs1md.F90 +++ b/model/src/w3sbs1md.F90 @@ -1,4 +1,23 @@ +!> @file +!> @brief Computes scattering term. +!> +!> @author F. Ardhuin +!> @date 14-Nov-2010 +!> + #include "w3macros.h" +!> +!> @brief This module computes a scattering term +!> based on the theory by Ardhuin and Magne (JFM 2007). +!> +!> @author F. Ardhuin +!> @date 14-Nov-2010 +!> +!> @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 W3SBS1MD !/ @@ -70,6 +89,27 @@ MODULE W3SBS1MD !/ CONTAINS ! +!> +!> @brief Bottom scattering source term. +!> +!> @details Without current, goes through a diagonalization of the matrix +!> problem S(f,:) = M(f,:,:)**E(f,:). +!> With current, integrates the source term along the resonant locus. + +!> @param[in] A Action density spectrum (1-D) +!> @param[in] CG Group velocities +!> @param[in] WN Wavenumbers +!> @param[in] DEPTH Mean water depth +!> @param[in] CX1 Current components at ISEA +!> @param[in] CY1 Current components at ISEA +!> @param[out] TAUSCX Change of wave momentum due to scattering +!> @param[out] TAUSCY Change of wave momentum due to scattering +!> @param[out] S Source term (1-D version) +!> @param[out] D Diagonal term of derivative (1-D version) +!> +!> @author F. Ardhuin +!> @date 23-Jun-2006 +!> SUBROUTINE W3SBS1(A, CG, WN, DEPTH, CX1, CY1, & TAUSCX, TAUSCY, S, D) !/ @@ -422,6 +462,15 @@ SUBROUTINE W3SBS1(A, CG, WN, DEPTH, CX1, CY1, & !/ END SUBROUTINE W3SBS1 !/ ------------------------------------------------------------------- / +!> +!> @brief Initialization for bottom scattering source term routine. +!> +!> @param[in] inistep +!> +!> @author F. Ardhuin +!> @date 23-Jun-2006 +!> + SUBROUTINE INSBS1( inistep ) !/ !/ +-----------------------------------+ From 88036828d0f59b62d09457cc8bda48bbcbbfa5c9 Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Thu, 29 Sep 2022 12:07:16 -0400 Subject: [PATCH 09/10] w3flx5md.F90: add doxgen markup --- model/src/w3flx5md.F90 | 54 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/model/src/w3flx5md.F90 b/model/src/w3flx5md.F90 index 6cace52673..f1082a81d8 100644 --- a/model/src/w3flx5md.F90 +++ b/model/src/w3flx5md.F90 @@ -1,5 +1,30 @@ +!> @file +!> @brief Unified process to obtain friction velocity and drag when stresses +!> are an input (from atmospheric model). +!> +!> @author N.G. Valiente +!> @author J. Edward +!> @author A. Saulter +!> @date 01-Jul-2021 +!> + #include "w3macros.h" + !/ ------------------------------------------------------------------- / +!> +!> @brief Unified process to obtain friction velocity and drag when stresses +!> are an input (from atmospheric model). +!> +!> @author N.G. Valiente +!> @author J. Edward +!> @author A. Saulter +!> @date 01-Jul-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. +!> MODULE W3FLX5MD !/ !/ +-----------------------------------+ @@ -61,6 +86,35 @@ MODULE W3FLX5MD !/ CONTAINS !/ ------------------------------------------------------------------- / +!> +!> @brief Unified process to obtain friction velocity and drag when +!> stresses are an input (from atmospheric model). +!> +!> @verbatim +!> UST = SQRT(TAUA / RHOAIR) +!> USTD = TAUADIR +!> CD = (UST/U10)**2 +!> SQRTCDM1 = MIN(U10/UST,100.0) +!> Z0 = ZWND*EXP(-KAPPA*SQRTCDM1) +!> @endverbatim +!> +!> @param[in] ZWND Wind height. +!> @param[in] U10 Wind speed. +!> @param[in] U10D Wind direction. +!> @param[in] TAUA Atmosphere total stress. +!> @param[in] TAUADIR Atmosphere total stress directions. +!> @param[in] RHOAIR Air density. +!> @param[out] UST Friction velocity. +!> @param[out] USTD Direction of friction velocity. +!> @param[out] Z0 Z0 in profile law. +!> @param[out] CD Drag coefficient. +!> @param[out] CHARN Charnock coefficient. +!> +!> @author N.G. Valiente +!> @author J. Edward +!> @author A. Saulter +!> @date 01-Jul-2021 +!> SUBROUTINE W3FLX5 ( ZWND, U10, U10D, TAUA, TAUADIR, RHOAIR, UST, USTD, Z0, CD, CHARN ) !/ !/ +-----------------------------------+ From 43be9099bf0dcb1915bc58db8d73967ce3c3cac9 Mon Sep 17 00:00:00 2001 From: Matt Masarik Date: Thu, 29 Sep 2022 14:49:04 -0400 Subject: [PATCH 10/10] w3adatmd.F90: add doxygen markup --- model/src/w3adatmd.F90 | 97 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) diff --git a/model/src/w3adatmd.F90 b/model/src/w3adatmd.F90 index 11f49b5dd1..5f1f74b3f1 100644 --- a/model/src/w3adatmd.F90 +++ b/model/src/w3adatmd.F90 @@ -1,5 +1,28 @@ +!> @file +!> @brief Define data structures to set up wave model auxiliary 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 auxiliary data +!> for several models simultaneously. +!> +!> @details The number of grids is taken from W3GDATMD, and needs to be +!> set first with W3DIMG. +!> +!> @author H. L. Tolman +!> @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. +!> MODULE W3ADATMD #ifdef W3_MEMCHECK USE MallocInfo_m @@ -665,6 +688,17 @@ MODULE W3ADATMD !/ 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 10-Dec-2014 +!> SUBROUTINE W3NAUX ( NDSE, NDST ) !/ !/ +-----------------------------------+ @@ -797,6 +831,20 @@ SUBROUTINE W3NAUX ( NDSE, NDST ) !/ END SUBROUTINE W3NAUX !/ ------------------------------------------------------------------- / +!> +!> @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] D_ONLY Flag for initializing data arrays only. +!> +!> @author H. L. Tolman +!> @date 22-Mar-2021 +!> SUBROUTINE W3DIMA ( IMOD, NDSE, NDST, D_ONLY ) !/ !/ +-----------------------------------+ @@ -1523,6 +1571,17 @@ SUBROUTINE W3DIMA ( IMOD, NDSE, NDST, D_ONLY ) !/ END SUBROUTINE W3DIMA !/ ------------------------------------------------------------------- / +!> +!> @brief Version of W3DIMX for extended ouput arrays only. +!> +!> @param[in] IMOD Model number to point to. +!> @param[in] NDSE Error output unit number. +!> @param[in] NDST Test output unit number. +!> @param[in] OUTFLAGS +!> +!> @author H. L. Tolman +!> @date 22-Mar-2021 +!> SUBROUTINE W3XDMA ( IMOD, NDSE, NDST, OUTFLAGS ) !/ !/ +-----------------------------------+ @@ -2395,6 +2454,21 @@ SUBROUTINE W3XDMA ( IMOD, NDSE, NDST, OUTFLAGS ) !/ END SUBROUTINE W3XDMA !/ ------------------------------------------------------------------- / +!> +!> @brief Initialize an individual data grid at the proper dimensions (DIA). +!> +!> @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] NSP Array dimensions. +!> @param[in] NSPX Array dimensions. +!> +!> @author H. L. Tolman +!> @date 10-Dec-2014 +!> SUBROUTINE W3DMNL ( IMOD, NDSE, NDST, NSP, NSPX ) !/ !/ +-----------------------------------+ @@ -2603,6 +2677,19 @@ SUBROUTINE W3DMNL ( IMOD, NDSE, NDST, NSP, NSPX ) !/ END SUBROUTINE W3DMNL !/ ------------------------------------------------------------------- / +!> +!> @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 W3SETA ( IMOD, NDSE, NDST ) !/ !/ +-----------------------------------+ @@ -3069,6 +3156,16 @@ SUBROUTINE W3SETA ( IMOD, NDSE, NDST ) !/ END SUBROUTINE W3SETA !/ ------------------------------------------------------------------- / +!> +!> @brief Reduced version of W3SETA to point to expended output arrays. +!> +!> @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 W3XETA ( IMOD, NDSE, NDST ) !/ !/ +-----------------------------------+