Branch=1167-R21B-in-IC4. Here, I add updates to the manual. I also up…

…date the documentation in fortran code and regtest to be consistent with naming convention used in the manual (using the 2021a 2021b convention outside the manual is risky because Latex assigns the a and b and it may not be what one has in mind, so I don't use that anymore.)

manual/eqs/ICE4.tex

@@ -52,6 +52,20 @@ \subsubsection{~$S_{ice}$: Empirical/parametric damping by sea ice} \label{sec:I
 
 {\code IC4M7}: This is a formula for dissipation from \cite{art:Dob15}, developed for a mixture of pancake and frazil ice, using data collected in the Weddell Sea (Antarctica). The formula depends on wave frequency and ice thickness:
 \begin{equation}\label{eq:ice7}
- {\alpha=0.2T^{-2.13}h} \:\:\: .
+ {\alpha=2k_i=0.2h^1f^{2.13}} \:\:\: .
 \end{equation}
 This method is described in \cite{rep:RPLA18}.
+
+{\code IC4M8}: Like {\code IC4M7}, this method is in the general form of 
+\begin{equation}\label{eq:ice8}
+ {k_i=C_{hf}h^mf^n} \:\:\: .
+\end{equation}
+The formula is taken from \cite{Meylan2018}, where it is described as a ``Model with Order 3 Power Law''. It is applied by \cite{Liu2020}, where it is referred to as the ``M2'' model. The model specifies $m=1$ and $n=3$, and $C_{hf}$ is a user-specified calibration coefficient. \cite{Liu2020} provide calibration to two field cases and \cite{rep:RYW2021} provides a calibration to a third field case, \cite{art:RMK2021}. The third calibration is set as the default for {\code IC4M8}, $C_{hf}=0.059$, but can be changed in using the namelist parameter (constant and uniform) {\code IC4CN}, or using the spatially and/or temporally variable parameter ${C_{ice,2}}$ . Further details on the calibrations are available in the inline documentation in {\file w3sic4md.F90}. This method is functionally the same as the ``{\code M2}'' model in {\code IC5} (i.e., {\code IC5} with {\code IC5VEMOD=3}) and is redundantly included here as {\code IC4M8} because it is in the same ``family'' as {\code IC4M7} and {\code IC4M9}, being in the form of Eq. (\ref{eq:ice8}). 
+
+For an example of setting the namelist parameter, see {\file /regtests/ww3\_tic1.1/input\_IC4\_M8}.
+
+{\code IC4M9}: This formula is taken from the ``monomial power fit'' given in section 2.2.3 of \cite{rep:RYW2021}. Like {\code IC4M7} and {\code IC4M8}, it is a specific case of the general form of Eq. (\ref{eq:ice8}). The specificity is the constraint that $m=n/2-1$. This constraint is derived by \cite{rep:RYW2021} by invoking the scaling from \cite{art:YRW2019}, which is based on Reynolds number with ice thickness as the relevant length scale. This is also given as equation 2 in \cite{art:YRW2022}. The default namelist settings are $C_{hf}=2.9$ and $n=4.5$, from calibration by \cite{rep:RYW2021} to \cite{art:RMK2021}. Further details, including alternative calibrations such as \cite{art:Yu2022}, are available in the inline documentation in {\file w3sic4md.F90}. Constant values can be set using namelist parameters, where $C_{hf}$ and $n$ are {\code IC4CN(1)} and {\code IC4CN(2)}, respectively. Spatially and/or temporally versions of the same can be specified as ${C_{ice,2}}$ and ${C_{ice,3}}$, respectively.
+
+The namelist default $C_{hf}$ values in {\code IC4M8} and {\code IC4M9} are consistent with those of identical formulae implemented in \cite{man:SWAN4145A}.
+
+

manual/eqs/ICE5.tex

@@ -25,7 +25,7 @@ \subsubsection{~$S_{ice}$: Damping by sea ice (effective medium models)} \label{
 \begin{align}
 k_i^{EFS} &\propto \eta h_i^3 \sigma^{11},\label{eq:fspw}\\ k_i^{RP} &\propto \frac{\eta}{\rho_w g^2} \sigma^3,\label{eq:rppw}
 \end{align}
-whereas previous field measurements \citep[e.g.,][]{Meylan2018, Rogers2021} support a power law $k_i \propto \sigma^n$, with $n$ between 2 and 4. Eqs.~(\ref{eq:fspw}) and (\ref{eq:rppw}) indicate at certain regimes (i.e., $k_r \approx k_0$ and low $k_i$), $k_i$ of the EFS model is too sensitive to wave frequency and $k_i$ of the RP model shows no dependence on ice thickness.
+whereas previous field measurements \citep[e.g.,][]{Meylan2018, RMK21} support a power law $k_i \propto \sigma^n$, with $n$ between 2 and 4. Eqs.~(\ref{eq:fspw}) and (\ref{eq:rppw}) indicate at certain regimes (i.e., $k_r \approx k_0$ and low $k_i$), $k_i$ of the EFS model is too sensitive to wave frequency and $k_i$ of the RP model shows no dependence on ice thickness.
 
 The third model included in the {\code IC5} module is based on the ``Model with Order 3 Power Law'' proposed by \citet[][their section 6.2; hereafter the M2 model]{Meylan2018}, which assumes the loss of wave energy is proportional to the horizontal ice velocity squared times the ice thickness. The attenuation rate is given by
 \begin{equation}
@@ -52,4 +52,4 @@ \subsubsection{~$S_{ice}$: Damping by sea ice (effective medium models)} \label{
 %
 \cit{IC5VEMOD} {the sea ice model to be selected: 1 - {\code EFS}, 2 - {\code RP}, 3 - {\code M2}; Default=3 (i.e., \textbf{the {\code M2} model is chosen}).}
 \end{clist}
-The first 6 parameters were introduced to improve the stability of the numerical solver for the EFS model \citep[the solver may fail for small wave periods in some rare cases, particularly for shallow water depth $d$ and low $G$; see][]{Liu2020}. Nonetheless, since version 7.12, the M2 model becomes the default option and these limiters are therefore not used by default.
+The first 6 parameters were introduced to improve the stability of the numerical solver for the EFS model \citep[the solver may fail for small wave periods in some rare cases, particularly for shallow water depth $d$ and low $G$; see][]{Liu2020}. Nonetheless, since version 7.12, the M2 model becomes the default option and these limiters are therefore not used by default.

manual/manual.bib

@@ -524,7 +524,7 @@ @TECHREPORT{rep:CR17
  INSTITUTION = "{N}aval {R}esearch {L}aboratory, {S}tennis {S}pace {C}enter, {MS}",
  TYPE = "NRL Memorandum Report",
  NUMBER = "NRL/MR/7320--17-9726",
- NOTE = "25 pp., www7320.nrlssc.navy.mil/pubs.php" }
+ NOTE = "25 pp., www7320.nrlssc.navy.mil/pubs" }
 
 % item art:CRT17
 
@@ -1764,7 +1764,7 @@ @INPROCEEDINGS{pro:RZ14
  TITLE = "New wave-ice interaction physics in {WAVEWATCH III}",
  BOOKTITLE = Ice14,
  PUBLISHER = "IAHR",
- NOTE = "8 pp., www7320.nrlssc.navy.mil/pubs.php" }
+ NOTE = "8 pp., www7320.nrlssc.navy.mil/pubs" }
 
 % item rep:RPLA18
 
@@ -1775,7 +1775,18 @@ @TECHREPORT{rep:RPLA18
  INSTITUTION = "{N}aval {R}esearch {L}aboratory, {S}tennis {S}pace {C}enter, {MS}",
  TYPE = "NRL Memorandum Report",
  NUMBER = "NRL/MR/7320--18-9786",
- NOTE = "179 pp., www7320.nrlssc.navy.mil/pubs.php" }
+ NOTE = "179 pp., www7320.nrlssc.navy.mil/pubs" }
+
+% item rep:RYW2021
+
+@TECHREPORT{rep:RYW2021,
+ AUTHOR = "W. E. Rogers and J. Yu and D. W. Wang",
+ YEAR = "2021",
+ TITLE = "Incorporating dependencies on ice thickness in empirical parameterizations of wave dissipation by sea ice",
+ INSTITUTION = "{N}aval {R}esearch {L}aboratory, {S}tennis {S}pace {C}enter, {MS}",
+ TYPE = "NRL Technical Report",
+ NUMBER = "NRL/OT/7320-21-5145",
+ NOTE = "35 pp., https://arxiv.org/abs/2104.01246" }
 
 % item rep:RMK18
 
@@ -1786,7 +1797,7 @@ @TECHREPORT{rep:RMK18
  INSTITUTION = "{N}aval {R}esearch {L}aboratory, {S}tennis {S}pace {C}enter, {MS}",
  TYPE = "NRL Memorandum Report",
  NUMBER = "NRL/MR/7320--18-9801",
- NOTE = "25 pp., www7320.nrlssc.navy.mil/pubs.php" }
+ NOTE = "25 pp., www7320.nrlssc.navy.mil/pubs" }
 
 % item art:RH09
 
@@ -1811,6 +1822,33 @@ @ARTICLE{art:RTS16
  doi = "doi:10.1002/2016JC012251"
  }
 
+% item art:YRW2019
+
+@ARTICLE{art:YRW2019,
+ AUTHOR = "J. Yu and W. E. Rogers and D. W. Wang",
+ YEAR = 2019,
+ TITLE = "A Scaling for Wave Dispersion Relationships in Ice-Covered Waters",
+ JOURNAL = JGR,
+ VOLUME = "124",
+ PAGES = "8429--8438" ,
+ doi = "doi:10.1029/2018JC014870"
+ }
+
+% item art:Yu2022
+
+@Article{art:Yu2022,
+AUTHOR = {Yu, Jie},
+TITLE = {Wave Boundary Layer at the Ice-Water Interface},
+JOURNAL = {Journal of Marine Science and Engineering},
+VOLUME = {10},
+YEAR = {2022},
+NUMBER = {10},
+ARTICLE-NUMBER = {1472},
+URL = {https://www.mdpi.com/2077-1312/10/10/1472},
+ISSN = {2077-1312},
+DOI = {10.3390/jmse10101472}
+}
+
 % item art:CFSRR10
 
 @ARTICLE{art:CFSRR10,
@@ -2346,7 +2384,7 @@ @TECHREPORT{rep:RC09
  INSTITUTION = "{N}aval {R}esearch {L}aboratory, {S}tennis {S}pace {C}enter, {MS}",
  TYPE = "NRL Memorandum Report",
  NUMBER = "NRL/MR/7320--09-9193",
- NOTE = "42 pp., www7320.nrlssc.navy.mil/pubs.php" }
+ NOTE = "42 pp., www7320.nrlssc.navy.mil/pubs" }
 
 % item rep:RO13
 
@@ -2357,7 +2395,7 @@ @TECHREPORT{rep:RO13
  INSTITUTION = "{N}aval {R}esearch {L}aboratory, {S}tennis {S}pace {C}enter, {MS}",
  TYPE = "NRL Memorandum Report",
  NUMBER = "NRL/MR/7320--13-9462",
- NOTE = "31 pp., www7320.nrlssc.navy.mil/pubs.php" }
+ NOTE = "31 pp., www7320.nrlssc.navy.mil/pubs" }
 
 % item rep:Roland2008
 
@@ -2606,6 +2644,17 @@ @MANUAL{man:SWAN3
  ADDRESS = "P.O. Box 5048, 2600 GA Delft, The Netherlands",
  NOTE = "see http:https://swan.ct.tudelft.nl" }
 
+% item man:SWAN4145A
+
+@MANUAL{man:SWAN4145A,
+ AUTHOR = "{SWAN team}",
+ YEAR = "2023",
+ TITLE = "{SWAN Cycle III} version 41.45A User Manual",
+ ORGANIZATION = "Delft University of Technology,
+ Faculty of Civil Engineering and Geosciences",
+ ADDRESS = "P.O. Box 5048, 2600 GA Delft, The Netherlands",
+ NOTE = "see https://swanmodel.sourceforge.io/" }
+
 % item man:Jones98
 
 @MANUAL{man:Jones98,
@@ -3485,10 +3534,14 @@ @article{Liu2021
  title={{Global Wave Hindcasts Using the Observation-based Source Terms: Description and Validation}},
  author={Liu, Qingxiang and Babanin, Alexander and Rogers, W Erick and Zieger, Stefan and Young, Ian and Bidlot, Jean-Raymond and Durrant, Tom and Ewans, Kevin and Guan, Changlong and Kirezci, Cagil and Lemos, Gil and MacHutchon, Keith and Moon, Il-Ju and Rapizo, Henrique and Ribal, Agustinus and Semedo, Alvaro and Wang, Juanjuan},
  journal={Journal of Advances in Modeling Earth Systems (JAMES)},
- year={submitted}
+ year = {2021},
+ volume = {13},
+ number = {8},
+ pages = {e2021MS002493},
+ doi = {https://doi.org/10.1029/2021MS002493},
 }
 
-@article{Rogers2021,
+@article{art:RMK2021,
  title = {Estimates of spectral wave attenuation in Antarctic sea ice, using model/data inversion},
  journal = {Cold Regions Science and Technology},
  volume = {182},
@@ -3499,6 +3552,18 @@ @article{Rogers2021
  author = {W. Erick Rogers and Michael H. Meylan and Alison L. Kohout}
 }
 
+@article{art:YRW2022,
+ title = {A new method for parameterization of wave dissipation by sea ice},
+ journal = {Cold Regions Science and Technology},
+ volume = {199},
+ pages = {103582},
+ year = {2022},
+ issn = {0165-232X},
+ doi = {https://doi.org/10.1016/j.coldregions.2022.103582},
+ url = {https://www.sciencedirect.com/science/article/pii/S0165232X2200101X},
+ author = {Jie Yu and W. Erick Rogers and David W. Wang},
+}
+
 @article{Forristall1981,
  author = {Forristall, George Z.},
  doi = {10.1029/JC086iC09p08075},

model/src/w3sic4md.F90

@@ -85,8 +85,8 @@ MODULE W3SIC4MD
  ! *** Meylan et al. JGR 2018
  ! *** Yu et al. JGR 2019
  ! *** Liu et al. JPO 2020
- ! *** Rogers et al. CRST 2021a (R21A)
- ! *** Rogers et al. tech. rep. 2021b (R21B)
+ ! *** Rogers et al. CRST 2021 (RMK2021)
+ ! *** Rogers et al. tech. rep. 2021 (RYW2021)
  ! *** Yu et al. CRST 2022
  ! *** Yu JMSE 2022
  !
@@ -136,7 +136,8 @@ SUBROUTINE W3SIC4 (A, DEPTH, CG, IX, IY, S, D)
  !/ 24-Feb-2017 : Corrections to Methods 1,2,3,4 (E. Rogers)
  !/ 13-Apr-2017 : Method 7 added (Doble et al. 2015) (E. Rogers)
  !/ 11-Jan-2024 : Method 8 added (Meylan et al. 2018) (E. Rogers)
- !/ 11-Jan-2024 : Method 9 added (Rogers et al. 2021b) (E. Rogers)
+ !/ 11-Jan-2024 : Method 9 added (Rogers et al., 2021)
+ !/ denoted "RYW2021" (E. Rogers)
  !/
  !/ FIXME : Move field input to W3SRCE and provide
  !/ (S.Zieger) input parameter to W3SIC1 to make the subroutine
@@ -182,7 +183,7 @@ SUBROUTINE W3SIC4 (A, DEPTH, CG, IX, IY, S, D)
  ! an encounter interval length scale from an a_ice and d_ice
  ! provided by the user...or a length scale provided by the 
  ! user.
- ! See also: page 3 of Rogers et al. (2021b).
+ ! See also: page 3 of Rogers et al. (RYW2021).
  ! 4) Eq. 1 from Kohout et al. 2014
  !
  ! 5) Simple step function for ki as a function of frequency
@@ -275,32 +276,36 @@ SUBROUTINE W3SIC4 (A, DEPTH, CG, IX, IY, S, D)
  ! ChfM2 has units of s3/m2
  ! It is equation 53 in Meylan et al. (2018) and equation 16 in
  ! Liu et al. (2020).
- ! This method is functionally the same as IC5M2 in WW3 and is
- ! redundantly included here as IC4M8 because it is in the same
- ! "family" as IC4M7 and IC4M9, being in the form of
+ ! This method is functionally the same as the "M2" model in IC5
+ ! in WW3 (IC5 w/IC5VEMOD=3) and is redundantly included here as
+ ! IC4M8 because it is in the same "family" as IC4M7 and IC4M9,
+ ! being in the form of:
  ! ki=Chf * h_ice^m * freq^n .
  ! Calibrations:
  ! * Liu et al. has ChfM2=eta*(2*pi)^3/(1025*9.81^2)
  ! ** eta=14.0 for "Sikuliaq" case of Liu et al., so ChfM2=0.035
  ! ** eta=3.0 for "SIPEX" case of Liu et al., so ChfM2=0.0075
- ! * Rogers et al. (tech rep. 2021b, "R21B") :
- ! ** Fit to Rogers et al. (CRST 2021a "R21A") ChfM2=0.059 (*SD*)
+ ! * Rogers et al. (tech rep. 2021, "RYW2021") :
+ ! ** Fit to Rogers et al. (CRST 2021 "RMK2021") ChfM2=0.059 (*SD*)
  ! suggested default is marked with "(*SD*)", for consistency
- ! with SWAN v41.31AB
- !
- ! 9) Rogers et al. (tech. rep. 2021b). The "monomial power fit"
- ! described in section 2.2.3. It is the general form above,
- ! ki=Chf * h_ice^m * freq^n
- ! but is constrained such that m=n/2-1.
+ ! with SWAN (v41.31AB or later)
+ !
+ ! 9) Rogers et al. (tech. rep. 2021, "RYW2021"): the "monomial power
+ ! fit" described in section 2.2.3. It is the general form above,
+ ! ki=Chf * h_ice^m * freq^n but is constrained such that m=n/2-1.
+ ! This constraint is derived by RYW2021 by invoking the scaling from
+ ! Yu et al. (2019), which is based on Reynolds number with ice
+ ! thickness as the relevant length scale.
  ! This is also given as equation 2 in Yu et al. (CRST 2022).
- ! * R21B, calibration to R21A: Chf=2.9 and n=4.5 (*SD*)
- ! * Yu et al. (2022) calibration to R21A : Chf=2.4 and n=4.46
+ ! Some calibrations are as follows:
+ ! * RYW2021, calibration to RMK2021: Chf=2.9 and n=4.5 (*SD*)
+ ! * Yu et al. (2022) calibration to RMK2021 : Chf=2.4 and n=4.46
  ! (noting that c_n=0.108 and Chf=c_n*(2*pi/sqrt(g))^n)
  ! * Yu (2022) adjusted the prior calibration to get better fit
  ! to higher frequency lab measurements and got:
  ! Chf=7.89 and n=4.8
  ! suggested default is marked with "(*SD*)", for consistency
- ! with SWAN v41.31AB
+ ! with SWAN (v41.31AB or later)
  !
  ! ------------------------------------------------------------------
  !
@@ -670,7 +675,7 @@ SUBROUTINE W3SIC4 (A, DEPTH, CG, IX, IY, S, D)
  WN_I(IK) = Chf*hice*(FREQ(IK)**3)
  END DO
 
- CASE (9) ! Rogers et al. (2021b) (R21B), Yu et al. (JGR 2022)
+ CASE (9) ! Rogers et al. (2021) (RYW2021), Yu et al. (JGR 2022)
 
  NML_INPUT=.TRUE.
  IF (INFLAGS2(-6).OR.INFLAGS2(-5)) NML_INPUT=.FALSE.

regtests/ww3_tic1.1/info

@@ -53,7 +53,7 @@
 # IC4METHOD = 7 - Doble et al. (GRL 2015) #
 # IC4METHOD = 8 - Meylan et al. (2018) ; Liu et al. (2020) #
 # (NB: redundant with IC5+IC5VEMOD=3) #
-# IC4METHOD = 9 - Rogers et al. (2021b) ; Yu et al. (2022) #
+# IC4METHOD = 9 - RYW (2021) ; Yu et al. (2022)  #
 # IC5 = Choose from three different effective medium models #
 # IC5VEMOD = 1 - Extended Fox and Squire model (EFS) #
 # IC5VEMOD = 2 - Robinson and Palmer model (RP) #
@@ -173,7 +173,8 @@
 # updated: Erick Rogers, Apr 2016 #
 # updated: Jessica Meixner, May 2016 #
 # updated: Qingxiang Liu, Jul 2018 #
-# last updated: Qingxiang Liu, May 2021 #
+# updated: Qingxiang Liu, May 2021 #
+# last updated: Erick Rogers, Jan 2024 #
 # Copyright 2009-2014 National Weather Service (NWS), #
 # National Oceanic and Atmospheric Administration. All rights #
 # reserved. WAVEWATCH III is a trademark of the NWS. #

regtests/ww3_tic1.1/input_IC4_M8/ww3_grid.inp

@@ -17,7 +17,7 @@ $ IC4METHOD = 5 - Simple ki step function
 $ IC4METHOD = 6 - Simple ki step function via namelist
 $ IC4METHOD = 7 - Doble et al. (GRL 2015)
 $ IC4METHOD = 8 - Meylan et al. (2018) ; Liu et al. (2020)
-$ IC4METHOD = 9 - Rogers et al. (2021b) ; Yu et al. (2022)
+$ IC4METHOD = 9 - RYW (2021) ; Yu et al. (2022)
 $ IC4M8 Fit to R21A L ChfM2=0.059
  &SIC4 IC4METHOD = 8 , IC4CN = 0.059/
 END OF NAMELISTS

regtests/ww3_tic1.1/input_IC4_M9/ww3_grid.inp

@@ -17,7 +17,7 @@ $ IC4METHOD = 5 - Simple ki step function
 $ IC4METHOD = 6 - Simple ki step function via namelist
 $ IC4METHOD = 7 - Doble et al. (GRL 2015)
 $ IC4METHOD = 8 - Meylan et al. (2018) ; Liu et al. (2020)
-$ IC4METHOD = 9 - Rogers et al. (2021b) ; Yu et al. (2022)
+$ IC4METHOD = 9 - RYW (2021) ; Yu et al. (2022)
 $ IC4M9 Fit to R21A Chf=2.9 and n=4.5
  &SIC4 IC4METHOD = 9 , IC4CN = 2.9, 4.5/
 END OF NAMELISTS