ADCIRCWiki - User contributions [en]

Examples and Test Cases

2024-09-11T19:27:56Z

Taylorgasher: removed nonexistant item, changed to bullet list

Below is a list of convenient test cases covering a range of basic uses and common ADCIRC capabilities. In addition to the test cases shown below, note the ADCIRC test suite hosted on the GitHub repository, https://github.com/adcirc/adcirc-testsuite, which has many of the tests below and more.

* [https://adcirc.org/home/documentation/example-problems/quarter-annular-harbor-with-tidal-forcing-example/ Quarter Annular Harbor with Tidal Forcing (2D and 3D)]
* [https://adcirc.org/home/documentation/example-problems/shinnecock-inlet-ny-with-tidal-forcing-example Shinnecock Inlet with Tidal Forcing (2D)]
* [https://adcirc.org/home/documentation/example-problems/beaufort-inlet-nc-example/ Beaufort Inlet (2D)]
* [https://adcirc.org/home/documentation/example-problems/idealized-inlet-test-cases/ Idealized Inlet (2D)]
* [https://adcirc.org/home/documentation/example-problems/internal-overflow-boundaries-example/ Internal Overflow Boundary (2D)]
* [https://adcirc.org/home/documentation/example-problems/apes-wind-run-example/ APES Wind Run (NWS = 3) (2D)]
* [https://adcirc.org/home/documentation/example-problems/hurricane-isabel-example/ Hurricane Isabel Wind Run (NWS = 4) (2D)]
* [https://adcirc.org/home/documentation/example-problems/large-grid-tides-example/ Large Grid (~300,000 nodes) Tides Only]
* [https://adcirc.org/home/documentation/example-problems/katrina-run-2015-nws-20-example/ Hurricane Katrina (NWS=20)]
* [[Global Astronomical M2 Tide]] (2D)
* [[Global Storm Tide - Hurricane Katrina]] (NWS = -14) (2D)
* [[Alaskan Winter Storm with Ice]] (NWS = 14014) (2D)
* [[Idealized Channel Problem]] (2D)

== See Also ==
[[Typical ADCIRC Parameter Selections]]

Version information

2024-09-11T19:23:31Z

Taylorgasher: Update version tracking info after conferring with Zach

ADCIRC uses git for version control and is hosted on a public GitHub repository, https://github.com/adcirc/adcirc. The version information is automatically generated when the release versions are packaged. When not using a release package, you should work with Git to track versioning.

== Major Model Updates ==
=== Version 53 ===
*Patch B of SWAN version 41.01 (i.e. version 41.01B) was merged into ADCIRC.
**[[Wave refraction in SWAN]] nodal attribute and SWAN spectral limiters should no longer be needed due to updated numerics in SWAN. [https://ccht.ccee.ncsu.edu/updates-to-spectral-propagation-velocities/ Details here].
=== Later Versions ===
Release notes accompany releases on the GitHub site, https://github.com/adcirc/adcirc/releases

Examples and Test Cases

2024-09-11T17:44:58Z

Taylorgasher:

In addition to the test cases shown below, note the ADCIRC test suite hosted on the GitHub repository, https://github.com/adcirc/adcirc-testsuite, which has many of the tests below and more.

Example 1: [https://adcirc.org/home/documentation/example-problems/quarter-annular-harbor-with-tidal-forcing-example/ Quarter Annular Harbor with Tidal Forcing (2D and 3D)]

Example 2: [https://adcirc.org/home/documentation/example-problems/shinnecock-inlet-ny-with-tidal-forcing-example Shinnecock Inlet with Tidal Forcing (2D)]

Example 3: [https://adcirc.org/home/documentation/example-problems/beaufort-inlet-nc-example/ Beaufort Inlet (2D)]

Example 4: [https://adcirc.org/home/documentation/example-problems/idealized-inlet-test-cases/ Idealized Inlet (2D)]

Example 5: [https://adcirc.org/home/documentation/example-problems/internal-overflow-boundaries-example/ Internal Overflow Boundary (2D)]

Example 6: [https://adcirc.org/home/documentation/example-problems/apes-wind-run-example/ APES Wind Run (NWS = 3) (2D)]

Example 7: [https://adcirc.org/home/documentation/example-problems/hurricane-isabel-example/ Hurricane Isabel Wind Run (NWS = 4) (2D)]

Example 8: [https://adcirc.org/home/documentation/example-problems/large-grid-tides-example/ Large Grid (~300,000 nodes) Tides Only]

Example 9: [https://adcirc.org/home/documentation/example-problems/katrina-run-2015-nws-20-example/ Hurricane Katrina (NWS=20)]

Example 10: [[Global Astronomical M2 Tide]] (2D)

Example 11: [[Global Storm Tide - Hurricane Katrina]] (NWS = -14) (2D)

Example 12: [[Global Storm Tide (NWS = 10)]] (2D)

Example 13: [[Alaskan Winter Storm with Ice]] (NWS = 14014) (2D)

Example 14: [[Idealized Channel Problem]] (2D)

== See Also ==
[[Typical ADCIRC Parameter Selections]]

Examples and Test Cases

2024-09-11T17:44:31Z

Taylorgasher: added github test repo

Note also the ADCIRC test suite hosted on the GitHub repository, https://github.com/adcirc/adcirc-testsuite, which has many of the tests below and more.

Example 1: [https://adcirc.org/home/documentation/example-problems/quarter-annular-harbor-with-tidal-forcing-example/ Quarter Annular Harbor with Tidal Forcing (2D and 3D)]

Example 2: [https://adcirc.org/home/documentation/example-problems/shinnecock-inlet-ny-with-tidal-forcing-example Shinnecock Inlet with Tidal Forcing (2D)]

Example 3: [https://adcirc.org/home/documentation/example-problems/beaufort-inlet-nc-example/ Beaufort Inlet (2D)]

Example 4: [https://adcirc.org/home/documentation/example-problems/idealized-inlet-test-cases/ Idealized Inlet (2D)]

Example 5: [https://adcirc.org/home/documentation/example-problems/internal-overflow-boundaries-example/ Internal Overflow Boundary (2D)]

Example 6: [https://adcirc.org/home/documentation/example-problems/apes-wind-run-example/ APES Wind Run (NWS = 3) (2D)]

Example 7: [https://adcirc.org/home/documentation/example-problems/hurricane-isabel-example/ Hurricane Isabel Wind Run (NWS = 4) (2D)]

Example 8: [https://adcirc.org/home/documentation/example-problems/large-grid-tides-example/ Large Grid (~300,000 nodes) Tides Only]

Example 9: [https://adcirc.org/home/documentation/example-problems/katrina-run-2015-nws-20-example/ Hurricane Katrina (NWS=20)]

Example 10: [[Global Astronomical M2 Tide]] (2D)

Example 11: [[Global Storm Tide - Hurricane Katrina]] (NWS = -14) (2D)

Example 12: [[Global Storm Tide (NWS = 10)]] (2D)

Example 13: [[Alaskan Winter Storm with Ice]] (NWS = 14014) (2D)

Example 14: [[Idealized Channel Problem]] (2D)

== See Also ==
[[Typical ADCIRC Parameter Selections]]

Main Page

2024-09-11T17:43:03Z

Taylorgasher: removed FAQ since it points to something silly

For visitors to the site, please note the message above. For editors and administrators, links to some general wiki information are provided toward the bottom of this page, while more specific editing help can be found at the "Help" link on the sidebar of this page. The following summary shows some of the major pages that need content. Blue links are pages that have been created (but still definitely need content). Red links are pages that haven't been created yet (clicking the link will let you create the page). Have fun, and welcome to the party!


{| style="border-style: solid; border-width:1px; width:100%; vertical-align:top; border-spacing:4px;"
|- style="vertical-align:top;
| style="width:50%" | 

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#97bfde; font-size:120%; font-weight:bold; text-align:left; color:#13294B; padding:0.2em 0.4em;">Basics</div>
|-
|style="color:#000;"|
*[[adcirc:About|About ADCIRC]]
*[[Features]]
*[[Getting started]]
*[[Version information]]
*[[Source code]]
|}
| style="width:50%" | 

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#b9b7eb; font-size:120%; font-weight:bold; text-align:left; color:#000; padding:0.2em 0.4em;">User Guide</div>
|-
|style="color:#000;"|
*[[Compiling]]
*[[File formats]]
*[[Model setup]]
*[[Running]]
*[[Visualization]]
*[[Tools]]
|}
|- style="vertical-align:top;
|

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#b7ebdb; font-size:120%; font-weight:bold; text-align:left; color:#000; padding:0.2em 0.4em;">How-To</div>
|-
|style="color:#000;"|
*[[Tutorials]]
*[[Examples and Test Cases]]
*[[Troubleshooting]]
*[[Grid Development and Editing]]
*[[Tips and Tricks]]
|}
|

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#7ea0ff; font-size:120%; font-weight:bold; text-align:left; color:#000; padding:0.2em 0.4em;">Technical</div>
|-
|style="color:#000;"|
*[[ADCIRC physics|Physics]]
*[[ADCIRC numerics|Numerics]]
*[[Code architecture]]
*[[Parallelization]]
*[[Coupling]]
|}
|}

== Contributor/Editor Resources ==
A quick way to learn Wiki syntax (the source code is called "[https://www.mediawiki.org/wiki/Wikitext wikitext]") is to go to a Wikipedia page and click on the "Edit source" or "View source" link at the top of the page. I often use [https://en.wikipedia.org/wiki/Navier%E2%80%93Stokes_equations the Navier Stokes page]. If something works on Wikipedia but not here, let Taylor know.
* General editing
** [http://www.workingwithmediawiki.com/book/chapter3.html Nice list of key editing abilities]
** [https://meta.wikimedia.org/wiki/Help:Contents#For_editors General editing help]
** [https://meta.wikimedia.org/wiki/Help:Advanced_editing Advanced editing]
* Specific editing tasks/tools
** [https://meta.wikimedia.org/wiki/Help:Starting_a_new_page Starting a new page]
** [https://meta.wikimedia.org/wiki/Help:Reverting Reverting edits]
** [https://www.mediawiki.org/wiki/Help:Templates Templates help]
** [https://www.mediawiki.org/wiki/Help:Cite Citations and <nowiki><ref></nowiki> help]
* [[Help:Style Guide|ADCIRC Wiki style guide]] (under development)
* [https://en.wikipedia.org/wiki/Wikipedia:Sandbox "Sandbox"] to play around with editing without affecting anything...this is on Wikipedia but should mostly work the same
* Somewhat related: [https://en.wikipedia.org/wiki/Help:Directory Wikipedia help directory], [https://en.wikipedia.org/wiki/Template:Wikipedia_technical_help Wikipedia technical help list], [https://en.wikipedia.org/wiki/Help:Text_editor_support Wikipedia text editor help]

== Moderator/Admin Resources ==

* [https://www.mediawiki.org/wiki/Manual:Administrators Administrator manual]
* [https://www.mediawiki.org/wiki/Sysadmin_hub Sysadmin hub]
* [https://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings]

== Wiki Management: Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
* [https://meta.wikimedia.org/wiki/Help:Contents User's Guide]

adcirc:About

2024-09-11T17:39:25Z

Taylorgasher: added source code

For general information on ADCIRC, see either the [http://adcirc.org ADCIRC site] or the [https://en.wikipedia.org/wiki/ADCIRC ADCIRC Wikipedia page]. For source code or licensing information, see [[source code]]. For model documentation not yet available on the wiki, see the ADCIRC site. New content is being continuously added to the ADCIRC wiki, and material from the main ADCIRC site will be gradually transitioned over to the wiki. For editors, links to some general wiki information are provided at the bottom of this page, while more specific editing help can be found at the "Help" link on the sidebar of this page.

Source code

2024-09-11T17:37:57Z

Taylorgasher: created page

The ADCIRC source code is hosted in a git repository on GitHub, https://github.com/adcirc/adcirc/. Releases of the code are also hosted there, https://github.com/adcirc/adcirc/releases/. ADCIRC is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version, https://www.gnu.org/licenses/.

Main Page

2024-09-11T17:34:20Z

Taylorgasher: added source code

For visitors to the site, please note the message above. For editors and administrators, links to some general wiki information are provided toward the bottom of this page, while more specific editing help can be found at the "Help" link on the sidebar of this page. The following summary shows some of the major pages that need content. Blue links are pages that have been created (but still definitely need content). Red links are pages that haven't been created yet (clicking the link will let you create the page). Have fun, and welcome to the party!


{| style="border-style: solid; border-width:1px; width:100%; vertical-align:top; border-spacing:4px;"
|- style="vertical-align:top;
| style="width:50%" | 

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#97bfde; font-size:120%; font-weight:bold; text-align:left; color:#13294B; padding:0.2em 0.4em;">Basics</div>
|-
|style="color:#000;"|
*[[adcirc:About|About ADCIRC]]
*[[Features]]
*[[Getting started]]
*[[FAQ]]
*[[Version information]]
*[[Source code]]
|}
| style="width:50%" | 

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#b9b7eb; font-size:120%; font-weight:bold; text-align:left; color:#000; padding:0.2em 0.4em;">User Guide</div>
|-
|style="color:#000;"|
*[[Compiling]]
*[[File formats]]
*[[Model setup]]
*[[Running]]
*[[Visualization]]
*[[Tools]]
|}
|- style="vertical-align:top;
|

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#b7ebdb; font-size:120%; font-weight:bold; text-align:left; color:#000; padding:0.2em 0.4em;">How-To</div>
|-
|style="color:#000;"|
*[[Tutorials]]
*[[Examples and Test Cases]]
*[[Troubleshooting]]
*[[Grid Development and Editing]]
*[[Tips and Tricks]]
|}
|

{| width="100%" cellpadding="2" cellspacing="5" style="vertical-align:top; "
|-
! <div style="margin:0; background:#7ea0ff; font-size:120%; font-weight:bold; text-align:left; color:#000; padding:0.2em 0.4em;">Technical</div>
|-
|style="color:#000;"|
*[[ADCIRC physics|Physics]]
*[[ADCIRC numerics|Numerics]]
*[[Code architecture]]
*[[Parallelization]]
*[[Coupling]]
|}
|}

== Contributor/Editor Resources ==
A quick way to learn Wiki syntax (the source code is called "[https://www.mediawiki.org/wiki/Wikitext wikitext]") is to go to a Wikipedia page and click on the "Edit source" or "View source" link at the top of the page. I often use [https://en.wikipedia.org/wiki/Navier%E2%80%93Stokes_equations the Navier Stokes page]. If something works on Wikipedia but not here, let Taylor know.
* General editing
** [http://www.workingwithmediawiki.com/book/chapter3.html Nice list of key editing abilities]
** [https://meta.wikimedia.org/wiki/Help:Contents#For_editors General editing help]
** [https://meta.wikimedia.org/wiki/Help:Advanced_editing Advanced editing]
* Specific editing tasks/tools
** [https://meta.wikimedia.org/wiki/Help:Starting_a_new_page Starting a new page]
** [https://meta.wikimedia.org/wiki/Help:Reverting Reverting edits]
** [https://www.mediawiki.org/wiki/Help:Templates Templates help]
** [https://www.mediawiki.org/wiki/Help:Cite Citations and <nowiki><ref></nowiki> help]
* [[Help:Style Guide|ADCIRC Wiki style guide]] (under development)
* [https://en.wikipedia.org/wiki/Wikipedia:Sandbox "Sandbox"] to play around with editing without affecting anything...this is on Wikipedia but should mostly work the same
* Somewhat related: [https://en.wikipedia.org/wiki/Help:Directory Wikipedia help directory], [https://en.wikipedia.org/wiki/Template:Wikipedia_technical_help Wikipedia technical help list], [https://en.wikipedia.org/wiki/Help:Text_editor_support Wikipedia text editor help]

== Moderator/Admin Resources ==

* [https://www.mediawiki.org/wiki/Manual:Administrators Administrator manual]
* [https://www.mediawiki.org/wiki/Sysadmin_hub Sysadmin hub]
* [https://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings]

== Wiki Management: Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
* [https://meta.wikimedia.org/wiki/Help:Contents User's Guide]

Version information

2024-09-11T17:33:29Z

Taylorgasher: added release info

This page holds information about how ADCIRC versioning is tracked and may serve as a list of major updates to the model. Currently, ADCIRC uses git for version control and is hosted on a public GitHub repository, https://github.com/adcirc/adcirc.

== Version Tracking ==
A file called “changelog” is automatically constructed by the script “generateChangelog.sh” in the scripts directory. The full commit messages are automatically generated in there. Git commit messages are split into two sections, a subject and a body (sort of like when people used to do patch type versioning by email). The changelog file prints the user, subject, commitid, date, etc in the top of the file in a table, then below it has the full details the user supplies. There is also an option to generate the full log since the beginning of time. The default is since the last time the code was tagged. The changelog is automatically generated from the beginning of time when the exportAdcirc.sh script is run and it is included in the package. Version.F is also generated here with unique information about the state of the repository when the code was exported. The idea here is someone can help us uniquely identify what version of the code they have and git will corroborate their description. This is particularly useful when someone who can't or won't work in a versioned environment sends code to merge in.

== Major Model Updates ==
=== Version 53 ===
*Patch B of SWAN version 41.01 (i.e. version 41.01B) was merged into ADCIRC.
**[[Wave refraction in SWAN]] nodal attribute and SWAN spectral limiters should no longer be needed due to updated numerics in SWAN. [https://ccht.ccee.ncsu.edu/updates-to-spectral-propagation-velocities/ Details here].
=== Later Versions ===
Release notes accompany releases on the GitHub site, https://github.com/adcirc/adcirc/releases

Version information

2024-09-11T17:30:46Z

Taylorgasher: updated to public repo

Generalized Asymmetric Holland Model

2024-06-11T19:38:03Z

Taylorgasher: /* Derivation of the GAHM */ fixed missing phi in math equation and a formatting issue

The Generalized Asymmetric Holland Model (hereinafter, GAHM) is a parametric hurricane vortex model developed in ADCIRC for operational forecasting purpose, based on the classic Holland Model <ref> Holland, G. J., 1980: An analytic model of the wind and pressure profiles in hurricanes. ''Monthly Weather Review'', 108, 1212-1218. </ref> (hereinafter, HM). The original HM was developed to render an ideal symmetric hurricane (a.k.a., annular hurricane). To represent hurricanes that may exhibit asymmetric structures, the Asymmetric Holland Model (hereinafter, AHM) was developed and implemented in ADCIRC for more practical usages<ref> Mattocks, C., C. Forbes, and L. Ran, 2006: Design and implementation of a real-time storm surge and flood forecasting capability for the State of North Carolina. UNC-CEP Technical Report, University of North Carolina, 103pp. </ref>, which has the same set of equations as of the HM, but takes azimuthally-varying radius to the maximum wind to reconstruct its spatial pressure and wind fields. Both the HM and AHM suffer from flaws that make rendering large but weak storms difficult. As a result, efforts were made to develop a more generalized model to fulfill the purpose. Compared to the HM and the AHM, the GAHM removes the assumption of cyclostrophic balance at the radius of maximum wind during derivation of its equations, and allows for a better representation of a wide range of hurricanes. Another important feature of the GAHM is the introduction of a composite wind method, which when activated enables the usage of multiple storm isotaches. It makes representing complex hurricane structures possible.


== The Classic Holland Model ==

The HM is an analytic model that describes the radial pressure and wind profiles of a standard hurricane. To begin with, Holland found that the normalized pressure profiles of a number of hurricanes resemble a family of rectangular hyperbolas and may be approximated by a hyperbolic equation, which after antilogarithms and rearranging yields the radial pressure equation:

<center> <math> P(r) = P_c + (P_n - P_c)e^{-A/r^B} \quad </math> (1) </center>

where <math> P_c </math> is the central pressure, <math> P_c </math> is the ambient pressure (theoretically at infinite radius), <math> P(r) </math> is the pressure at radius <math> r </math> from the center of the hurricane, and <math> A </math> and <math> B </math> are shape parameters that may be empirically estimated from observations in a hurricane.

Substituting (1) into the gradient wind equation, which describes a steady flow balanced by the horizontal pressure gradient force, the centripetal acceleration, and the Coriolis acceleration for a vortex above the influence of the planetary boundary layer where the atmospheric flow decouples from surface friction <ref> Powell, Mark & Uhlhorn, E. & Kepert, Jeffrey. (2009). Estimating Maximum Surface Winds from Hurricane Reconnaissance Measurements. ''Weather and Forecasting''. 24. 10.1175/2008WAF2007087.1. </ref>, gives the radial wind equation of a hurricane:

<center> <math> V_g(r) = \sqrt{AB(P_n - P_c)e^{-A/r^B}/\rho r^B + (\frac{rf}{2})^2} - \frac{rf}{2} \quad </math> (2) </center>

where <math> V_g(r) </math> is the gradient wind at radius <math> r </math>, <math> \rho </math> is the density of air, <math> f </math> is the Coriolis parameter. In the region of the maximum winds, if we assume that the Coriolis force is negligible in comparison to the pressure gradient and centripetal force, then the air is in cyclostrophic balance. By removing the Coriolis term in (2) we get the cyclostrophic wind

<center> <math> V_c(r) = \sqrt{AB(P_n - P_c)e^{-A/r^B}/\rho r^B} \quad </math> (3) </center>

By setting <math> dV_c/dr = 0 </math> at radius to the maximum wind <math> r = R_{max} </math>, it is obtained that

<center> <math> A = (R_{max})^B \quad </math> (4) </center>

Thus the (<math> R_{max} </math>) is irrelevant to the relative value of ambient and central pressures, and is solely defined by the shape parameters <math> A </math> and <math> B </math>. Substituting (4) back into (3) to get rid of <math> A </math>, we get an estimate of <math> B </math> as a function of the maximum wind speed

<center> <math> B = (V_{max})^2\rho e/(P_n - P_c) \quad </math> (5) </center>

It was notable that the maximum wind speed is proportional to the square root of <math> B </math> and irrespective of the (<math> R_{max} </math>), given a constant pressure drop. It was also reasoned by Holland that a plausible range of <math> B </math> would be between 1 and 2.5 for realistic hurricanes. Substituting (4) and (5) back into (1) and (2) yields the final radial pressure and wind profiles for the HM

<center> <math> P(r) = P_c + (P_n - P_c)e^{-(R_{max}/r)^B} \quad </math> (6) </center>

<center> <math> V_g(r) = \sqrt{(V_{max})^2e^{1-(R_{max}/r)^B}(R_{max}/r)^B + (\frac{rf}{2})^2} - \frac{rf}{2} \quad </math> (7) </center>

When sparse observations of a hurricane are given, estimates of the <math> R_{max} </math> and shape parameter <math> B </math> can be estimated by fitting data into the radial wind equation, which in turn allow us to compute <math> P(r) </math> and <math> V_g(r) </math> along the radius <math> r </math> of the hurricane. However, discrepancies between wind observations and computed winds were sometimes found, and were negatively correlated to the Rossby number at <math> r = R_{max} </math>, defined as

<center> <math> R_o = \frac{Nonlinear Acceleration}{Coriolis force} \approx \frac{V_{max}^2/R_{max}}{V_{max}f} = \frac{V_{max}}{R_{max}f} \quad </math> (8) </center>

By definition, a large <math> R_o (\approx 10^3) </math> describes a system in cyclostrophic balance that is dominated by the inertial and centrifugal force with negligible Coriolis force, such as a tornado or the inner core of an intense hurricane, whereas a small value <math> (\approx 10^{-2} \sim 10^2) </math> signifies a system in geostrophic balance where the Coriolis force plays an important role, such as the outer region of a hurricane. As a result, the assumption of cyclostrophic balance at <math> R_{max} </math> made in HM is mostly valid for describing an intense and narrow (small <math> R_{max} </math>) hurricane with a large <math> R_o </math>, but not applicable for a weak and broad hurricane with a small <math> R_o </math>. This intrinsic problem with the HM calls our intention to develop a generalized model that will work consistently for a wide range of hurricanes, which theoretically can be accomplished by removing the above cyclostrophic balance assumption and re-derive the radial pressure and wind equations (6)&(7).


== Derivation of the GAHM ==

The GAHM also starts with the same radial pressure and wind equations (1)&(2) with shape parameters <math> A </math> and <math> B </math>, as in the HM. Without assuming cyclostrophic balance at <math> R_{max} </math>, we take <math> dV_g/dr = 0 </math> at <math> r = R_{max} </math> to get the adjusted shape parameter <math> B_g </math> as

<center> <math> B_g = \frac{(V_{max}^2 + V_{max}R_{max}f)\rho e^\varphi}{\varphi(P_n - P_c)} = B \frac{(1+1/R_o)e^{\varphi - 1}}{\varphi} \quad </math> (9) </center>

where <math> {\varphi} </math> is a scaling parameter introduced to simplify the derivation process, defined as

<center> <math> \varphi = \frac{A}{R_{max}^B} \quad </math> or <math> \quad A = \varphi R_{max}^B \quad </math> (10) </center>

and later derived as

<center> <math> \varphi = 1 + \frac{V_{max}R_{max}f}{B_g(V_{max}^2+V_{max}R_{max}f)} = 1 + \frac{1/R_o}{B_g(1+1/R_o)} \quad </math> (11) </center>

Thus, the <math> R_{max} </math> in the GAHM is not entirely defined by the shape parameters <math> A </math> and <math> B </math> as in the HM, but also by the scaling factor <math> {\varphi} </math>, as Equation (11) indicates that <math> {\varphi} \ge 1 </math>. Numerical solutions for <math> B_g </math> and <math> {\varphi} </math> can be solved iteratively in the model using Equation (9)&(11). Figure 1 illustrates how <math> B_g/B </math> and <math> \varphi </math> vary with <math> \log_{10}R_o </math> given different <math> B </math> values. It is evident that values of both <math> B_g/B </math> and <math> \varphi </math> remain close to 1 when <math> \log_{10}R_o </math> is within the range of [1,2], but increase noticeably as <math> \log_{10}R_o </math> decreases below 1, and the smaller the value of <math> B </math>, the bigger the changes.

[[File:Fig 1. GAHM.png|center|Profiles of Bg⁄B (left panel) and φ (right panel)]]
<center> Figure 1. Profiles of <math> B_g/B </math> (left panel) and <math> \varphi </math> (right panel) with respect to <math> \log_{10}R_o </math>, given different <math> B </math> values as shown in different colors. </center>

Substituting (9)&(11) back into (1)&(2) yields the final radial pressure and wind equations for the GAHM

<center> <math> P(r) = P_c + (P_n - P_c)e^{-\varphi(R_{max}/r)^{B_g}} \quad </math> (12) </center>

<center> <math> V_g(r) = \sqrt{V_{max}^2(1+1/R_o)e^{\varphi(1-(R_{max}/r)^{B_g})}(R_{max}/r)^{B_g} + (\frac{rf}{2})^2} - \frac{rf}{2} \quad </math> (13) </center>

Influence of the Coriolis force on the radial pressure and wind profiles are evidenced by the presence of <math> R_o </math> and <math> \varphi </math> in (12)&(13). A special case scenario is when we set <math> f=0 </math>, which corresponds to an infinitely large <math> R_o </math>, then (12)&(13) in the GAHM reduce to (6)&(7) in the HM. However，for a hurricane with a relatively small <math> R_o </math>, the influence of the Coriolis force can only be addressed by the GAHM. It meets our expectation that the GAHM’s solution approaches to that of the HM’s when the influence of Coriolis force is small, but departs from it when the Coriolis force plays an important role in the wind system.

The above reasoning can be demonstrated by the 3D plots in Figure 2, which show the normalized gradient winds of the HM (left panel) and the GAHM (right panel) as functions of the normalized radial distances <math> r/R_{max} </math>, the Holland <math> B </math> parameter, and <math> R_o </math>. In both panels, each colored surface represents the normalized gradient winds corresponding to a unique Holland B value. By definition, we get <math> V_g = V_{max} </math> at <math> r = R_{max} </math>, which means all the surfaces in each panel should intersect with the plane of <math> r/R_{max} = 1 </math> on the plane of <math> V_g/V_{max} = 1 </math>, no matter what values of <math> R_o </math>. However, the line of intersection (shown by the black line) shown in the left panel deviates from the plane of <math> V_g/V_{max} =1 </math> as <math> \log_{10}R_o </math> decreases from 2 to close to 0 (<math> R_o </math> decreases from 100 to 1), while remains on the plane regardless of how <math> R_o </math> changes in the right panel, demonstrating that the GAHM is mathematically more coherent than the HM.

[[File:Fig 2. GAHM.png|center|Comparison of the normalized gradient winds]]
<center> Figure 2. The normalized gradient wind profiles of the HM (left panel) and the GAHM (right panel) as functions of the normalized radial distances and <math> \log_{10}R_o </math>, given different Holland <math> B </math> values. </center>

To have a dissective look of the surface plots in Figure 2, we draw slices perpendicular to the axis of <math> \log_{10}R_o </math> at three different values 0, 1, 2, and plot the lines of intersection with each surface in Figure 3. It is evident that we get <math> V_g = V_{max} </math> at <math> r = R_{max} </math> consistently in the right panel for the GAHM regardless of the value of <math> R_o </math>. The HM in the left panel, however, generates distorted wind profiles with underestimated maximum winds skewed inward towards the storm center, espeically when <math> \log_{10}R_o < 1 </math>. As a results, when both models being applied to real hurricane cases, the GAHM will perform more consistently than the HM.

[[File:Fig 3. GAHM.png|center|Normalized gradient wind profiles]]
<center> Fig 3. Slices of the normalized gradient wind profiles (as shown in Figure 2) at <math> \log_{10}R_o =0, 1, 2 </math> (or correspondingly <math> R_o =1, 10, 100 </math>). </center>



== Calculation of the Radius to the Maximum Wind ==

Same with the HM and AHM, the GAHM also uses processed forecast advisories (during active hurricanes) or best track advisories (post-hurricanes) from the National Hurricane Center (NHC) in ATCF format as input files, which contain a time series of storm parameters (usually at 6-hour intervals) such as storm location, storm movement, central pressure, 1 minute averaged maximum wind, radii to the 34-, 50-, and/or 64-kt storm isotaches in 4 storm quadrants (NE, SE, SW, NW), etc. See meteorological input file with NWS = 20 for more details. As a standard procedure, the <math> B_g </math> and <math> R_{max} </math> are pre-computed in 4 storm quadrants for all available isotaches in the ASWIP program <ref group = "footnotes"> The auxiliary preprocessing program ASWIP.F (located in the /wind directory) was further developed here to accommodate the GAHM. </ref> and appended to the input file prior to running an ADCIRC simulation. The following describes the procedures to prepare the input file for the GAHM.

First, the influence of the boundary layer effect must be removed to bring the maximum sustained wind and the 34-, 50-, and/or 64-kt isotaches from 10 meter height to the gradient wind level. Practically, the maximum gradient wind can be directly calculated as

<center> <math> V_{max} = \vert \frac{\overrightarrow{V_M} - \gamma\overrightarrow{V_T}}{W_{rf}} \vert = \frac{V_M - \gamma V_T}{W_{rf}} \quad </math> (14) </center>

where <math> \overrightarrow{V_M} </math> is the reported maximum sustained wind at 10 meter height assuming in the same direction as <math> \overrightarrow{V_T} </math>, <math> \overrightarrow{V_T} </math> is the storm translational speed calculated from successive storm center locations, <math> W_{rf} = 0.9 </math> is the wind reduction factor for reducing wind speed from the gradient wind level to the surface at 10 meter height (Powell et al., 2003), and <math> \gamma </math> is the damp factor for <math> V_T </math>. The following formula of <math> \gamma </math> is employed in the ASWIP program:

<center> <math> \gamma = \frac{V_g}{V_{max}} \quad </math> (15) </center>

which is the ratio of gradient wind speed to the maximum wind speed along a radial wind profile. Thus, <math> \gamma </math> is zero at storm center, and increases with <math> r </math> until reaches a maximum value of 1 at <math> R_{max} </math>, then gradually decreases outward to zero.

In addition to the scalar reduction in wind speed, surface friction and continuity also cause the vortex wind to flow inward across isobars, with an inward rotation angle <math> \beta </math> according to the Queensland Government's Ocean Hazards Assessment (2001) <ref> Queensland Government, 2011: Queensland Climate Change and Community Vulnerability to Tropical Cyclone, ''Ocean Hazards Assessment – Stage 1''. </ref>:

<center> <math> \beta = \begin{cases}
10^{\circ}, & r<R_{max} \\
10^{\circ} + 75(r-R_{max})/R_{max}, & R_{max} \le r<1.2R_{max} \\
25^{\circ}, & r \ge 1.2R_{max}
\end{cases} \quad (16) </math> </center>

Thus, the gradient wind at the radii to specified storm isotaches in 4 storm quadrants can be obtained from the observed isotaches as

<center> <math> \begin{align}
V_r & = \vert \overrightarrow{V_r}\vert = \vert \overrightarrow{V_{inflow}}\vert \\
& = \frac{\vert\overrightarrow{V_{isot}} - \gamma\overrightarrow{V_T} \vert}{W_{rf}}
\end{align} \quad </math> (17) </center>

where <math> \overrightarrow{V_{isot}} </math> is the observed isotach wind speed with an unknown angle <math> \varepsilon </math>, and <math> \overrightarrow{V_{inflow}} </math> is the wind speed at radius to specified isotach before the inward rotation angle <math> \beta </math> is removed.

Rewriting (17) in x- and y-components yields:

<center> <math> V_r\cos(quad(i)+90+\beta)=V_{isot}\cos(\varepsilon)-\gamma {\mu}_T \quad </math> (18) </center>

<center> <math> V_r\sin(quad(i)+90+\beta)=V_{isot}\sin(\varepsilon)-\gamma {\nu}_T \quad </math> (19) </center>

where <math> quad(i) </math> is the azimuth angle of the <math> i-th </math> storm quadrant (NE, SE, SW, NW at <math> 45^\circ, 135^\circ, 225^\circ, 315^\circ </math>, respectively), <math> V_{isot}\cos(\varepsilon) </math> and <math> V_{isot}\sin(\varepsilon) </math> are the zonal and meridional components of <math> \overrightarrow{V_{isot}} </math>, <math> {\mu}_T </math> and <math> {\nu}_T </math> are the zonal and meridional components of <math> \overrightarrow{V_T} </math>.

Given an initial guess of <math> R_{max} </math>, values of <math> B_g </math> and <math> \varphi </math> can be solved iteratively from (9) and (11) until both converge, and <math> V_r </math> can be estimated by combining (15), (17), (18), and (19). Plugging <math> V_{max} </math> from (14), the above calculated <math> B_g, \varphi, V_{max}, V_r </math> and the observed radius <math> R_r </math> to <math> V_r </math> back into (13), a new <math> R_{max} </math> can be inversely solved by a root-finding algorithm. Since the above calculations are carried out based on an initial guess of <math> R_{max} </math>, wWe need to repeat the entire process until <math> R_{max} </math> converges.

In case where multiple isotaches are given in the forecast/best track advisories, the <math> R_{max} </math> for the highest isotach will be calculated using the above procedure, and used as the pseudo <math> R_{max} </math> for the entire storm (physically, there is only one <math> R_{max} </math> found along a radial wind profile ). For each lower isotach, <math> R_{max} </math> will be calculated with the pseudo <math> R_{max} </math> set as its initial value to determine the inward rotation angle <math> \beta </math> following the above process only once. The use of the pseudo <math> R_{max} </math> across all storm isotaches ensures that the cross-isobar frictional inflow angle changes smoothly along the radius according to (17).

Occasionally, we have to deal with situations where <math> V_{max} < V_r </math>, which violate (13) so <math> R_{max} </math> couldn't be calculated. These situations mostly happen in the right hand quadrants (in the Northern Atmosphere) of a weak storm with a relatively high translational speed. For cases like this, we assign <math> V_{max} = V_r </math>, which is equivalent to assigning <math> R_{max} = R_r </math>.

After the ASWIP program finishes processing the input file, it can be readily used by the GAHM to construct spatial pressure and wind fields in ADCIRC for storm surge forecast.



== Composite Wind Generation ==

Since storm parameters are only given in 4 storm quadrants (assuming at <math> 45^\circ, 135^\circ, 225^\circ, 315^\circ </math> azimuthal angles, respectively) at 3 available isotaches in the input file, spatial interpolation of storm parameters must take place first at each ADCIRC grid node. Traditionally, the single-isotach approach is used by the AHM, in which storm parameters will be interpolated azimuthally from the highest isotach only. To take advantage of the availability of multiple isotaches, a new composite wind method is introduced in the GAHM, the multiple-isotach approach, in which storm parameters will be interpolated both azimuthally and radially from all available isotaches.

To begin, the relative location of a node to the storm center at given time <math> t </math> is calculated, specified by the azimuth angle <math> \theta </math> and distance <math> d </math>. The angle <math> \theta </math> places the node between two adjacent quadrants <math> i </math> and <math> i+1 </math>, where <math> quad(i) < \theta \le quad(i+1) </math>. For each storm parameter <math> P </math> to be interpolated, its value at <math> (\theta,d) </math> are weighted between its values at two pseudo nodes <math> (quad(i),d) </math> and <math> (quad(i+1),d) </math>:

<center> <math> P(\theta,d)=\frac{P(quad(i),d)(90-\theta)^2+P(quad(i+1),d)\theta^2}{(90-\theta)^2+\theta^2} \quad </math> (20) </center>

The distance <math> d </math> then places each pseudo node between the radii of two adjacent isotaches in its quadrant, and the value at the pseudo node is interpolated using the inverse distance weighting (IDW) method:

<center> <math> P(quad,d) = f_{34}P_{34}+f_{50}P_{50}+f_{64}P_{64} \quad </math> (21) </center>

where <math> P_{34}, P_{50}, P_{64} </math> are parameter values computed from the 34-, 50-, and 64-isotach, <math> f_{34}, f_{50}, f_{64} </math> are distance weighting factors for each isotach, calculated as

<center> <math> \begin{array}{lll}
\mathrm{I}. & r<R_{64}& f_{64}=1,f_{50}=0,f_{34}=0 \\
\mathrm{II}. & R_{64}\le r<R_{50} & f_{64}=(r-R_{64})/(R_{50}-R_{64}),f_{50}=(R_{50}-r)/(R_{50}-R_{64}), f_{34}=0 \\
\mathrm{III}. & R_{50}\le r<R_{34} & f_{64}=0,f_{50}=(r-R_{50}/(R_{34}-R_{50})),f_{34}=(R_{34}-r/(R_{34}-R_{50})) \\
\mathrm{IV}. & r \le R_{34} & f_{64}=0,f_{50}=0,f_{34}=1
\end{array} \quad </math> (22) </center>

and <math> f_{34}+f_{50}+f_{64}=1 </math>.

The above procedure is performed at each node of an ADCIRC grid. After all storm parameters are interpolated, the pressure and gradient winds can be calculated using (12)&(13). To bring the gradient wind down to the standard 10 meter reference level, the same wind reduction factor <math> W_{rf} </math> is applied, and the tangential winds are rotated by an inward flow angle β according to (16). Then, the storm translational speed is added back to the vortex winds. Last but not least, a wind averaging factor is applied to convert resulted wind field from 1-min to 10-min averaged winds in order to be used by ADCIRC. This new composite wind method is simple and efficient, and more importantly, it assures that the constructed surface winds match all observed storm isotaches provided in NHC’s forecast or “best track” advisories.


== Case Studies ==
Preliminary evaluation of the GAHM was carried out based on seven hurricanes that struck the Gulf of Mexico and the Eastern United States: Katrina (2005), Rita (2005), Gustav (2008), Ike (2008), Irene (2011), Isaac (2012), and Sandy (2012), see Table 1. Ranging from category 1 to 5 on the Saffir-Simpson Hurricane Wind Scale, these storms vary in storm track, forward motion, size, intensity, and duration, but all caused severe damages to coastal states due to destructive winds, wind-induced storm surges, and ocean waves. Their “best track” advisories were retrieved from NHC’s ftp site (ftp://ftp.nhc.noaa.gov/atcf; previous years’ data are located in the archive directory) and pre-processed using the ASWIP program. The “best track” file contains an estimate of the radius to the maximum wind for each data entry, but will solely be used for model validation purpose as both the GAHM and AHM calculate their own spatially-varying <math> R_{max} </math>.

{| class="wikitable" style="text-align:center" style="margin: 1em auto 1em auto"
|+'''Table 1. Seven selected hurricanes used for preliminary evaluation of the GAHM'''
|-
! Hurricane !! Saffir-Simpson Wind Scale !! Maximum Sustained Wind (knot) !! Minimum Central Pressure (mbar) !! Period from Formation to Dissipation
|-
| '''Katrina''' || 5 || 150 || 902 || 08/23-08/30, 2005
|-
| '''Rita''' || 5 || 150 || 902 || 09/18-09/26, 2005
|-
| '''Gustav''' || 4 || 135 || 941 || 08/23-09/04, 2008
|-
| '''Ike''' || 4 || 125 || 935 || 09/01-09/14, 2008
|-
| '''Irene''' || 3 || 105 || 942 || 08/21-08/30, 2011
|-
| '''Isaac''' || 1 || 70 || 965 || 08/21-09/03, 2012
|-
| '''Sandy''' || 3 || 95 || 940 || 10/22-10/01, 2012
|}

Besides the maximum wind speed, both Holland <math> B </math> and <math> R_o </math> can be used as key storm characteristics to characterize the development of the storm. Figure 4 depicts the change of <math> V_M </math>, <math> B </math>, and <math> \log_{10}R_o </math> during different stages of the hurricanes along their best tracks. Typically, both <math> B </math> and <math> R_o </math> increase as hurricane strengthens, and decrease as hurricane dissipates, within the range of (0, 2.5). Previous analytical evaluation has demonstrated that the GAHM behaves consistently better than the HM, especially under situations where <math> \log_{10}R_o < 1 </math>. Here, evaluation of model performance will be carried out by comparing the modeled winds with the observed winds in the "best track" data, as well as the AHM, the SLOSH (Sea, Lake, and Overland Surges from Hurricanes) winds, re-analysis H*Wind and hindcast OWI modeled winds. The OWI winds and H*Winds are considered more mature wind products that are able to resolve more complex structures of a hurricane than the simple vortex models do.

{| border="0" cellpadding="5" cellspacing="0" align="center"
|-
| align="center" width="33%" | [[File:Fig 4. GAHM.png|360px]]
| align="center" width="33%" | [[File:Fig 5. GAHM.png|360px]]
| align="center" width="33%" | [[File:Fig 6. GAHM.png|360px]]
|-
| colspan="3" align="center" |Figure 4. The development of (a) The Maximum Wind Speed, (b) Holland <math> B </math>, and (c) <math> \log_{10}R_o </math> along the best tracks of 7 selected hurricanes
|}



=== The AHM vs. The GAHM ===

* '''Comparison of Radial Wind Profiles using the Single-Isotach Approach'''

Since the AHM is an advanced version of the HM, here we only use model results from the AHM for comparisons with the GAHM. First, the single-isotach approach was evaluated using Hurricane Irene (2011) as an example. Figure 5 gives the comparison of radial wind profiles of Hurricane Irene (2011) between the AHM and the GAHM using the single-isotach approach at three snapshots, each representing the developing (top panels), mature (middle panels), and dissipating (bottom panels) stages of the hurricane.

[[File:Fig 7. GAHM.png|center|Radial wind profiles of Irene (2011) at three different stages.]]

<center> Figure 5. Comparison of radial wind profiles of Irene (2011) at three different stages between the AHM and the GAHM. </center>

The cross-section radial winds from SW to NE are given in the left panels, and NW to SE in the right panels. The observed isotaches at radii to specified isotaches given in the "best track" file are also plotted as vertical line segments for reference (highest isotach in black and lower isotaches in gray). For a perfect match between the modeled winds and the isotaches, the radial profiles should meet the tip of the line segments at the exact same height. The <math> B </math>, <math> B_g </math> and <math> \log_{10}R_o </math> are also computed at the same snapshots in all 4 quadrants, given by Table 2.

{| class="wikitable" style="text-align:center" style="margin: 1em auto 1em auto" width = "75%"
|+'''Table 2. Key storm characteristics <math> B </math>, <math> B_g </math> and <math> \log_{10}R_o </math> at three snapshots of Irene (2011)'''
|
! colspan="4" | 2011-Aug-21 18:00
! colspan="4" | 2011-Aug-25 00:00
! colspan="4" | 2011-Aug-28 06:00
|-
| '''Quadrant''' || NE || SE || SE || NW || NE || SE || SW || NW ||NE || SE || SW || NW
|-
| '''<math> \boldsymbol{B} </math> '''|| 1.00 || 1.00 || 1.00 || 1.00 || 1.62 || 1.62 || 1.62 || 1.62 || 0.60 || 0.60 || 0.60 || 0.60
|-
| '''<math> \boldsymbol{B_g} </math> '''|| 1.24 || 1.03 || 1.05 || 1.19 || 1.69 || 1.69 || 1.65 || 1.68 || 1.11 || 0.92 || 0.72 || 0.73
|-
| '''<math> \boldsymbol{log_{10}R_o} </math> '''|| 0.64 || 1.44 || 1.26 || 0.74 || 1.37 || 1.36 || 1.70 || 1.41 || 0.28 || 0.33 || 0.74 || 0.82
|}

It is evident that the radial wind profiles generated by the GAHM consistently match the highest isotaches in all quadrants at different stages of Irene, no matter how <math> B </math> and <math> \log_{10}R_o </math> vary. The AHM did a similarly good job when the hurricane is strong (see middle panels), but failed to match the highest isotaches when <math> \log_{10}R_o < 1 </math>. Both the AHM and the GAHM winds died off too quickly away from the storm center, thus failed to match any lower isotaches.

* '''Evaluation of the Maximum Winds and Radius to Maximum Winds'''

Comparisons of the modeled maximum winds and radius to maximum winds to the observed values in the input file were also carried out based on all 7 selected hurricanes, given by the scatter plots in Figure 6. Evaluations of the maximum winds are given in the upper panels, while the radius to maximum winds given in lower panels, both color-coded by <math> \log_{10}R_o </math>, with a simple linear correlation given in each panel. Examination of the upper panels reveals that the GAHM did an excellent job in estimating the maximum winds, with a few overestimations near the lower bound of the dataset. Careful examinations of these over estimated values revealed that they were from those "bad" dada entries in the "best track" file that violate certain criteria in the GAHM when solving for the <math> R_{max} </math>. This phenomenon was particular common during the dissipating stage of a hurricane. The AHM had larger discrepancies in estimating the maximum wind compared to the GAHM, especially when <math> \log_{10}R_o < 1 </math>, which was a direct consequence of the cyclostrophic balance assumption made during the derivation of HM's equations. Examination of the lower panels reveals that the maximum value of the modeled azimuthally-varying <math> R_{max} </math> failed to match the observed <math> R_{max} </math> values given in the input file, but the trend of the GAHM was significantly better.

{| border="0" cellpadding="5" cellspacing="0" align="center"
|-
| align="center"|[[File:Fig 8.1. GAHM.png|800px]]
|-
| align="center"|[[File:Fig 8.2. GAHM.png|800px]]
|-
| align="center"|Figure 6. Comparison of the modeled and “Best Track” maximum winds (upper two panels), and the modeled and “Best Track” <math> R_{max} </math> (lower two panels) between the AHM and the GAHM based on all seven hurricanes.
|}

* '''Demonstration of the Multiple-Isotach Approach'''

Earlier we have shown that a radial wind profile constructed by the GAHM using the single-isotach approach would only match the highest isotach, due to limitations of this single-fitting method. In fact, underestimations of modeled winds at distances to isotachs other than the highest one were common, as the radial wind profile tends to die off too quickly away from the storm center due to the nature of GAHM’s formulas. In an effort to minimize the combined errors mentioned above, and to improve the overall accuracy of the estimated wind field, the multiple-isotach approach should be used whenever there is more than one isotach present in the best track file.

The 3D plots of Irene’s radial wind profiles (left) and interpolated spatial wind fields (right) by the GAHM using the single-isotach approach (upper panels) versus the multiple-isotach approach (lower panels) were given by Figure 7. For easier visualization, all available isotaches were plotted at radii to specified isotaches in the left two panels, and as contour lines (after azimuthal interpolation) in the right two panels. It is evident that winds generated by the multiple-isotach approach were able to match all given isotaches in all 4 quadrants, while only the highest isotach was matched by the single-isotach approach. Comparison of the spatial wind fields also indicated that the multiple-isotach approach allowed the wind to die off more gradually away from the storm center than the single-isotach approach did, demonstrated by the smaller gradient of the contour lines in the lower panel. It is believed that the multiple-isotach approach improves the overall accuracy and performance of the GAHM.

[[File:Fig 9. GAHM.png|center|800px|Irene’s radial wind profiles (left) and interpolated spatial wind field (right)]]
<center> Figure 7. 3D plot of Irene’s radial wind profiles (left) and interpolated spatial wind fields (right) by the single-isotach approach (upper panels) and the multiple-isotach approach (lower panels). </center>



=== Evaluation of GAHM's Composite Wind Field ===

* '''Comparison of Radial Wind Profiles'''

Using the multiple-isotach approach, radial wind profiles generated from the GAHM were compared to those from the AHM, the SLOSH, H*Winds, and OWI winds, shown in Figure 8 at three different stages of Irene (2011), with the left panels showing the SW to NE cross-section winds, and the right showing the NW to SE cross-section winds (same as in Figure 5). It is evident that the GAHM's composite radial wind profiles matched all available storm isotachs at all time, while the rest of the models failed most of the time. The SLOSH model, which is also a parametric wind model, does not take the isotach information to construct its wind field, so generally did a bad job matching any given isotaches. More detailed wind structures can be observed from the radial profiles extracted from the H*Wind and OWI winds than those from the parametric wind profiles, as expected. However, profiles from different models in general did not match each other due to different mechanisms involved in each model.

[[File:Picture12 GAHM.png|center|Comparison of radial wind profiles of Irene (2011)]]
<center> Figure 8. Comparison of radial wind profiles of Irene (2011) at three different stages among the AHM, the GAHM, SLOSH, H*Wind and OWI winds. </center>

* '''Evaluation of Model Results at Radii to Given Isotaches'''

[[File:Picture13 GAHM.png|center|Comparison of specified isotachs and modeled winds]]
<center> Figure 9. Evaluation of modeled wind at radii to given isotaches based on all seven selected storms. </center>

Quantitative evaluation of the GAHM's performance at radii to given isotaches were given in Figure 9, with statistics given in Table 3, based on all seven selected hurricanes. The GAHM had almost perfect match to each of the 34-, 50-, and 64-kt isotaches, with a standard deviation around 0.1 kt, which was very impressive. The AHM matched the 64-kt isotach reasonably well with a mean of 63.3 kts, but failed at the lower isotaches. The SLOSH did not take any isotach information to construct its wind fields, thus behaved poorly in matching any given isotaches. Its data also had the largest spread compared to other models, with standard deviation ranging from 11 to 16 kts. For the H*Wind and the OWI winds, the means of modeled winds were close to each specified isotach, generally within ±3 kts, but the spreads of data were also large compared to that of the AHM and the GAHM, with a standard deviation greater than 7 kts.

{| class="wikitable" style="text-align:center" style="margin: 1em auto 1em auto" width = "75%"
|+'''Table 3. Statistical analysis of modeled winds at radii to specified isotaches based on all seven storms'''
|
! colspan="3" | MEAN (kt)
! colspan="3" | Standard Deviation (kt)
|-
|
| Iso-34 || Iso-50 || Iso-64 || Iso-34 || Iso-50 || Iso-64
|-
| '''AHM''' || 26.9 || 44.7 || 63.3 || 7.96 || 7.09 || 2.55
|-
| '''GAHM''' || 34.0 || 50.0 || 64.0 || 0.10 || 0.12 || 0.10
|-
| '''SLOSH''' || 30.0 || 48.9 || 69.5 || 11.00 || 14.11 || 16.08
|-
| '''OWI''' || 33.1 || 48.3 || 61.3 || 7.65 || 8.71 || 9.42
|-
| '''H*Wind''' || 34.9 || 49.2 || 61.2 || 7.55 || 8.88 || 8.89
|}

* '''Comparison of Spatial Wind fields'''


Comparisons of spatial wind fields among the AHM, the GAHM using the multiple-isotach approach, the SLOSH, H*Wind and OWI winds (in rows) were given by Figure 10 at the same snapshots (in columns) as in Figure 8. The 34-, 50-, and 64-kt contour lines were shown in each wind snapshot. In general, the AHM and GAHM winds shared a lot of similarities. During weaker periods of Irene, the differences between the AHM and the GAHM's spatial wind fields were mostly observed in the inner region of the hurricane due to differences in calculated <math> R_{max} </math>. More specifically, the calculated <math> R_{max} </math> in the AHM was under-predicted (thus is closer to the storm center) than that in the GAHM, resulted from the faulty cyclostrophic balance assumption made in the HM and AHM. During stronger periods of Irene, however, the differences were mostly observed in the outer region of the hurricane due to the usage of the multiple-isotach approach in the GAHM. Without taking into account storm information from lower isotaches, the AHM winds tended to die off too quickly away from the storm center. The SLOSH winds did not show much similarity to the AHM and GAHM winds. It used an azimuthally constant <math> R_{max} </math> from the "best track" file to generate its vortex winds, and a distance-weighted translational speed to account for storm asymmetry, which was not rendered properly when the storm was strong. The winds fields of H*Wind and OWI winds were much more complex than those of the simple parametric models, but the GAHM did a relatively good job matching the spatial patterns of the hurricane. Although it is unlikely that the parametric winds constructed over a minimum set of data would match the level of details and complexity in the re-analysis H*Wind and the numerical OWI winds, the ability of a the GAHM to produce reasonable estimates of surface wind fields in a timely manner was highly desirable for real-time forecasting.

[[File:Fig 10. GAHM.png|center|Three snapshots (in columns) of Irene’s two-dimensional wind fields by the AHM, GAHM, SLOSH, H*Wind and OWI winds]]
<center> Figure 10. Comparison of Irene’s spatial wind fields by the AHM, GAHM, SLOSH, H*Wind and OWI winds at three different stages </center>

== Notes ==
<references group = "footnotes" />

== References ==
<references />

[[Category:physics]]
[[Category:meteorology]]

NWS

2024-05-23T16:06:30Z

Taylorgasher: /* Parameter Summary */ fixed link

'''<code>NWS</code>''' is a parameter in the [[fort.15 file]] that selects the meteorological forcing input type. The value on the "[[fort.15_file_format#NWS|NWS line]]" of the fort.15 file also implicitly includes [[#Value Seen in fort.15 File|other parameters]] affecting wave coupling and ice inputs. Further, <code>NWS</code> affects not just the file type and handling of meteorological data, but also changes what the [[Fort.15_file_format#WTIMINC|meteorological parameter line]] (informally, the <code>[[WTIMINC]]</code> line) looks like in the fort.15 file. See the [[supplemental meteorological/wave/ice parameters]] page for information on the format of this line.

ADCIRC supports a wide range of meteorological input formats, including moving/fixed gridded data in several file formats, tropical cyclone track and parameter data that can be turned into wind/pressure fields via one of several internal vortex models, and direct specification of wind speeds or stresses on nodes. As a result of the great flexibility and importance of this choice, several pages are devoted to the topic. In particular, see also the [[fort.22 file]] and [[wind stress]] pages.

== Value Seen in fort.15 File ==
In the fort.15 file, what we call "NWS" is actually a combination of several parameters. For example, given a 5-digit value on that line,
-12305 ! TRICKY NWS IMPOSTER
the first two digits (ten-thousands and thousands) tell us the format of ice data <code>[[NCICE]]=12</code>, the 3rd digit (hundreds) tells us the wave coupling mode <code>[[NRS]]=3</code>, and the last two digits (tens and ones) combined with the sign of the entire value tell us the meteorological forcing mode <code>NWS=-5</code>. If the value has only 3 digits then ADCIRC assumes no ice input <code>[[NCICE]]=0</code>, and if it's 2 digits then ADCIRC further assumes no wave coupling <code>[[NRS]]=0</code>. It is often presumed that when one refers to "NWS", one is referring to the 2-digit value, not what is in the fort.15 file, but be mindful of the ambiguity here.

== Parameter Summary ==
The following table is a summary of possible <code>NWS</code> values, their descriptions, and associated meteorological input files (required and optional).

{| class="wikitable" border="1"
|-
! <code>NWS</code> Value
! Short-name
! Description
! Required Input Files
! Optional Input Files
|-
| 1
| Wind stress, every node, every timestep
| Wind stress and atmospheric pressure are read in at all grid nodes at every model time step from the [[fort.22_file_format#NWS = 1 or 101|fort.22 file]]
| [[fort.22_file_format#NWS = 1 or 101|fort.22]]
|
|-
| 2
| Wind stress, every node, every [[WTIMINC]]
| Wind stress and atmospheric pressure are read in at all grid nodes at a time interval that does not equal the model time step from the [[fort.22_file_format#NWS = 2, -2, 102 or -102|fort.22 file]]. Interpolation in time is used to synchronize the wind and pressure information with the model time step. The wind time interval ([[WTIMINC]]) is specified in the [[fort.15_file_format|fort.15 file]].
| [[fort.22_file_format#NWS = 2, -2, 102 or -102|fort.22]]
|
|-
| 3
| US Navy Fleet Numeric
| Wind velocity is read in from a wind file from the [[fort.22_file_format#NWS = 3 or 103, Fleet Numeric Format|fort.22 file]] in US Navy Fleet Numeric format. This information is interpolated in space onto the ADCIRC grid and in time to synchronize the wind and pressure information with the model time step. Garret’s formula is used to compute wind stress from the wind velocity. Several parameters describing the Fleet Numeric wind file must be specified in the [[fort.15_file_format|fort.15 file]].
| [[fort.22_file_format#NWS = 3 or 103, Fleet Numeric Format|fort.22]]
|
|-
| 4
| PBL/JAG
| Wind velocity and atmospheric pressure are read in (PBL/JAG format) at selected ADCIRC grid nodes from the [[fort.22_file_format#NWS = 4, -4, 104 or -104 - PBL Hurricane Model format|fort.22]] file. Interpolation in time is used to synchronize the wind and pressure information with the model time step. Garret’s formula is used to compute wind stress from wind velocity.
| [[fort.22_file_format#NWS = 4, -4, 104 or -104 - PBL Hurricane Model format|fort.22]]
|
|-
| 5
| Wind velocity, every node, every [[WTIMINC]]
| Wind velocity and atmospheric pressure are read in at all grid nodes from the [[fort.22_file_format#NWS = 5, -5, 105, or -105|fort.22]] File. Interpolation in time is used to synchronize the wind and pressure information with the model time step. Garret’s formula is used to compute wind stress from wind velocity.
| [[fort.22_file_format#NWS = 5, -5, 105, or -105|fort.22]]
|
|-
| 6
| wind velocity, rectangular grid, every [[WTIMINC]]
| Meteorological data (U,V,P) is input on a rectangular grid (either in Longitude, Latitude or Cartesian coordinates, consistent with the grid coordinates) and interpolated in space onto the ADCIRC grid. Wind velocity (U,V @ 10 m above the water surface) must be input in units of m/s and surface atmospheric pressure (P) must be input in units of Pascals = Newtons/square meter. The meteorological grid MUST cover the entire ADCIRC mesh; that is, the ADCIRC mesh must be ENTIRELY within the meteorological grid or an error will result.
| [[fort.22_file_format#NWS = 6 or 106|fort.22]]
|
|-
| 7 {{ADC version|version=future|relation=eq}}
| Wind stress, regular grid, every [[WTIMINC]]
| Surface stress and pressure values are read in on a regular grid from the [[fort.22_file_format|fort.22 file]]. Currently, this feature is not supported for parallel runs because adcprep cannot decompose the files. See [https://github.com/adcirc/adcirc-cg/issues/215].
| [[fort.22_file_format#NWS = 7 or -7|fort.22]]
|
|-
| 8
| Symmetric Holland Vortex
| Wind velocity and atmospheric pressure are calculated at every node on the fly by ADCIRC internally using the Dynamic Holland model.
| [[Fort.22_file_format#NWS_.3D_8|fort.22]]
|
|-
| 10
| NCDC GFS
| Wind velocity (10 m) and atmospheric pressure are read in from a sequence of National Weather Service (NWS) Aviation (AVN) model output files. Each AVN file is assumed to contain data on a Gaussian longitude, latitude grid at a single time.
| [[fort.200_file_format|fort.200, fort.200+N, fort.200+2*N, fort.200+3*N,….,]] where N is the time interval (in hours) between successive meteorological data
|
|-
| 11
| National Weather Service Eta-29 file
| Wind velocity (10 m) and atmospheric pressure are read in from a sequence of stripped down National Weather Service (NWS) ETA 29km model output files
| [[fort.200_file_format|fort.200, fort.201, fort.202, fort.203,….,]]
|
|-
|-
| 12 / -12
| OWI ASCII, every [[WTIMINC]]
| See [[NWS12]] for details. Wind velocities (U10, V10) and atmospheric sea level pressure (SLP) are provided in the OWI ASCII format on one to three rectangular (lat/lon) grid(s)
| [[Fort.22_file_format#NWS_.3D_12|fort.22]], [[fort.221]], [[fort.222]]
| [[fort.223]], [[fort.224]], [[fort.217]], [[fort.218]]
|-
| 13 {{ADC version|version=55|relation=ge}}
| OWI NetCDF
| See [[NWS13]] for details. Wind velocities (U10, V10) and atmospheric sea level pressure (SLP) fields are provided in the OWI NetCDF format as 1 or more meshgrid overlays stored in netCDF groups, supporting storm following grids on overlay 2 and on.
| default is [[fort.22.nc]], see [[NWS13]]
|
|-
| 14 / -14 {{ADC version|version=55|relation=ge}}
| GRIB2/NetCDF Binary, every [[WTIMINC]]
| Gridded data of wind velocities (U10, V10) and atmospheric sea level pressure (SLP) are provided in GRIB2 (e.g., GFS, CFSv2) or NetCDF (e.g., ERA5, WRF) binary files. Gridded data may be on a standard rectangular lat/lon grid, a [https://en.wikipedia.org/wiki/Gaussian_grid Gaussian grid], or a projected WRF-like grid. Requires that ADCIRC is compiled with DATETIME, NetCDF and if required, GRIB2 flags enabled (the static libraries must be compiled). Will find and read time-snaps based on the reference date, [[NCDATE]] located near or at the bottom of the [[fort.15_file_format|fort.15 file]] taking into account hot-start times etc. If the negative value is used, OWI ASCII (see NWS = 12) meteorology will overwrite the GRIB2/NetCDF meteorology data in the overlap region (except during the "skipping OWI time snap" phase).
| [[fort.22x.grb2 file|fort.221.grb2, fort.222.grb2]] '''or''' [[Fort.22_file#NWS_.3D_.C2.B114_Gridded_GRIB2_or_NetCDF_Wind_and_Pressure|fort.22]], [[fort.221.nc]], [[fort.222.nc]]
|
|-
| 15
| HWIND
| Uses data assimilated snapshots of the wind velocity fields of tropical cyclones that are produced by the NOAA Hurricane Research Division (HRD)
| [[fort.22_file_format#NWS = 15|fort.22]]
| Additional HWIND files specified in the [[fort.22_file_format#NWS = 15|fort.22]] file
|-
| 16
| GFDL
| GFDL model output files produced by the Geophysical Fluid Dynamics Laboratory at NOAA. Each ASCII GFDL model output file contains one or more nested grid dataset where the nested grids are allowed to change in time. Coarse grid data is not stored where finer nest data is given.
| [[fort.22_file_format#NWS = 16|fort.22]]
| Additional GFDL files specified in the [[fort.22_file_format#NWS = 16|fort.22]] file
|-
| 19
| Dynamic Asymmetric Model<ref group="note" name="nws19bad">Use of this [[Typical_ADCIRC_Parameter_Selections#Discouraged_Parameter_Selections|is discouraged]].</ref>
| Wind velocity and atmospheric pressure are calculated at exact finite element mesh node locations and directly coupled to ADCIRC at every time step using the asymmetric hurricane vortex formulation based on the Holland gradient wind model. The input file is assumed to correspond to the ATCF Best Track/Objective Aid/Wind Radii Format. This option uses the radii at specific wind speeds (34, 50, 64, 100 knots) reported in the four quadrants (NE, SE, SW, NW) of the storm to calculate the radius of maximum winds as a function of the azimuthal angle. Garret’s formula is used to compute wind stress from the wind velocity. This option allows the user to set a value for Rmax and Holland B Parameter. Additionally the user can select the isotachs to be used for each of the 4 quadrants. The utility program aswip_1.0.3.F located in the /wind folder will generate the NWS=19 formatted file from a NWS=9 formatted fort.22 input file.
| [[fort.22_file_format#NWS = 19|fort.22]]
|
|-
| 20
| [[Generalized Asymmetric Holland Model]]
| The Generalized Asymmetric Holland Model (GAHM) provides a set of theoretical and practical improvements over previous parametric meteorological vortex models in ADCIRC. The track file format is similar to that of the older Dynamic Asymmetric Model (NWS = 19) but with 8 additional columns of data.
| [[fort.22_file_format#NWS = 20 Generalized Asymmetric Holland Vortex Model (GAHM)|fort.22]]
|
|}

==Extended NWS with Ice + Waves==
The following presents a summary of the extended <code>NWS</code> values to included ice-coverage and/or wind wave-coupling

{| class="wikitable" border="1"
|-
! style="font-weight:bold;" |Meteorological Data Format
! style="font-weight:bold;" |Met. Only
! style="font-weight:bold;" |Met. plus Waves from fort.23
! style="font-weight:bold;" |Met. plus Waves SWAN
! style="font-weight:bold;" |Met. plus Waves STWAVE
! style="font-weight:bold;" |Met. plus Ice Coverage, Waves off
! style="font-weight:bold;" |Met. plus Ice Coverage OWI-like format plus Waves from fort.23
! style="font-weight:bold;" |Met. plus Ice Coverage OWI-like format plus Waves from SWAN
! style="font-weight:bold;" |Met. plus Ice Coverage OWI-like format plus Waves from STWAVE
|-
|none
| 0
| n/a
| n/a
| n/a
| n/a
| n/a
| n/a
|-
|wind stress, every node, every timestep
| 1
| 101
| 301
| 401
|
| 12101
| 12301
| 12401
|-
|wind stress, every node, every WTIMINC
| 2
| 102
| 302
| 402
|
| 12102
| 12302
| 12402
|-
|US Navy Fleet Numeric
| 3
| 103
| 303
| 403
|
| 12103
| 12303
| 12403
|-
|PBL/JAG
| 4
| 104
| 304
| 404
|
| 12104
| 12304
| 12404
|-
|wind velocity, every node, every WTIMINC
| 5
| 105
| 305
| 405
|
| 12105
| 12305
| 12405
|-
|wind velocity, rectangular grid, every WTIMINC
| 6
| 106
| 306
| 406
|
| 12106
| 12306
| 12406
|-
|wind stress, regular grid, every WTIMINC
| 7
| 107
| 307
| 407
|
| 12107
| 12307
| 12407
|-
|symmetrc vortex model
| 8
| 108
| 308
| 408
|
| 12108
| 12308
| 12408
|-
|asymmetric vortex model (no longer available)
| n/a
| n/a
| n/a
| n/a
| n/a
| n/a
| n/a
| n/a
|-
|National Weather Service AVN
| 10
| 110
| 310
| 410
| 10010 (ice in 4th column of AVN file)
| 12110
| 12310
| 12410
|-
|National Weather Service ETA 29km
| 11
| 111
| 311
| 411
|
| 12111
| 12311
| 12411
|-
|Oceanweather Inc (OWI)
| 12
| 112
| 312
| 412
|
| 12112
| 12312
| 12412
|-
|Oceanweather Inc (OWI) NetCDF
| 13
| 113?
| 313?
| 413?
|
| 12113?
| 12313?
| 12413?
|-
|GRIB2/NetCDF
| 14
| 114
| 314
| 414
| 14014 (GRIB2/NetCDF format ice)
| 14114 (GRIB2/NetCDF format ice)
| 14314 (GRIB2/NetCDF format ice)
| 14414 (GRIB2/NetCDF format ice)
|-
|H*Wind
| 15
| 115
| 315
| 415
|
| 12115
| 12315
| 12415
|-
|Dynamic Asymmetric Holland Model<ref group="note" name="nws19bad"></ref>
| 19
| 119
| 319
| 419
|
| 12119
| 12319
| 12419
|-
|[[Generalized Asymmetric Holland Model]]
| 20
| 120
| 320
| 420
|
| 12120
| 12320
| 12420
|
|}

== Notes ==
<references group="note" />

Wind Stress

2024-03-22T18:34:19Z

Taylorgasher: /* Interpolating Roughness Lengths Before v55 */ adding video

When wind blows over the water, it exerts a shear stress at the water surface that transfers horizontal momentum vertically downward across the air–sea interface, driving circulation. In ADCIRC, wind stress is an input forcing term, with several different formats provided. See the <code>[[NWS]]</code> parameter for available formats. In most cases, the exact wind stress to be applied to the model is not provided, therefore ADCIRC must determine how to convert a given wind speed to the actual stress applied at the ocean surface. This page covers the various aspects of this process, as well as the options available to the user.

== Definition of Winds ==
The characteristics of wind forcing are often broken down in three ways:
# Whether the winds are considered to be over-water (termed "marine exposure") or over-land
# The elevation above the sea (or ground) surface of the winds
# The time-averaging (if any) that has been applied

ADCIRC generally expects 10-meter, 10-minute winds at their actual exposure, although the exact expectations vary depending on the input type. For instance, when Holland-type wind inputs are provided (e.g. <code>NWS=8</code> or <code>NWS=20</code>), the wind speed is expected to be the '''1-minute [https://en.wikipedia.org/wiki/Maximum_sustained_wind maximum sustained wind]''' at 10 meters elevation. If marine-exposure winds are provided, then [[Fort.13_file#Surface_Roughness|surface roughness]] reductions may be needed
<ref name="simiu1996">Simiu, E., Scanlan, R.H., 1996. Wind effects on structures: fundamentals and applications to design, 3rd ed. ed. John Wiley, New York.</ref>
<ref name="simiu2018">Simiu, E., Yeo, D., 2018. Wind effects on structures: modern structural design for wind, Fourth edition. ed. John Wiley & Sons, Hoboken, NJ.</ref>
. If winds are provided with a different averaging time, then an appropriate correction may be needed, though winds with averaging times of 10 to 60 minutes are generally considered to be quite similar; this is the so-called mesoscale gap. For recommendations on wind time-scale conversions not handled internally by ADCIRC, for tropical cyclones, see the WMO guidelines of Harper et al.
<ref name="wmotcaveraging">Harper, B., Kepert, J., Ginger, J., 2010. Guidelines for converting between various wind averaging periods in tropical cyclone conditions (No. WMO/TD-No. 1555). WMO, Geneva, Switzerland.</ref>

== Roughness Reductions ==
Reductions in wind speed to convert to the appropriate exposure come from a logarithmic boundary layer formulation (see, e.g. <ref name="simiu1996" /> <ref name="simiu2018" />) to determine a fraction <math>f</math> to reduce the winds,
:<math>f=\left ( \frac{z_{0l}}{z_{0m}}\right ) ^{0.0706} \left ( \frac{\ln \frac{10}{z_{0l}}}{\ln \frac{10}{z_{0m}}} \right ) </math>
for marine roughness length <math>z_{0m}</math> and reduced ("land") roughness length <math>z_{0l}</math>. Wind speed is then reduced as,
:<math>\mathbf{w}'=f\mathbf{w}=f [u,v]</math>
for x- and y- wind vector components <math>u</math> and <math>v</math>. The marine roughness length is,
:<math>z_{0m}=\frac{0.018}{g} c_d \left \Vert \mathbf{w} \right \| </math>
for Charnock parameter <math>0.018</math>, drag coefficient <math>c_d</math> and acceleration due to gravity <math>g</math>. The wind drag coefficient is addressed below in [[#Converting Wind Velocity to Wind Stress|this section]]. As previously noted, the reduced ("land") roughness length <math>z_{0l}</math> is specified by the user via the [[Fort.13_file#Surface_Roughness|surface roughness]] nodal attribute. The fraction <math>f</math> is bounded on <math>[0,1]</math>, meaning the winds cannot be increased, nor change direction.

=== Older Behavior ===
====Interpolating Roughness Lengths Before v55====
[[File:WindTraceV2.png|right|frameless|Comparison of output wind velocities using old and new methods.]]

{{ADC version|version=55|relation=lt}}Before version 55, the directional wind reductions were applied by determining which of the 12 directional bins the wind velocity (at each time step) fell into, and using that roughness reduction, i.e. nearest neighbor interpolation. Starting in version 55, the roughness length is linearly (in angle space) interpolated between directional bins. In testing, this has been found to generally have a very small effect on water levels, but a notable effect on wind speeds, since time evolution of winds is smoother. It can have large localized effects on water levels in cases where there are large changes in neighboring roughness length bins coinciding with well-aligned winds, as in [[:File:MaxeleDiffRun13MinusRun12View1.png|this test case]] with Hurricane Isaac.
[[File:Run03masterVsRun05interp trimmedAndAnnotatedTry7-min.gif|thumb|500px|Video of wind speeds before (left) and after (right) adding linear interpolation of surface roughness.]]
 

====Roughness Reduction Bug Before v54====
{{ADC version|version=54|relation=lt}}Before version 54, there was a bug in this calculation. The mistake and its effects are addressed in this PDF document: '''ADD A LINK TO A PDF HERE YOOOOO'''.

== Converting Wind Velocity to Wind Stress ==
In ADCIRC, four formulations are available to convert wind velocities to the wind stresses applied in the momentum equations. Although there are several ways to control this, users are generally encouraged to use the [[metControl]] namelist in the [[fort.15]] file. The default drag formulation is the Garratt
<ref name=garratt1977>Garratt, J.R., 1977. Review of Drag Coefficients over Oceans and Continents. Mon. Wea. Rev. 105, 915–929. https://doi.org/10.1175/1520-0493(1977)105<0915:RODCOO>2.0.CO;2</ref>
linear formula. An alternative for use with tropical cyclones is the Powell formulation,
<ref>Powell, M.D., Vickery, P.J., Reinhold, T.A., 2003. Reduced drag coefficient for high wind speeds in tropical cyclones. Nature 422, 279–283. https://doi.org/10.1038/nature01481</ref>
which varies drag by the sector of the tropical cyclone. When ice coverage is included in the model, a wind drag formulation that accounts for this effect should be used. By default, if ice coverage input data are supplied, ADCIRC uses a cubic function of ice coverage, termed the "IceCube" drag formulation. Lastly, the "swell" drag law option allows users to utilize SWAN's drag formulation when employing the coupled model.

In all cases, the actual wind drag coefficients determined by ADCIRC can be output to a [[fort.63]]-type file named [[winddrag.173]]. Output settings (file format, output start/end times, and output interval) match those of either the fort.63 or fort.73/74 files, ''I think'' fort.73/74. Outputting of this file is enabled by setting <code>outputWindDrag=.TRUE.</code> in the <code>&metControl</code> namelist of the [[Fort.15_file_format#Namelists|fort.15 file's namelist section]].

=== Garratt Drag Formulation ===
This is the default wind drag formulation in ADCIRC. From Garratt (1977)<ref name=garratt1977></ref>, the formula is,
:<math>c_d=0.001 \left ( 0.75+0.067 \left \Vert \mathbf{w} \right \| \right ) </math>

By default, ADCIRC puts an upper bound on the drag coefficient of <math>c_d\le0.0035</math>. This upper bound <code>WindDragLimit</code> can be changed via the [[metControl]] fort.15 namelist.

=== Powell Drag Formulation ===
CONTRIBUTOR NEEDED
Note that the code for the Powell drag law has not been configured to reverse orientation in the southern hemisphere, and so will produce the wrong results. For details on Powell, see [https://ccht.ccee.ncsu.edu/wind-drag-based-on-storm-sectors/ this post].

=== IceCube Drag Formulation ===
CONTRIBUTOR NEEDED

==References==
<references />

[[Category:meteorology]]
[[Category:physics]]

User:Taylorgasher

2024-03-22T18:25:23Z

Taylorgasher:

My user page

== etc. ==
<nowiki><nowiki>'''not bold text''' ''not italic text'' not ADC version {{ADC version|version=-4E7|relation=ge}} </nowiki></nowiki>

<nowiki>A redirect: #REDIRECT [[Fort.13_file#Nodal_Attributes]]</nowiki>

<nowiki></nowiki>

== gifo sho ==
[[File:Run03masterVsRun05interp trimmedAndAnnotatedTry7-min.gif|frame|alt=or not?|oh yeah]]

== syntax highlivin ==
monty
<syntaxhighlight lang="python" line='line'>
def quick_sort(arr):
less = []
pivot_list = []
more = []
if len(arr) <= 1:
return arr
else:
pass
</syntaxhighlight>

fortless
<syntaxhighlight lang="fortran" line='line'>
! I N I T W I N D M O D U L E
! ----------------------------------------------------------------
subroutine initWindModule()
use mesh, only : np
call setMessageSource("initWindModule")
#if defined(WIND_TRACE) || defined(ALL_TRACE)
call allMessage(DEBUG,"Enter.")
#endif
allocate ( wvnx1(np),wvny1(np) )
allocate ( wvnx2(np),wvny2(np) )
allocate ( prn1(np) )
allocate ( prn2(np) )

C well this commenting approach does not work
if(yourMom.eq.fat)then
write(*,*)'ahahahahaha'
endif !looks like this doesn't work
IF((EyeLat(1).EQ.0.D0).OR.(EyeLon(1).EQ.0.D0).OR.
& (EyeLat(2).EQ.0.D0).OR.(EyeLon(2).EQ.0.D0).OR.
& (EyeLat(3).EQ.0.D0).OR.(EyeLon(3).EQ.0.D0))THEN
FoundEye = .FALSE.
ENDIF

!.... tcm v49.16 20100617 added
!.... convert background pressure from millibars to meters of water
PRBCKGRND_MH2O = 100.0D0*PRBCKGRND/(RHOWAT0*G)
prn1 = PRBCKGRND_MH2O
prn2 = PRBCKGRND_MH2O

CALL checkWindDragType()
CALL mapWindDragFunctionPointer()

#if defined(WIND_TRACE) || defined(ALL_TRACE)
call allMessage(DEBUG,"Return.")
#endif
call unsetMessageSource()

! ----------------------------------------------------------------
END SUBROUTINE initWindModule
! ----------------------------------------------------------------
</syntaxhighlight>
== some mats ==
:<math>a_b(c)=\left ( \frac{de^2}{\sqrt[6]{f+\alpha(\beta)}} \right ) ^{\Tau^\tau}</math>



:<math>\{ A \mid A \in \mathbb{E} \land \mathbb{E} - (N \cup R) \} </math>
for <math>A</math> Andrew, <math>\mathbb{E}</math> the entire space, <math>N</math> Nickelback fans, and <math>R</math> Republicans.

== linky ==
<nowiki>[[#test table| link to subsection or anchor in same page]]</nowiki>[[#test table| link to subsection or anchor in same page]]

== test table ==
but

{| class="wikitable"
|-
| apple || pear
|-
| orange || grape
|}

srsly

{| style="background-color: orange; border-style: solid; border-width: 2px"
|-
|
{| style="border-style: solid; border-width: 4px"
| ap || ple
|}
|
{| style="border-style: solid; border-width: 4px"
| pe || ar
|}
|-
|
{| style="border-style: solid; border-width: 4px"
| ora || nge
|}
|
{| style="border-style: solid; border-width: 4px"
| gr || ape
|}
|}

Some norma text

== wind drag in/out notes ==
see email with John, subject line "Outputting wind drag coefficients"

winddrag.173
or
winddrag.173.nc

outputWindDrag=.true.

&metControl

from ncdump -h winddrag.173.nc:

double winddrag(time, node) ;
winddrag:long_name = "wind drag coefficient at sea level" ;
winddrag:standard_name = "wind drag coefficient" ;
winddrag:coordinates = "time y x" ;
winddrag:location = "node" ;
winddrag:mesh = "adcirc_mesh" ;
winddrag:units = "unitless" ;
winddrag:_FillValue = -99999. ;

== test transclus ==


== yup ==
Internal tide energy conversion refers to the energy conversion from barotropic to baroclinic modes as surface tides flow over steep and rough topography in the deep ocean generating internal tides. The "lost" barotropic tidal energy is often accounted for through a linear friction term in large-scale numerical models that are barotropic or not fine-scaled enough to resolve the energy conversion. It is implemented in ADCIRC through a spatially varying [[nodal attribute]] called [[internal_tide_friction]], in the [[fort.13 file]].

== Background and Theory ==
For a review.<ref>C. Garrett, E. Kunze, Internal Tide Generation in the Deep Ocean, Annu. Rev. Fluid Mech. 39 (2007) 57–87. doi:10.1146/annurev.fluid.39.050905.110227.</ref>

How it was known that internal energy conversion is important to the global energy balance of the surface tides.<ref>G.D. Egbert, R.D. Ray, Significant dissipation of tidal energy in the deep ocean inferred from satellite altimeter data, Nature. 405 (2000) 775–778. doi:10.1038/35015531</ref><ref>G.D. Egbert, R.D. Ray, Estimates of M2 tidal energy dissipation from TOPEX/Poseidon altimeter data, J. Geophys. Res. Ocean. 106 (2001) 22475–22502. doi:10.1029/2000JC000699.</ref>

== Attribute Summary ==
In a computational domain covering a large portion of the deep ocean it is critical to include the effect of internal tide energy conversion to obtain more accurate tidal solutions. The user should only elect to use the internal_tide_friction nodal attribute when tides are included in the simulation through tidal boundary conditions and tidal potential functions. The attribute is unnecessary for domains that are small in size and/or do not cover a significant portion of the deep ocean (taken here to mean the portion of the ocean excluding the continental shelf).

ADCIRC reads the internal_tide_friction attribute in as the ''IT_Fric'' variable, which can have 1 (scalar) or 3 (tensor) dimensions. The attribute has dimensions of [1/time], meaning that it is a linear friction term which is multiplied by the velocity in the governing equations, and is normalized by the ocean depth prior to simulation. Hence, it ignores the water surface elevation portion of the total water depth, which is reasonable since the term and theory it is based on is only applicable to deep ocean. Typically, it is only applied to ocean depths greater than 100-500 m.

== Specifying ''IT_Fric'' Values ==
''IT_Fric'' values are determined through analytical formulations based on Bell's linear theory<ref name="Bell1975">{{cite journal|last1=Bell|first1=T.H.|title=Topographically generated internal waves in the open ocean|journal=Journal of Geophysical Research|volume=80|year=1975|pages=320–327|doi=10.1029/JC080i003p00320}}</ref>, valid in what is called sub-critical topography.

Recent publications using ADCIRC<ref>W.J. Pringle, D. Wirasaet, A. Suhardjo, J. Meixner, J.J. Westerink, A.B. Kennedy, S. Nong, Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities, Ocean Model. 129 (2018) 13–38. doi:10.1016/j.ocemod.2018.07.003.</ref><ref>W.J. Pringle, D. Wirasaet, J.J. Westerink, Modifications to Internal Tide Conversion Parameterizations and Implementation into Barotropic Ocean Models, EarthArXiv. (2018) 9. doi:10.31223/osf.io/84w53.</ref> provide relevant formulation and implementation details.

==References==
{{Reflist}}

Wind Stress

2024-03-22T18:23:35Z

Taylorgasher: /* Interpolating Roughness Lengths Before v55 */ typo

When wind blows over the water, it exerts a shear stress at the water surface that transfers horizontal momentum vertically downward across the air–sea interface, driving circulation. In ADCIRC, wind stress is an input forcing term, with several different formats provided. See the <code>[[NWS]]</code> parameter for available formats. In most cases, the exact wind stress to be applied to the model is not provided, therefore ADCIRC must determine how to convert a given wind speed to the actual stress applied at the ocean surface. This page covers the various aspects of this process, as well as the options available to the user.

== Definition of Winds ==
The characteristics of wind forcing are often broken down in three ways:
# Whether the winds are considered to be over-water (termed "marine exposure") or over-land
# The elevation above the sea (or ground) surface of the winds
# The time-averaging (if any) that has been applied

ADCIRC generally expects 10-meter, 10-minute winds at their actual exposure, although the exact expectations vary depending on the input type. For instance, when Holland-type wind inputs are provided (e.g. <code>NWS=8</code> or <code>NWS=20</code>), the wind speed is expected to be the '''1-minute [https://en.wikipedia.org/wiki/Maximum_sustained_wind maximum sustained wind]''' at 10 meters elevation. If marine-exposure winds are provided, then [[Fort.13_file#Surface_Roughness|surface roughness]] reductions may be needed
<ref name="simiu1996">Simiu, E., Scanlan, R.H., 1996. Wind effects on structures: fundamentals and applications to design, 3rd ed. ed. John Wiley, New York.</ref>
<ref name="simiu2018">Simiu, E., Yeo, D., 2018. Wind effects on structures: modern structural design for wind, Fourth edition. ed. John Wiley & Sons, Hoboken, NJ.</ref>
. If winds are provided with a different averaging time, then an appropriate correction may be needed, though winds with averaging times of 10 to 60 minutes are generally considered to be quite similar; this is the so-called mesoscale gap. For recommendations on wind time-scale conversions not handled internally by ADCIRC, for tropical cyclones, see the WMO guidelines of Harper et al.
<ref name="wmotcaveraging">Harper, B., Kepert, J., Ginger, J., 2010. Guidelines for converting between various wind averaging periods in tropical cyclone conditions (No. WMO/TD-No. 1555). WMO, Geneva, Switzerland.</ref>

== Roughness Reductions ==
Reductions in wind speed to convert to the appropriate exposure come from a logarithmic boundary layer formulation (see, e.g. <ref name="simiu1996" /> <ref name="simiu2018" />) to determine a fraction <math>f</math> to reduce the winds,
:<math>f=\left ( \frac{z_{0l}}{z_{0m}}\right ) ^{0.0706} \left ( \frac{\ln \frac{10}{z_{0l}}}{\ln \frac{10}{z_{0m}}} \right ) </math>
for marine roughness length <math>z_{0m}</math> and reduced ("land") roughness length <math>z_{0l}</math>. Wind speed is then reduced as,
:<math>\mathbf{w}'=f\mathbf{w}=f [u,v]</math>
for x- and y- wind vector components <math>u</math> and <math>v</math>. The marine roughness length is,
:<math>z_{0m}=\frac{0.018}{g} c_d \left \Vert \mathbf{w} \right \| </math>
for Charnock parameter <math>0.018</math>, drag coefficient <math>c_d</math> and acceleration due to gravity <math>g</math>. The wind drag coefficient is addressed below in [[#Converting Wind Velocity to Wind Stress|this section]]. As previously noted, the reduced ("land") roughness length <math>z_{0l}</math> is specified by the user via the [[Fort.13_file#Surface_Roughness|surface roughness]] nodal attribute. The fraction <math>f</math> is bounded on <math>[0,1]</math>, meaning the winds cannot be increased, nor change direction.

=== Older Behavior ===
====Interpolating Roughness Lengths Before v55====
[[File:WindTraceV2.png|right|thumb|Comparison of output wind velocities using old and new methods.]]
{{ADC version|version=55|relation=lt}}Before version 55, the directional wind reductions were applied by determining which of the 12 directional bins the wind velocity (at each time step) fell into, and using that roughness reduction, i.e. nearest neighbor interpolation. Starting in version 55, the roughness length is linearly (in angle space) interpolated between directional bins. In testing, this has been found to generally have a very small effect on water levels, but a notable effect on wind speeds, since time evolution of winds is smoother. It can have large localized effects on water levels in cases where there are large changes in neighboring roughness length bins coinciding with well-aligned winds, as in [[:File:MaxeleDiffRun13MinusRun12View1.png|this test case]] with Hurricane Isaac.
 

====Roughness Reduction Bug Before v54====
{{ADC version|version=54|relation=lt}}Before version 54, there was a bug in this calculation. The mistake and its effects are addressed in this PDF document: '''ADD A LINK TO A PDF HERE YOOOOO'''.

== Converting Wind Velocity to Wind Stress ==
In ADCIRC, four formulations are available to convert wind velocities to the wind stresses applied in the momentum equations. Although there are several ways to control this, users are generally encouraged to use the [[metControl]] namelist in the [[fort.15]] file. The default drag formulation is the Garratt
<ref name=garratt1977>Garratt, J.R., 1977. Review of Drag Coefficients over Oceans and Continents. Mon. Wea. Rev. 105, 915–929. https://doi.org/10.1175/1520-0493(1977)105<0915:RODCOO>2.0.CO;2</ref>
linear formula. An alternative for use with tropical cyclones is the Powell formulation,
<ref>Powell, M.D., Vickery, P.J., Reinhold, T.A., 2003. Reduced drag coefficient for high wind speeds in tropical cyclones. Nature 422, 279–283. https://doi.org/10.1038/nature01481</ref>
which varies drag by the sector of the tropical cyclone. When ice coverage is included in the model, a wind drag formulation that accounts for this effect should be used. By default, if ice coverage input data are supplied, ADCIRC uses a cubic function of ice coverage, termed the "IceCube" drag formulation. Lastly, the "swell" drag law option allows users to utilize SWAN's drag formulation when employing the coupled model.

In all cases, the actual wind drag coefficients determined by ADCIRC can be output to a [[fort.63]]-type file named [[winddrag.173]]. Output settings (file format, output start/end times, and output interval) match those of either the fort.63 or fort.73/74 files, ''I think'' fort.73/74. Outputting of this file is enabled by setting <code>outputWindDrag=.TRUE.</code> in the <code>&metControl</code> namelist of the [[Fort.15_file_format#Namelists|fort.15 file's namelist section]].

=== Garratt Drag Formulation ===
This is the default wind drag formulation in ADCIRC. From Garratt (1977)<ref name=garratt1977></ref>, the formula is,
:<math>c_d=0.001 \left ( 0.75+0.067 \left \Vert \mathbf{w} \right \| \right ) </math>

By default, ADCIRC puts an upper bound on the drag coefficient of <math>c_d\le0.0035</math>. This upper bound <code>WindDragLimit</code> can be changed via the [[metControl]] fort.15 namelist.

=== Powell Drag Formulation ===
CONTRIBUTOR NEEDED
Note that the code for the Powell drag law has not been configured to reverse orientation in the southern hemisphere, and so will produce the wrong results. For details on Powell, see [https://ccht.ccee.ncsu.edu/wind-drag-based-on-storm-sectors/ this post].

=== IceCube Drag Formulation ===
CONTRIBUTOR NEEDED

==References==
<references />

[[Category:meteorology]]
[[Category:physics]]

File:Run03masterVsRun05interp trimmedAndAnnotatedTry7-min.gif

2024-03-22T17:52:28Z

Taylorgasher:

GIF showing differences in wind speeds from improved (linear interpolation) of surface_directional_effective_roughness_length values.

Fort.15 file format

2024-03-15T20:36:51Z

Taylorgasher: /* Namelists */ added smag namelist, reorganized, cleaned up namelists section

The basic file structure of the [[fort.15 file]] is shown below. Each line of input data is represented by a line containing the input variable name(s). Inputs in the [[fort.15 file]] must be entered in the exact order shown on this page. '''Blank lines and headings are only to enhance readability.''' Loops indicate multiple lines of input. 
==Main Controls==
===Metadata and Logging===
'''<code>[[RUNDES]]'''</code> - alphanumeric run description 1, 32 characters or less 
'''<code>[[RUNID]]'''</code> - alphanumeric run description 2, 24 characters or less 
'''<code>[[NFOVER]]'''</code> - non-fatal error override option 
'''<code>[[NABOUT]]'''</code> - verbosity of run log output, <code>= -1</code> is debug mode, higher is less output, up to <code>3</code> for errors only 
'''<code>[[NSCREEN]]'''</code> - directs log messages to the screen (<code>> 0</code>), the adcirc.log file (<code>< 0</code>), or disables them (<code>= 0</code>) 


===Numerics & Physics===
'''<code>[[IHOT]]'''</code> - whether to read a hotstart file 
'''<code>[[ICS]]</code>''' - coordinate projection to run in 
'''<code>[[IM]]</code>''' - model run mode 
'''<code>[[IDEN]]</code>''' - density forcing mode, ''include this line only if:'' <code>[[IM]] = 20, 21, 30, 31</code>, or if <code>IM</code>'s last 6-digit entry is > 4 (e.g., <code>513115</code>). 
'''<code>[[NOLIBF]]</code>''' - bottom stress parameterization mode 
'''<code>[[NOLIFA]]</code>''' - finite amplitude term and wetting/drying mode, off if <code>= 0</code> 
'''<code>[[NOLICA]]</code>''' - advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NOLICAT]]</code>''' - time-derivative advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NWP]]</code>''' - number of [[nodal attribute]]s 
''for j=1 to <code>[[NWP]]</code>'' 
: '''<code>[[AttrName(j)]]</code>''' - nodal attributes to use, ''include this line only if:'' <code>[[NWP]] > 0</code> 
''end j loop'' 
'''<code>[[NCOR]]</code>''' - Coriolis control, spatially constant if <code>= 0</code>, varies with latitude if <code>= 1</code> 
'''<code>[[NTIP]]</code>''' - tidal potential forcing control, off if <code>= 0</code> 
'''<code>[[NWS#Value_Seen_in_fort.15_File|NWS]]</code>''' - meteorological, wave, and ice forcing control 
'''<code>[[NRAMP]]</code>''' - forcing ramping control 
'''<code>[[G]]</code>''' - acceleration due to gravity 
'''<code>[[TAU0]]</code>''' - affects numerical diffusion/stability of governing equations 
'''<code>[[Tau0FullDomainMin]] [[Tau0FullDomainMax]]</code>''' - limits on <code>[[TAU0]]</code>, ''include this line only if:''<code>TAU0 = -5.0</code>. 
'''<code>[[DTDP]]</code>''' - model time step (seconds) and predictor-corrector control 
'''<code>[[STATIM]]</code>''' - shifts numeric value of starting simulation time (days) 
'''<code>[[REFTIM]]</code>''' - shifts reference time (days) for tidal harmonic analysis 
'''[[Supplemental_Meteorological/Wave/Ice_Parameters|Meteorological controls including <code>WTIMINC, RSTIMINC</code>]]''' - ''include this line:'' for most cases of <code>NWS ≠ 0</code>, see linked page for details. 
'''<code>[[RNDAY]]</code>''' - end time of simulation (days) 
'''[[Ramping|Ramping controls including <code>DRAMP, FluxSettlingTime</code>]]''' - ''include this line only if:'' <code>NRAMP > 0</code>, see linked page for details 
'''<code>[[A00 B00 C00]]</code>''' - time weighting factors in GWCE 
'''<code>[[H0]]</code>''' - minimum depth, ''include this line only if:'' <code>[[NOLIFA]] = 0</code> or <code>1</code>'' 
'''<code>[[H0]]</code> <code>INTEGER</code> <code>INTEGER</code> <code>[[VELMIN]]</code>''' - alternate minimum depth controls, ''include this line only if:'' <code>[[NOLIFA]] = 2</code> or <code>3</code>'' 
'''<code>[[SLAM0]] [[SFEA0]]</code>''' - longitude and latitude for center of CPP coordinate projection 
'''<code>[[TAU]]</code>''' - linear bottom friction coefficient, ''include this line only if:'' <code>[[NOLIBF]] = 0</code>'' 
'''<code>[[CF]]</code>''' - quadratic bottom friction coefficient or limit, ''include this line only if:'' <code>[[NOLIBF]] = 1</code>'' 
'''<code>[[CF]]</code> <code>[[HBREAK]]</code> <code>[[FTHETA]]</code> <code>[[FGAMMA]]</code>''' - alternate quadratic bottom friction controls, ''include this line only if:'' <code>[[NOLIBF]] = 2</code>'' 
'''<code>[[ESLM]]</code>''' - horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 0</code>, <code>1</code>, or <code>2</code>'' 
'''<code>[[ESLM]]</code> <code>[[ESLC]]</code>''' - alternate horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 10</code>'' 
'''<code>[[CORI]]</code>''' - constant Coriolis coefficient, ''only used if'' <code>NCOR=0</code>

===Periodic (Tidal) Body Forcing===
[[NTIF]] 
for k=1 to [[NTIF]]
: [[TIPOTAG(k)]]
: [[TPK(k)]], [[AMIGT(k)]], [[ETRF(k)]], [[FFT(k)]], [[FACET(k)]]
end k loop

===Periodic (Tidal) Boundary Elevations===
[[NBFR]] 
for k=1 to [[NBFR]] 
: [[BOUNTAG(k)]] 
: [[AMIG(k)]], [[FF(k)]], [[FACE(k)]] 
end k loop 
for k=1 to [[NBFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NETA]] 
:: [[EMO(k,j), EFA(k,j)]] 
: end j loop 
end k loop

===Periodic (Tidal) Boundary Velocities===
[[ANGINN]] 
[[NFFR]] - include this line only if [[IBTYPE]] = 2, 12, 22, 32 or 52 in the Grid and Boundary Information File 
for k=1 to [[NFFR]] 
: [[FBOUNTAG(k)]] 
: [[FAMIGT(k),FFF(k),FFACE(k)]] 
end k loop 
for k=1 to [[NFFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NVEL]] 
:: [[QNAM(k,j), QNPH(k,j)]] - use this line if [[IBTYPE]] = 2, 12, 22 in the Grid and Boundary Information File 
:: [[QNAM(k,j), QNPH(k,j)]], [[ENAM(k,j), ENPH(k,j)]] - use this line if [[IBTYPE]] = 32 in the Grid and Boundary Information File 
:end j loop 
end k loop

===Model Output===
[[NOUTE]], [[TOUTSE]], [[TOUTFE]], [[NSPOOLE]] 
[[NSTAE]] 
for k=1 to [[NSTAE]] 
: [[XEL(k), YEL(k)]] - use these lines if [[NSTAE]] is positive. If negative, stations are listed in the [[elev_stat.151]] file 
end k loop 
[[NOUTV]], [[TOUTSV]], [[TOUTFV]], [[NSPOOLV]] 
[[NSTAV]] 
for k=1 to [[NSTAV]] 
: [[XEV(k), YEV(k)]] - use these lines if [[NSTAV]] is positive. If negative, stations are listed in the [[vel_stat.151]] file 
end k loop 
[[NOUTC]], [[TOUTSC]], [[TOUTFC]], [[NSPOOLC]] - include this line only if IM =10 
[[NSTAC]] - include this line only if IM =10 
for k=1 to [[NSTAC]] 
: [[XEC(k), YEC(k)]] 
end k loop 
[[NOUTM]], [[TOUTSM]], [[TOUTFM]], [[NSPOOLM]] - include this line only if NWS is not equal to zero. 
[[NSTAM]] - include this line only if NWS is not equal to zero. 
for k=1 to [[NSTAM]] 
: [[XEM(k), YEM(k)]] - use these lines if [[NSTAM]] is positive. If negative, stations are listed in the [[met_stat.151]] file 
end k loop 
[[NOUTGE]], [[TOUTSGE]], [[TOUTFGE]], [[NSPOOLGE]] 
[[NOUTGV]], [[TOUTSGV]], [[TOUTFGV]], [[NSPOOLGV]] 
[[NOUTGC]], [[TOUTSGC]], [[TOUTFGC]], [[NSPOOLGC]] - include this line only if IM =10 
[[NOUTGW]], [[TOUTSGW]], [[TOUTFGW]], [[NSPOOLGW]] - include this line only if NWS is not equal to zero.

====Harmonic Analysis====
[[NFREQ]] 
for k=1 to [[NFREQ]] 
: [[NAMEFR(k)]] 
: [[HAFREQ(k), HAFF(k), HAFACE(k)]] 
end k loop 
[[THAS]], [[THAF]], [[NHAINC]], [[FMV]] 
[[NHASE]], [[NHASV]], [[NHAGE]], [[NHAGV]]

====Hotstart Output and Numeric Controls====
[[NHSTAR]], [[NHSINC]] 
[[ITITER]], [[ISLDIA]], [[CONVCR]], [[ITMAX]] 

''For a 2DDI ADCIRC run that does not use netCDF nor namelists, the file ends here. For those controls, see further below in the [[#NetCDF Controls|NetCDF Controls]] and [[#Namelists|Namelists]] sections.''

==3D Model Run==
[[IDEN]] 
[[ISLIP]], [[KP]] 
[[Z0S,Z0B]] 
[[ALP1,ALP2,ALP3]] 
[[IGC]], [[NFEN]] 
for k=1 to [[NFEN]] (include this loop only if [[IGC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[SIGMA(k)]] 
end k loop 
[[IEVC]], [[EVMIN]], [[EVCON]] 
for k=1 to [[NFEN]] (include this loop only if [[IEVC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[EVTOT(k)]] 
end k loop 
[[THETA1, THETA2]](include this line only if [[IEVC]] = 50 or 51) 
[[I3DSD,TO3DSDS,TO3DSDF,NSPO3DSD]] 
[[NSTA3DD]] 
for k=1 to [[NSTA3DD]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DSV,TO3DSVS,TO3DSVF,NSPO3DSV]] 
[[NSTA3DV]] 
for k=1 to [[NSTA3DV]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DST,TO3DSTS,TO3DSTF,NSPO3DST]] 
[[NSTA3DT]] 
for k=1 to [[NSTA3DT]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DGD]],[[TO3DGDS]],[[TO3DGDF]],[[NSPO3DGD]] 
[[I3DGV]],[[TO3DGVS]],[[TO3DGVF]],[[NSPO3DGV]] 
[[I3DGT]],[[TO3DGTS]],[[TO3DGTF]],[[NSPO3DGT]] 
The following line will be read in if [[IM]] is 21 or 31. 
[[RES_BC_FLAG]], [[BCFLAG_LNM]], [[BCFLAG_TEMP]] 
The following two lines will be read in if [[RES_BC_FLAG]] is negative. 
[[RBCTIMEINC]] 
[[BCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 2. 
[[RBCTIMEINC]], [[SBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3. 
[[RBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 4. 
[[RBCTIMEINC]], [[SBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3 or 4 and [[BCFLAG_TEMP]] is not equal to 0. 
[[TTBCTIMEINC]], [[TTBCSTATIM]] 
[[TTBCTIMEINC]] 
The following two lines will be read in only if [[IM]] is 21 or 31. 
[[SPONGEDIST]] 
[[EQNSTATE]] 
The following lines will be read in only if [[IDEN]] is > 0. 
[[NLSD, NVSD]] 
[[NLTD, NVTD]] 
[[ALP4]] 
The following line will be read in only if [[IDEN]] = 3 or 4. 
[[NTF]]

==NetCDF Controls==
The following lines will be read in only if the NetCDF output or hotstart format is chosen 
NCPROJ 
NCINST 
NCSOUR 
NCHIST 
NCREF 
NCCOM 
NCHOST 
NCCONV 
NCCONT 
NCDATE

==Namelists==
The following Fortran namelist lines are optional, but if they appear, they must appear at the very end of the fort.15 file. Namelist entries can have blank lines between them, and individual entries in a given namelist can be on separate lines in addition to being comma-delimited. Each namelist is terminated by a slash. 
<code>&[[AliDispersionControl]] CAliDisp=logicalValue, Cs=floatValue, Ad=floatValue, Bd=floatValue /</code>

<code>&[[Dynamic_water_level_correction#Controlling_Water_Level_Correction|dynamicWaterLevelCorrectionControl]] dynamicWaterLevelCorrectionFileName='stringValue', dynamicWaterLevelCorrectionMultiplier=floatValue, dynamicWaterLevelCorrectionRampStart=floatValue, dynamicWaterLevelCorrectionRampEnd=floatValue, dynamicWaterLevelCorrectionRampReferenceTime='stringValue', dynamicWaterLevelCorrectionSkipSnaps=integerValue /</code>

<code>&[[Horizontal_eddy_viscosity#Smagorinsky_Eddy_Viscosity|Smag_Control]] SMAG_LOWER_LIM=floatValue, SMAG_UPPER_LIM=floatValue /</code>

<code>&inundationOutputControl inundationOutput=logicalValue0, inunThresh =floatValue /</code>

<code>&metControl WindDragLimit=floatValue, DragLawString='stringValue', rhoAir=floatValue, outputWindDrag=logicalValue /</code>

<code>&subdomainModeling subdomainOn=logicalValue/</code>

<code>&SWANOutputControl SWAN_OutputHS=logicalValue, SWAN_OutputDIR=logicalValue, SWAN_OutputTM01=logicalValue, SWAN_OutputTPS=logicalValue, SWAN_OutputWIND=logicalValue, SWAN_OutputTM02=logicalValue, SWAN_OutputTMM10=logicalValue /</code>

<code>&timeBathyControl NDDT=integerValue, BTIMINC=floatValue, BCHGTIMINC=floatValue, invertedBarometerOnElevationBoundary=logicalValue /</code>

<code>&TVWControl use_TVW=logicalValue, TVW_file='stringValue', nout_TVW =integerValue, touts_TVW =floatValue, toutf_TVW=floatValue, nspool_TVW =integerValue /</code>

<code>&WarnElevControl WarnElev=floatValue, ErrorElev=floatValue, WarnElevDump=logicalValue, WarnElevDumpLimit=integerValue /</code>

<code>&waveCoupling WindWaveMultiplier=floatValue /</code>

<code>&wetDryControl outputNodeCode=logicalValue, outputNOFF=logicalValue, noffActive=logicalValue /</code>

[[category:input files]]

Fort.15 file format

2024-03-15T20:27:11Z

Taylorgasher: /* Namelists */ typo

The basic file structure of the [[fort.15 file]] is shown below. Each line of input data is represented by a line containing the input variable name(s). Inputs in the [[fort.15 file]] must be entered in the exact order shown on this page. '''Blank lines and headings are only to enhance readability.''' Loops indicate multiple lines of input. 
==Main Controls==
===Metadata and Logging===
'''<code>[[RUNDES]]'''</code> - alphanumeric run description 1, 32 characters or less 
'''<code>[[RUNID]]'''</code> - alphanumeric run description 2, 24 characters or less 
'''<code>[[NFOVER]]'''</code> - non-fatal error override option 
'''<code>[[NABOUT]]'''</code> - verbosity of run log output, <code>= -1</code> is debug mode, higher is less output, up to <code>3</code> for errors only 
'''<code>[[NSCREEN]]'''</code> - directs log messages to the screen (<code>> 0</code>), the adcirc.log file (<code>< 0</code>), or disables them (<code>= 0</code>) 


===Numerics & Physics===
'''<code>[[IHOT]]'''</code> - whether to read a hotstart file 
'''<code>[[ICS]]</code>''' - coordinate projection to run in 
'''<code>[[IM]]</code>''' - model run mode 
'''<code>[[IDEN]]</code>''' - density forcing mode, ''include this line only if:'' <code>[[IM]] = 20, 21, 30, 31</code>, or if <code>IM</code>'s last 6-digit entry is > 4 (e.g., <code>513115</code>). 
'''<code>[[NOLIBF]]</code>''' - bottom stress parameterization mode 
'''<code>[[NOLIFA]]</code>''' - finite amplitude term and wetting/drying mode, off if <code>= 0</code> 
'''<code>[[NOLICA]]</code>''' - advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NOLICAT]]</code>''' - time-derivative advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NWP]]</code>''' - number of [[nodal attribute]]s 
''for j=1 to <code>[[NWP]]</code>'' 
: '''<code>[[AttrName(j)]]</code>''' - nodal attributes to use, ''include this line only if:'' <code>[[NWP]] > 0</code> 
''end j loop'' 
'''<code>[[NCOR]]</code>''' - Coriolis control, spatially constant if <code>= 0</code>, varies with latitude if <code>= 1</code> 
'''<code>[[NTIP]]</code>''' - tidal potential forcing control, off if <code>= 0</code> 
'''<code>[[NWS#Value_Seen_in_fort.15_File|NWS]]</code>''' - meteorological, wave, and ice forcing control 
'''<code>[[NRAMP]]</code>''' - forcing ramping control 
'''<code>[[G]]</code>''' - acceleration due to gravity 
'''<code>[[TAU0]]</code>''' - affects numerical diffusion/stability of governing equations 
'''<code>[[Tau0FullDomainMin]] [[Tau0FullDomainMax]]</code>''' - limits on <code>[[TAU0]]</code>, ''include this line only if:''<code>TAU0 = -5.0</code>. 
'''<code>[[DTDP]]</code>''' - model time step (seconds) and predictor-corrector control 
'''<code>[[STATIM]]</code>''' - shifts numeric value of starting simulation time (days) 
'''<code>[[REFTIM]]</code>''' - shifts reference time (days) for tidal harmonic analysis 
'''[[Supplemental_Meteorological/Wave/Ice_Parameters|Meteorological controls including <code>WTIMINC, RSTIMINC</code>]]''' - ''include this line:'' for most cases of <code>NWS ≠ 0</code>, see linked page for details. 
'''<code>[[RNDAY]]</code>''' - end time of simulation (days) 
'''[[Ramping|Ramping controls including <code>DRAMP, FluxSettlingTime</code>]]''' - ''include this line only if:'' <code>NRAMP > 0</code>, see linked page for details 
'''<code>[[A00 B00 C00]]</code>''' - time weighting factors in GWCE 
'''<code>[[H0]]</code>''' - minimum depth, ''include this line only if:'' <code>[[NOLIFA]] = 0</code> or <code>1</code>'' 
'''<code>[[H0]]</code> <code>INTEGER</code> <code>INTEGER</code> <code>[[VELMIN]]</code>''' - alternate minimum depth controls, ''include this line only if:'' <code>[[NOLIFA]] = 2</code> or <code>3</code>'' 
'''<code>[[SLAM0]] [[SFEA0]]</code>''' - longitude and latitude for center of CPP coordinate projection 
'''<code>[[TAU]]</code>''' - linear bottom friction coefficient, ''include this line only if:'' <code>[[NOLIBF]] = 0</code>'' 
'''<code>[[CF]]</code>''' - quadratic bottom friction coefficient or limit, ''include this line only if:'' <code>[[NOLIBF]] = 1</code>'' 
'''<code>[[CF]]</code> <code>[[HBREAK]]</code> <code>[[FTHETA]]</code> <code>[[FGAMMA]]</code>''' - alternate quadratic bottom friction controls, ''include this line only if:'' <code>[[NOLIBF]] = 2</code>'' 
'''<code>[[ESLM]]</code>''' - horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 0</code>, <code>1</code>, or <code>2</code>'' 
'''<code>[[ESLM]]</code> <code>[[ESLC]]</code>''' - alternate horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 10</code>'' 
'''<code>[[CORI]]</code>''' - constant Coriolis coefficient, ''only used if'' <code>NCOR=0</code>

===Periodic (Tidal) Body Forcing===
[[NTIF]] 
for k=1 to [[NTIF]]
: [[TIPOTAG(k)]]
: [[TPK(k)]], [[AMIGT(k)]], [[ETRF(k)]], [[FFT(k)]], [[FACET(k)]]
end k loop

===Periodic (Tidal) Boundary Elevations===
[[NBFR]] 
for k=1 to [[NBFR]] 
: [[BOUNTAG(k)]] 
: [[AMIG(k)]], [[FF(k)]], [[FACE(k)]] 
end k loop 
for k=1 to [[NBFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NETA]] 
:: [[EMO(k,j), EFA(k,j)]] 
: end j loop 
end k loop

===Periodic (Tidal) Boundary Velocities===
[[ANGINN]] 
[[NFFR]] - include this line only if [[IBTYPE]] = 2, 12, 22, 32 or 52 in the Grid and Boundary Information File 
for k=1 to [[NFFR]] 
: [[FBOUNTAG(k)]] 
: [[FAMIGT(k),FFF(k),FFACE(k)]] 
end k loop 
for k=1 to [[NFFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NVEL]] 
:: [[QNAM(k,j), QNPH(k,j)]] - use this line if [[IBTYPE]] = 2, 12, 22 in the Grid and Boundary Information File 
:: [[QNAM(k,j), QNPH(k,j)]], [[ENAM(k,j), ENPH(k,j)]] - use this line if [[IBTYPE]] = 32 in the Grid and Boundary Information File 
:end j loop 
end k loop

===Model Output===
[[NOUTE]], [[TOUTSE]], [[TOUTFE]], [[NSPOOLE]] 
[[NSTAE]] 
for k=1 to [[NSTAE]] 
: [[XEL(k), YEL(k)]] - use these lines if [[NSTAE]] is positive. If negative, stations are listed in the [[elev_stat.151]] file 
end k loop 
[[NOUTV]], [[TOUTSV]], [[TOUTFV]], [[NSPOOLV]] 
[[NSTAV]] 
for k=1 to [[NSTAV]] 
: [[XEV(k), YEV(k)]] - use these lines if [[NSTAV]] is positive. If negative, stations are listed in the [[vel_stat.151]] file 
end k loop 
[[NOUTC]], [[TOUTSC]], [[TOUTFC]], [[NSPOOLC]] - include this line only if IM =10 
[[NSTAC]] - include this line only if IM =10 
for k=1 to [[NSTAC]] 
: [[XEC(k), YEC(k)]] 
end k loop 
[[NOUTM]], [[TOUTSM]], [[TOUTFM]], [[NSPOOLM]] - include this line only if NWS is not equal to zero. 
[[NSTAM]] - include this line only if NWS is not equal to zero. 
for k=1 to [[NSTAM]] 
: [[XEM(k), YEM(k)]] - use these lines if [[NSTAM]] is positive. If negative, stations are listed in the [[met_stat.151]] file 
end k loop 
[[NOUTGE]], [[TOUTSGE]], [[TOUTFGE]], [[NSPOOLGE]] 
[[NOUTGV]], [[TOUTSGV]], [[TOUTFGV]], [[NSPOOLGV]] 
[[NOUTGC]], [[TOUTSGC]], [[TOUTFGC]], [[NSPOOLGC]] - include this line only if IM =10 
[[NOUTGW]], [[TOUTSGW]], [[TOUTFGW]], [[NSPOOLGW]] - include this line only if NWS is not equal to zero.

====Harmonic Analysis====
[[NFREQ]] 
for k=1 to [[NFREQ]] 
: [[NAMEFR(k)]] 
: [[HAFREQ(k), HAFF(k), HAFACE(k)]] 
end k loop 
[[THAS]], [[THAF]], [[NHAINC]], [[FMV]] 
[[NHASE]], [[NHASV]], [[NHAGE]], [[NHAGV]]

====Hotstart Output and Numeric Controls====
[[NHSTAR]], [[NHSINC]] 
[[ITITER]], [[ISLDIA]], [[CONVCR]], [[ITMAX]] 

''For a 2DDI ADCIRC run that does not use netCDF nor namelists, the file ends here. For those controls, see further below in the [[#NetCDF Controls|NetCDF Controls]] and [[#Namelists|Namelists]] sections.''

==3D Model Run==
[[IDEN]] 
[[ISLIP]], [[KP]] 
[[Z0S,Z0B]] 
[[ALP1,ALP2,ALP3]] 
[[IGC]], [[NFEN]] 
for k=1 to [[NFEN]] (include this loop only if [[IGC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[SIGMA(k)]] 
end k loop 
[[IEVC]], [[EVMIN]], [[EVCON]] 
for k=1 to [[NFEN]] (include this loop only if [[IEVC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[EVTOT(k)]] 
end k loop 
[[THETA1, THETA2]](include this line only if [[IEVC]] = 50 or 51) 
[[I3DSD,TO3DSDS,TO3DSDF,NSPO3DSD]] 
[[NSTA3DD]] 
for k=1 to [[NSTA3DD]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DSV,TO3DSVS,TO3DSVF,NSPO3DSV]] 
[[NSTA3DV]] 
for k=1 to [[NSTA3DV]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DST,TO3DSTS,TO3DSTF,NSPO3DST]] 
[[NSTA3DT]] 
for k=1 to [[NSTA3DT]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DGD]],[[TO3DGDS]],[[TO3DGDF]],[[NSPO3DGD]] 
[[I3DGV]],[[TO3DGVS]],[[TO3DGVF]],[[NSPO3DGV]] 
[[I3DGT]],[[TO3DGTS]],[[TO3DGTF]],[[NSPO3DGT]] 
The following line will be read in if [[IM]] is 21 or 31. 
[[RES_BC_FLAG]], [[BCFLAG_LNM]], [[BCFLAG_TEMP]] 
The following two lines will be read in if [[RES_BC_FLAG]] is negative. 
[[RBCTIMEINC]] 
[[BCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 2. 
[[RBCTIMEINC]], [[SBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3. 
[[RBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 4. 
[[RBCTIMEINC]], [[SBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3 or 4 and [[BCFLAG_TEMP]] is not equal to 0. 
[[TTBCTIMEINC]], [[TTBCSTATIM]] 
[[TTBCTIMEINC]] 
The following two lines will be read in only if [[IM]] is 21 or 31. 
[[SPONGEDIST]] 
[[EQNSTATE]] 
The following lines will be read in only if [[IDEN]] is > 0. 
[[NLSD, NVSD]] 
[[NLTD, NVTD]] 
[[ALP4]] 
The following line will be read in only if [[IDEN]] = 3 or 4. 
[[NTF]]

==NetCDF Controls==
The following lines will be read in only if the NetCDF output or hotstart format is chosen 
NCPROJ 
NCINST 
NCSOUR 
NCHIST 
NCREF 
NCCOM 
NCHOST 
NCCONV 
NCCONT 
NCDATE

==Namelists==
The following Fortran namelist lines are optional, but if they appear, they must appear at the very end of the fort.15 file. 
<code>&metControl WindDragLimit=floatValue, DragLawString='stringValue', rhoAir=floatValue, outputWindDrag=logicalValue /</code> 
<code>&timeBathyControl NDDT=integerValue, BTIMINC=floatValue, BCHGTIMINC=floatValue, invertedBarometerOnElevationBoundary=logicalValue /</code> 
<code>&waveCoupling WindWaveMultiplier=floatValue /</code> 
<code>&SWANOutputControl SWAN_OutputHS=logicalValue, SWAN_OutputDIR=logicalValue, SWAN_OutputTM01=logicalValue, SWAN_OutputTPS=logicalValue, SWAN_OutputWIND=logicalValue, SWAN_OutputTM02=logicalValue, SWAN_OutputTMM10=logicalValue /</code> 
<code>&subdomainModeling subdomainOn=logicalValue/</code> 
<code>&wetDryControl outputNodeCode=logicalValue, outputNOFF=logicalValue, noffActive=logicalValue /</code> 
<code>&inundationOutputControl inundationOutput=logicalValue0, inunThresh =floatValue /</code> 
<code>&TVWControl use_TVW=logicalValue, TVW_file='stringValue', nout_TVW =integerValue, touts_TVW =floatValue, toutf_TVW=floatValue, nspool_TVW =integerValue /</code> 
<code>&WarnElevControl WarnElev=floatValue, ErrorElev=floatValue, WarnElevDump=logicalValue, WarnElevDumpLimit=integerValue /</code> 
<code>[[Dynamic_water_level_correction#Controlling_Water_Level_Correction|&dynamicWaterLevelCorrectionControl]] dynamicWaterLevelCorrectionFileName='stringValue', dynamicWaterLevelCorrectionMultiplier=floatValue, dynamicWaterLevelCorrectionRampStart=floatValue, dynamicWaterLevelCorrectionRampEnd=floatValue, dynamicWaterLevelCorrectionRampReferenceTime='stringValue', dynamicWaterLevelCorrectionSkipSnaps=integerValue /</code> 
<code>&[[AliDispersionControl]] CAliDisp=logicalValue, Cs=floatValue, Ad=floatValue, Bd=floatValue /</code> 
[[category:input files]]

Tips and Tricks

2024-03-04T21:52:52Z

Taylorgasher: /* Method 1 - Very Easy */ added a little info

This page serves as a catch-all covering methods to achieve common goals or overcome common issues.

== Pre-Processing Tips and Tricks ==

== ADCIRC-Only Tips and Tricks ==
* [[fort.15_file#Meteorological-Only Mode|Meteorological-Only Mode]]
* [[fort.15_file#Ramping Meteorological Forcing at Hot-Start|Ramping Meteorological Forcing at Hot-Start]]

== ADCIRC+SWAN Tips and Tricks ==
=== Writing Alternative Station SWAN Output ===
SWAN has expansive outputting capabilities, documented in [https://swanmodel.sourceforge.io/online_doc/swanuse/swanuse.html its manual], but figuring out how can be a bit difficult. Here's a simple summary of how to output various parameters at a user-specified set of locations. Add two lines to your [[fort.26]] (SWAN control) file. I put these lines after the <code>NUM</code> line in the fort.26 file. The first line declares the existence and name of a set of points at which you want outputs: 
<code>POINTS 'aStringIdForPointsFile' FILE 'theFileNameOfYourPointsFile'</code> 
where <code>'aStringIdForPointsFile</code> is the name you're giving the list of locations, and <code>'theFileNameOfYourPointsFile</code> is the actual file name. This file should be placed in your base run directory. The file format is ASCII x-y coordinate pairs, no header line, space-delimited, and one point per line, e.g. 
x1 y1 x2 y2 x3 y3 ...

The second line describes the outputs you want: 
<code>TABLE 'aStringIdForPointsFile' HEADER 'outputFile' HSIGN HSWELL DIR PDIR TDIR TM02 STEEPNESS OUT 20010101.000000 15 MIN</code> 
where <code>HEADER</code> (or <code>NOHEADER</code>) indicates whether you want a header, <code>'outputFile'</code> is the output file name that SWAN writes to, <code>HSIGN HSWELL...STEEPNESS</code> are a list of the parameters to-be-output, <code>OUT</code> denotes the termination of the list of parameters, <code>20010101.000000</code> indicates when outputting should start in YYYYMMDD.hhmmss format, and <code>15 MIN</code> indicates a 15-minute output interval. Some notes:

* The header can be nice but it can also sometimes cause format problems if the numeric values being output are too large to fit in the fixed-width columns. If you do <code>NOHEADER</code>, the file won't have this issue, though it can be harder to inspect visually...it'll be just as easy to read it with a computer program or something like Excel.
* The list of parameters you can output is long, and the definitions are even longer. The list is currently on the SWAN website [https://swanmodel.sourceforge.io/online_doc/swanuse/node32.html here] under the description of the <code>BLOCK</code> output command, and has [https://swanmodel.sourceforge.io/online_doc/swanuse/node35.html#app:defvar a link] to the parameter definitions. If that link doesn't work, maybe go to the SWAN user manual [https://swanmodel.sourceforge.io/online_doc/swanuse/swanuse.html base page], then click on "Write or plot computed quantities".
* In a parallel run, for model versions later than roughly ADCIRC version v52, the output should be a single file in the main run directory. In earlier versions, the output was written individually by each subdomain to its PE* folder.

Note that you can add multiple <code>POINTS</code> and/or <code>TABLE</code> lines for different list of coordinates and/or different outputs.

=== Writing Alternative Global SWAN Output ===
Have you ever wanted to write different SWAN parameters to output in a coupled ADCIRC+SWAN simulation? If so, these tips and tricks are for you! The current implementations of the dynamically coupled version of ADCIRC+SWAN only write a few SWAN parameters to global time-series output files. Those output parameters and files include:
* spectrally significant wave height (filename: swan_HS.63)
* "smoothed" peak wave period (filename: swan_TPS.63)
* mean absolute wave period (filename: swan_TMM10.63)
* mean wave direction (filename: swan_DIR.63)
* and perhaps others like TM01, TM02, and WIND

The SWAN model has many other potentially useful output parameters and, in some cases, they may be more appropriate for your needs than these default outputs. For example, what if you preferred seeing the peak wave direction instead of the mean wave direction? Or maybe you need the swell wave height instead of, or in addition to, the significant wave height? The two methods below will allow you to accomplish just this. Granted, this does require that you modify some files within the SWAN and ADCIRC source codes, and that you recompile the source code into your desired executables. We hope the instructions below make the task of modifying the source code a little less daunting. There is one major caveat to the two methods outlined below: it will not allow you to 'define' your desired SWAN output in either the fort.26 file OR in namelist form at the bottom of fort.15. In other words, you will receive whatever outputs you hardwire into your source code and you cannot easily turn them on or off without again modifying the source code.

==== Method 1 - Very Easy ====
Use the approach described in the [[Tips_and_Tricks#Writing_Alternative_Station_SWAN_Output|last section]] and use the coordinates of all nodes as your list of stations. It's possible this may not exactly match what you'd get with other methods, e.g. if SWAN interpolates the station value even when a point exactly matches a node location then it would be subject to floating point errors and to effects of wetting/drying at the other nodes in the triangle.

==== Method 2 - Easy but Limited ====

This is by far the simplest method for modifying SWAN output in a coupled ADCIRC+SWAN simulation. By following the instructions below, you will be able to write any SWAN output you desire… but only to the existing SWAN output files. Existing SWAN output files include swan_HS.63, swan_TPS.63, swan_TMM10.63, swan_DIR.63, etc. This method will not produce NEW or ADDITIONAL SWAN output files. Rather, it will simply write the user-specified output to these existing filenames.

Go to the swan/ folder in your adcirc source code directory tree and open the file swanout1.f

You are looking for a variable assignment named IVTYPE in the subroutine named SWOEXA. The IVTYPE value is linked to SWAN output variables. For example, this is what the first IVTYPE definition looks like in my version of SWAN…

! 
! significant wave height 
! 
IVTYPE = 10

Keep searching and note the IVTYPE values corresponding to your desired SWAN output variable(s). I have included a few below for reference.

'''IVTYPE value / variable name''' 
10 / significant wave height 
44 / swell wave height 
12 / peak wave period 
14 / peak wave direction 
13 / mean wave direction 
16 / directional spread 
15 / energy transport direction 
17 / average wave length 
18 / steepness 

With the IVTYPE value(s) noted, proceed to the src/ directory and open the file couple2swan.F

Search for the variable IVTYPE. Reassign the IVTYPE values using the values of your desired output. For example, if you want to write the peak wave direction to the “swan_DIR.63” file instead of the mean wave direction, you’d want to change IVTYPE = 13 to IVTYPE = 14. Note that you’ll need to make this change in approximately five places within the couple2swan.F file. The embedded images below show comparisons between the original and modified files for this example (substituting IVTYPE=14 (PDIR) for IVTYPE=13 (DIR)). The change areas appear in the following subroutines of couple2swan.F:
* ComputeWaveFrictionProperties
* SwanOutput

You would of course want to make these IVTYPE reassignments for any and all existing SWAN output that you'd like to modify. Keep in mind that you only have four existing files to work with here, so that is ultimately your limit on output parameters as well. You may want to consider renaming your output files so that you do not misinterpret your results. The output filenames are found in src/write_output.F. Using the example IVTYPE reassignment above, you might consider renaming swan_DIR.63 to swan_PDIR.63. If you need more than four output parameters and also want to change the filenames, see Method 2 below.

<gallery>
method1_1.png|Change area 1 of 5 (click to enlarge)
method1_2.png|Change area 2 of 5 (click to enlarge)
method1_3.png|Change area 3 of 5 (click to enlarge)
method1_4.png|Change area 4 of 5 (click to enlarge)
method1_5.png|Change area 5 of 5 (click to enlarge)
</gallery>

==== Method 3 - Moderately Difficult but Limitless ====

This method is more complex but it will allow you to name and create any number of original SWAN output files. For example, say I wanted to keep the existing default SWAN output files (referenced above in Method 1) but also write the peak wave direction output to a brand new file named swan_PDIR.63. You can do that if you follow the steps below. Note that the example below will also generate a corresponding swan_PDIR_max.63 file in a manner similar to swan_HS_max.63, swan_TPS_max.63, etc.

In this more complicated (really just more work) method you will need to perform four general tasks:
# Increment an output counter in multiple places (in my example, from 7 to 8 because I am only adding the PDIR output)
# Insert new sections of code pertaining to your desired output
# Create and insert new variable names in GLOBAL and OUTPUT blocks
# Add new code to direct your parameters to output files

I honestly did this somewhat blindly the first time and it worked just fine (for me). You do need to be very careful and take your time going through the couple2swan.F file and all internal subroutines to make sure you are making all appropriate additions. Like method 1 above, your only modifications will be in couple2swan.F, but you will need to refer to the IVTYPE values found in swan/swanout1.f as described above.

As was done above, I am providing screenshots of a "diff" comparison between the original and modified couple2swan.F files for this simple example of adding the PDIR output as a new output file. For consistency purposes I do specify PDIR as an output variable in my fort.26 file, but as Casey and others have mentioned in the past I don't think that makes any difference whatsoever. If you follow my example below you would get the PDIR outputs even if you omitted PDIR from the fort.26 file. The change areas appear in the following subroutines of couple2swan.F:
* ComputeWaveFrictionProperties
* SwanOutput

<gallery>
method2_1.png|Change area 1 of 7 (click to enlarge)
method2_2.png|Change area 2 of 7 (click to enlarge)
method2_3.png|Change area 3 of 7 (click to enlarge)
method2_4.png|Change area 4 of 7 (click to enlarge)
method2_5.png|Change area 5 of 7 (click to enlarge)
method2_6.png|Change area 6 of 7 (click to enlarge)
method2_7.png|Change area 7 of 7 (click to enlarge)
</gallery>

== Post-Processing Tips and Tricks ==

Tips and Tricks

2024-03-04T21:49:33Z

Taylorgasher: /* ADCIRC+SWAN Tips and Tricks */ added section on SWAN station output

This page serves as a catch-all covering methods to achieve common goals or overcome common issues.

== Pre-Processing Tips and Tricks ==

== ADCIRC-Only Tips and Tricks ==
* [[fort.15_file#Meteorological-Only Mode|Meteorological-Only Mode]]
* [[fort.15_file#Ramping Meteorological Forcing at Hot-Start|Ramping Meteorological Forcing at Hot-Start]]

== ADCIRC+SWAN Tips and Tricks ==
=== Writing Alternative Station SWAN Output ===
SWAN has expansive outputting capabilities, documented in [https://swanmodel.sourceforge.io/online_doc/swanuse/swanuse.html its manual], but figuring out how can be a bit difficult. Here's a simple summary of how to output various parameters at a user-specified set of locations. Add two lines to your [[fort.26]] (SWAN control) file. I put these lines after the <code>NUM</code> line in the fort.26 file. The first line declares the existence and name of a set of points at which you want outputs: 
<code>POINTS 'aStringIdForPointsFile' FILE 'theFileNameOfYourPointsFile'</code> 
where <code>'aStringIdForPointsFile</code> is the name you're giving the list of locations, and <code>'theFileNameOfYourPointsFile</code> is the actual file name. This file should be placed in your base run directory. The file format is ASCII x-y coordinate pairs, no header line, space-delimited, and one point per line, e.g. 
x1 y1 x2 y2 x3 y3 ...

The second line describes the outputs you want: 
<code>TABLE 'aStringIdForPointsFile' HEADER 'outputFile' HSIGN HSWELL DIR PDIR TDIR TM02 STEEPNESS OUT 20010101.000000 15 MIN</code> 
where <code>HEADER</code> (or <code>NOHEADER</code>) indicates whether you want a header, <code>'outputFile'</code> is the output file name that SWAN writes to, <code>HSIGN HSWELL...STEEPNESS</code> are a list of the parameters to-be-output, <code>OUT</code> denotes the termination of the list of parameters, <code>20010101.000000</code> indicates when outputting should start in YYYYMMDD.hhmmss format, and <code>15 MIN</code> indicates a 15-minute output interval. Some notes:

* The header can be nice but it can also sometimes cause format problems if the numeric values being output are too large to fit in the fixed-width columns. If you do <code>NOHEADER</code>, the file won't have this issue, though it can be harder to inspect visually...it'll be just as easy to read it with a computer program or something like Excel.
* The list of parameters you can output is long, and the definitions are even longer. The list is currently on the SWAN website [https://swanmodel.sourceforge.io/online_doc/swanuse/node32.html here] under the description of the <code>BLOCK</code> output command, and has [https://swanmodel.sourceforge.io/online_doc/swanuse/node35.html#app:defvar a link] to the parameter definitions. If that link doesn't work, maybe go to the SWAN user manual [https://swanmodel.sourceforge.io/online_doc/swanuse/swanuse.html base page], then click on "Write or plot computed quantities".
* In a parallel run, for model versions later than roughly ADCIRC version v52, the output should be a single file in the main run directory. In earlier versions, the output was written individually by each subdomain to its PE* folder.

Note that you can add multiple <code>POINTS</code> and/or <code>TABLE</code> lines for different list of coordinates and/or different outputs.

=== Writing Alternative Global SWAN Output ===
Have you ever wanted to write different SWAN parameters to output in a coupled ADCIRC+SWAN simulation? If so, these tips and tricks are for you! The current implementations of the dynamically coupled version of ADCIRC+SWAN only write a few SWAN parameters to global time-series output files. Those output parameters and files include:
* spectrally significant wave height (filename: swan_HS.63)
* "smoothed" peak wave period (filename: swan_TPS.63)
* mean absolute wave period (filename: swan_TMM10.63)
* mean wave direction (filename: swan_DIR.63)
* and perhaps others like TM01, TM02, and WIND

The SWAN model has many other potentially useful output parameters and, in some cases, they may be more appropriate for your needs than these default outputs. For example, what if you preferred seeing the peak wave direction instead of the mean wave direction? Or maybe you need the swell wave height instead of, or in addition to, the significant wave height? The two methods below will allow you to accomplish just this. Granted, this does require that you modify some files within the SWAN and ADCIRC source codes, and that you recompile the source code into your desired executables. We hope the instructions below make the task of modifying the source code a little less daunting. There is one major caveat to the two methods outlined below: it will not allow you to 'define' your desired SWAN output in either the fort.26 file OR in namelist form at the bottom of fort.15. In other words, you will receive whatever outputs you hardwire into your source code and you cannot easily turn them on or off without again modifying the source code.

==== Method 1 - Very Easy ====
Use the approach described in the [[Tips_and_Tricks#Writing_Alternative_Station_SWAN_Output|last section]].

==== Method 2 - Easy but Limited ====

This is by far the simplest method for modifying SWAN output in a coupled ADCIRC+SWAN simulation. By following the instructions below, you will be able to write any SWAN output you desire… but only to the existing SWAN output files. Existing SWAN output files include swan_HS.63, swan_TPS.63, swan_TMM10.63, swan_DIR.63, etc. This method will not produce NEW or ADDITIONAL SWAN output files. Rather, it will simply write the user-specified output to these existing filenames.

Go to the swan/ folder in your adcirc source code directory tree and open the file swanout1.f

You are looking for a variable assignment named IVTYPE in the subroutine named SWOEXA. The IVTYPE value is linked to SWAN output variables. For example, this is what the first IVTYPE definition looks like in my version of SWAN…

! 
! significant wave height 
! 
IVTYPE = 10

Keep searching and note the IVTYPE values corresponding to your desired SWAN output variable(s). I have included a few below for reference.

'''IVTYPE value / variable name''' 
10 / significant wave height 
44 / swell wave height 
12 / peak wave period 
14 / peak wave direction 
13 / mean wave direction 
16 / directional spread 
15 / energy transport direction 
17 / average wave length 
18 / steepness 

With the IVTYPE value(s) noted, proceed to the src/ directory and open the file couple2swan.F

Search for the variable IVTYPE. Reassign the IVTYPE values using the values of your desired output. For example, if you want to write the peak wave direction to the “swan_DIR.63” file instead of the mean wave direction, you’d want to change IVTYPE = 13 to IVTYPE = 14. Note that you’ll need to make this change in approximately five places within the couple2swan.F file. The embedded images below show comparisons between the original and modified files for this example (substituting IVTYPE=14 (PDIR) for IVTYPE=13 (DIR)). The change areas appear in the following subroutines of couple2swan.F:
* ComputeWaveFrictionProperties
* SwanOutput

You would of course want to make these IVTYPE reassignments for any and all existing SWAN output that you'd like to modify. Keep in mind that you only have four existing files to work with here, so that is ultimately your limit on output parameters as well. You may want to consider renaming your output files so that you do not misinterpret your results. The output filenames are found in src/write_output.F. Using the example IVTYPE reassignment above, you might consider renaming swan_DIR.63 to swan_PDIR.63. If you need more than four output parameters and also want to change the filenames, see Method 2 below.

<gallery>
method1_1.png|Change area 1 of 5 (click to enlarge)
method1_2.png|Change area 2 of 5 (click to enlarge)
method1_3.png|Change area 3 of 5 (click to enlarge)
method1_4.png|Change area 4 of 5 (click to enlarge)
method1_5.png|Change area 5 of 5 (click to enlarge)
</gallery>

==== Method 3 - Moderately Difficult but Limitless ====

This method is more complex but it will allow you to name and create any number of original SWAN output files. For example, say I wanted to keep the existing default SWAN output files (referenced above in Method 1) but also write the peak wave direction output to a brand new file named swan_PDIR.63. You can do that if you follow the steps below. Note that the example below will also generate a corresponding swan_PDIR_max.63 file in a manner similar to swan_HS_max.63, swan_TPS_max.63, etc.

In this more complicated (really just more work) method you will need to perform four general tasks:
# Increment an output counter in multiple places (in my example, from 7 to 8 because I am only adding the PDIR output)
# Insert new sections of code pertaining to your desired output
# Create and insert new variable names in GLOBAL and OUTPUT blocks
# Add new code to direct your parameters to output files

I honestly did this somewhat blindly the first time and it worked just fine (for me). You do need to be very careful and take your time going through the couple2swan.F file and all internal subroutines to make sure you are making all appropriate additions. Like method 1 above, your only modifications will be in couple2swan.F, but you will need to refer to the IVTYPE values found in swan/swanout1.f as described above.

As was done above, I am providing screenshots of a "diff" comparison between the original and modified couple2swan.F files for this simple example of adding the PDIR output as a new output file. For consistency purposes I do specify PDIR as an output variable in my fort.26 file, but as Casey and others have mentioned in the past I don't think that makes any difference whatsoever. If you follow my example below you would get the PDIR outputs even if you omitted PDIR from the fort.26 file. The change areas appear in the following subroutines of couple2swan.F:
* ComputeWaveFrictionProperties
* SwanOutput

<gallery>
method2_1.png|Change area 1 of 7 (click to enlarge)
method2_2.png|Change area 2 of 7 (click to enlarge)
method2_3.png|Change area 3 of 7 (click to enlarge)
method2_4.png|Change area 4 of 7 (click to enlarge)
method2_5.png|Change area 5 of 7 (click to enlarge)
method2_6.png|Change area 6 of 7 (click to enlarge)
method2_7.png|Change area 7 of 7 (click to enlarge)
</gallery>

== Post-Processing Tips and Tricks ==

Tips and Tricks

2024-03-04T21:11:22Z

Taylorgasher: initializing new section on SWAN station output

This page serves as a catch-all covering methods to achieve common goals or overcome common issues.

== Pre-Processing Tips and Tricks ==

== ADCIRC-Only Tips and Tricks ==
* [[fort.15_file#Meteorological-Only Mode|Meteorological-Only Mode]]
* [[fort.15_file#Ramping Meteorological Forcing at Hot-Start|Ramping Meteorological Forcing at Hot-Start]]

== ADCIRC+SWAN Tips and Tricks ==
=== Writing Alternative Station SWAN Output ===
SWAN has expansive outputting capabilities, but navigating the means of doing these can be a bit difficult. Here's a simple summary of how to output one of various parameters at a user-specified set of locations.

=== Writing Alternative Global SWAN Output ===
Have you ever wanted to write different SWAN parameters to output in a coupled ADCIRC+SWAN simulation? If so, these tips and tricks are for you! The current implementations of the dynamically coupled version of ADCIRC+SWAN only write a few SWAN parameters to global time-series output files. Those output parameters and files include:
* spectrally significant wave height (filename: swan_HS.63)
* "smoothed" peak wave period (filename: swan_TPS.63)
* mean absolute wave period (filename: swan_TMM10.63)
* mean wave direction (filename: swan_DIR.63)
* and perhaps others like TM01, TM02, and WIND

The SWAN model has many other potentially useful output parameters and, in some cases, they may be more appropriate for your needs than these default outputs. For example, what if you preferred seeing the peak wave direction instead of the mean wave direction? Or maybe you need the swell wave height instead of, or in addition to, the significant wave height? The two methods below will allow you to accomplish just this. Granted, this does require that you modify some files within the SWAN and ADCIRC source codes, and that you recompile the source code into your desired executables. We hope the instructions below make the task of modifying the source code a little less daunting. There is one major caveat to the two methods outlined below: it will not allow you to 'define' your desired SWAN output in either the fort.26 file OR in namelist form at the bottom of fort.15. In other words, you will receive whatever outputs you hardwire into your source code and you cannot easily turn them on or off without again modifying the source code.

==== Method 1 - Very Easy ====
Use the approach described in the last section, [[Tips_and_Tricks#Writing_Alternative_Station_SWAN_Output|last section]]
==== Method 2 - Easy but Limited ====

This is by far the simplest method for modifying SWAN output in a coupled ADCIRC+SWAN simulation. By following the instructions below, you will be able to write any SWAN output you desire… but only to the existing SWAN output files. Existing SWAN output files include swan_HS.63, swan_TPS.63, swan_TMM10.63, swan_DIR.63, etc. This method will not produce NEW or ADDITIONAL SWAN output files. Rather, it will simply write the user-specified output to these existing filenames.

Go to the swan/ folder in your adcirc source code directory tree and open the file swanout1.f

You are looking for a variable assignment named IVTYPE in the subroutine named SWOEXA. The IVTYPE value is linked to SWAN output variables. For example, this is what the first IVTYPE definition looks like in my version of SWAN…

! 
! significant wave height 
! 
IVTYPE = 10

Keep searching and note the IVTYPE values corresponding to your desired SWAN output variable(s). I have included a few below for reference.

'''IVTYPE value / variable name''' 
10 / significant wave height 
44 / swell wave height 
12 / peak wave period 
14 / peak wave direction 
13 / mean wave direction 
16 / directional spread 
15 / energy transport direction 
17 / average wave length 
18 / steepness 

With the IVTYPE value(s) noted, proceed to the src/ directory and open the file couple2swan.F

Search for the variable IVTYPE. Reassign the IVTYPE values using the values of your desired output. For example, if you want to write the peak wave direction to the “swan_DIR.63” file instead of the mean wave direction, you’d want to change IVTYPE = 13 to IVTYPE = 14. Note that you’ll need to make this change in approximately five places within the couple2swan.F file. The embedded images below show comparisons between the original and modified files for this example (substituting IVTYPE=14 (PDIR) for IVTYPE=13 (DIR)). The change areas appear in the following subroutines of couple2swan.F:
* ComputeWaveFrictionProperties
* SwanOutput

You would of course want to make these IVTYPE reassignments for any and all existing SWAN output that you'd like to modify. Keep in mind that you only have four existing files to work with here, so that is ultimately your limit on output parameters as well. You may want to consider renaming your output files so that you do not misinterpret your results. The output filenames are found in src/write_output.F. Using the example IVTYPE reassignment above, you might consider renaming swan_DIR.63 to swan_PDIR.63. If you need more than four output parameters and also want to change the filenames, see Method 2 below.

<gallery>
method1_1.png|Change area 1 of 5 (click to enlarge)
method1_2.png|Change area 2 of 5 (click to enlarge)
method1_3.png|Change area 3 of 5 (click to enlarge)
method1_4.png|Change area 4 of 5 (click to enlarge)
method1_5.png|Change area 5 of 5 (click to enlarge)
</gallery>

==== Method 3 - Moderately Difficult but Limitless ====

This method is more complex but it will allow you to name and create any number of original SWAN output files. For example, say I wanted to keep the existing default SWAN output files (referenced above in Method 1) but also write the peak wave direction output to a brand new file named swan_PDIR.63. You can do that if you follow the steps below. Note that the example below will also generate a corresponding swan_PDIR_max.63 file in a manner similar to swan_HS_max.63, swan_TPS_max.63, etc.

In this more complicated (really just more work) method you will need to perform four general tasks:
# Increment an output counter in multiple places (in my example, from 7 to 8 because I am only adding the PDIR output)
# Insert new sections of code pertaining to your desired output
# Create and insert new variable names in GLOBAL and OUTPUT blocks
# Add new code to direct your parameters to output files

I honestly did this somewhat blindly the first time and it worked just fine (for me). You do need to be very careful and take your time going through the couple2swan.F file and all internal subroutines to make sure you are making all appropriate additions. Like method 1 above, your only modifications will be in couple2swan.F, but you will need to refer to the IVTYPE values found in swan/swanout1.f as described above.

As was done above, I am providing screenshots of a "diff" comparison between the original and modified couple2swan.F files for this simple example of adding the PDIR output as a new output file. For consistency purposes I do specify PDIR as an output variable in my fort.26 file, but as Casey and others have mentioned in the past I don't think that makes any difference whatsoever. If you follow my example below you would get the PDIR outputs even if you omitted PDIR from the fort.26 file. The change areas appear in the following subroutines of couple2swan.F:
* ComputeWaveFrictionProperties
* SwanOutput

<gallery>
method2_1.png|Change area 1 of 7 (click to enlarge)
method2_2.png|Change area 2 of 7 (click to enlarge)
method2_3.png|Change area 3 of 7 (click to enlarge)
method2_4.png|Change area 4 of 7 (click to enlarge)
method2_5.png|Change area 5 of 7 (click to enlarge)
method2_6.png|Change area 6 of 7 (click to enlarge)
method2_7.png|Change area 7 of 7 (click to enlarge)
</gallery>

== Post-Processing Tips and Tricks ==

Dynamic water level correction

2023-10-29T19:22:46Z

Taylorgasher: Added note about file being read from the start of the run

'''Dynamic Water Level Correction''' is a process by which modeled water levels are dynamically adjusted by use of a forcing term. The correction can be applied as constant or varying in space and/or time. The correction is applied as a forcing term in the momentum equations whose mathematical form is equivalent to that of an atmospheric pressure term. This means that, for gradually-varying corrections, corrected water levels should closely follow the input correction, though these may deviate if a correction is applied very quickly or to an area that has a very weak connection to an open boundary through which water can flow. Further discussion is below in the [[#FAQ|FAQ]].

Overviews and examples of this capability have been provided in multiple presentations (Luettich et al. 2017<ref name="luettichPres2017">Luettich, R.L., T.G. Asher, B.O. Blanton, J.G. Fleming. Representing Low Frequency, Spatially Varying Water Level Anomalies in Storm Surge Computations. 2017 American Meteorological Society Annual Meeting. [https://ams.confex.com/ams/97Annual/webprogram/Paper316033.html Link to talk]</ref>, Asher et al. 2018<ref name="asherPres2018">Asher, T.G., R.L. Luettich, J.G. Fleming, B.O.Blanton. Assimilation of Observed Water Levels into Storm Surge Model Predictions. 2018 American Meteorological Society Annual Meeting. [https://ams.confex.com/ams/98Annual/webprogram/Paper334044.html Link to talk]</ref>) and a journal article (Asher et al. 2019<ref name="asher2019">Asher, T.G., Luettich Jr., R.A., Fleming, J.G., Blanton, B.O., 2019. Low frequency water level correction in storm surge models using data assimilation. Ocean Modelling 144, 101483. https://doi.org/10.1016/j.ocemod.2019.101483</ref>) with details and an application to Hurricane Matthew. Users looking for ways to generate water level correction surfaces can look to that same article and this digital publication/data repository<ref>Asher, T., 2019. Hurricane Matthew (2016) Storm Surge and Wave Simulations with Data Assimilation. https://doi.org/10.17603/2Z8H-7K90</ref>, which holds the code base used in the aforementioned paper.

== Version ==
{{ADC version|version=54|relation=ge}}
Early versions of this feature were implemented in v53, however important bug fixes and a renaming of related variables<ref group="note">If using an older version, note that in the fort.15 file, instances of "dynamicWaterLevelCorrection" should be changed to "offset" in the namelist parameter names, e.g. "offsetControl". </ref> were done later, so users are strongly encouraged to not use these earlier versions.

==Controlling Water Level Correction==
The water level correction feature is triggered by the presence of the &dynamicWaterLevelCorrectionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used: 
<code>&dynamicWaterLevelCorrectionControl dynamicWaterLevelCorrectionFileName="hsofs_offset_test_ft.dat" dynamicWaterLevelCorrectionMultiplier=0.3048, dynamicWaterLevelCorrectionRampStart=0.0, dynamicWaterLevelCorrectionRampEnd=259200.0 dynamicWaterLevelCorrectionRampReferenceTime="hotstart", dynamicWaterLevelCorrectionSkipSnaps=0 /</code>

* <code>dynamicWaterLevelCorrectionMultiplier</code> allows one to easily change the entire dataset by a single factor, e.g. if the data were provided in feet; ADCIRC requires meters.
* <code>dynamicWaterLevelCorrectionRampStart</code> and <code>dynamicWaterLevelCorrectionRampEnd</code> are the time in seconds for a linear ramp up period.
* <code>dynamicWaterLevelCorrectionRampReferenceTime</code> controls whether the ramp times are relative to the hotstart time or the coldstart time. Prior to the start of the ramp, the correction values are multiplied by 0.0, eliminating the correction until the ramp period starts.
* <code>dynamicWaterLevelCorrectionSkipSnaps</code> is used to skip the specified number of initial data sets in the corrections data file. It can also be used to insert blank snaps at the beginning of the run if it is negative.

===Water Level Correction Input File===
ADCIRC will begin reading this input file when the run starts, so time snaps are needed from the start of the run. ADCIRC looks for the water level correction input file in the same directory as the other full-domain files, both in serial and in parallel. In parallel, each subdomain does domain decomposition of the correction data on the fly, so the only change to adcprep is the read/write of the new namelist to the subdomain fort.15 files. The water level correction input file starts with the following three header lines:

<nowiki>#</nowiki> test file for 1ft correction on hsofs mesh during matthew
14400.0 # time increment between datasets, must be positive -- read but ignored if constant correction
0.0 # default correction value

The first line is a comment line. The second line is the time interval in seconds between successive datasets. The third line is the default correction value; this allows us to create correction input files in a "sparse" format where only the non-default values are provided.If there is only one dataset in the correction file, then the values are treated as temporally constant. If there is more than one dataset, ADCIRC linearly interpolates between them in time. If ADCIRC runs out of correction data, it continues with the last dataset as a set of constant values for the remainder of the run.

Because each correction dataset may have a different number of values, the # (hash, pound, or number) symbol is used as a separator. Specifically, users should place a line containing # in the first and second columns, i.e. <code>##</code>, of the file after the end of the current time snap of data. When ADCIRC sees this, it understands the next line is the start of the next time snap of data.

===Output===
If a water level correction input file is specified, then the time interpolated water level correction values will be written to a file called [[offset.63]] on the same schedule as output to the [[fort.63]]. This file can then be used as a diagnostic to check that the correction values have been applied as expected.

==Compatibility==
Although the correction is implemented as a pseudo barometric pressure, it is entirely independent of any/all meteorological forcing and meteorological data. The values do not show up in the fort.71 (barometric pressure stations) or fort.73 (fulldomain barometric pressure field) output files. The correction can be used with any meteorological forcing data, or with no meteorological forcing data at all.

==Example==
An ADCIRC model is coldstarted with a tide only run that uses a 10 day ramp, and runs for 15 days. How should the water level correction be configured?

In this case, I suggest that you apply your bias correction after reaching full strength tidal forcing (i.e., after the 10 day tidal ramp). So to have your bias correction ramp completed at the end of the 15 day tidal spinup, start the ramp period at 10.0 days and end it at 13.0 days. This should ensure you clearly see the correction occurring when you look at the output data, while avoiding applying the correction too rapidly. In summary, set your ramp period in the fort.15 file to <code>dynamicWaterLevelCorrectionRampStart =864000.0, dynamicWaterLevelCorrectionRampEnd = 1036800.0</code>

Since this is the model spin-up period, using a time-constant correction is likely sufficient. That means a single time snap of correction data can be supplied, for example:
<nowiki>#</nowiki> bias correction values test for GFS 20161002 cycle 00Z
99999.9 # time increment in seconds; not used in this case
0.0 # default nodal value applied to any node not specified below
234 0.5
1223 0.6
1789 -0.2
4000 0.1
##

After the spinup, in preparation for a forecast run, when you want to migrate from one set of bias correction values to another over a 6 hour time period, the fort.15 file's <code>dynamicWaterLevelCorrectionControl</code> line would be something like this: 
<code>&dynamicWaterLevelCorrectionControl dynamicWaterLevelCorrectionFileName= "offset_migration_from_00Z_to_06Z.dat", dynamicWaterLevelCorrectionMultiplier = 1.0, dynamicWaterLevelCorrectionRampStart = 1252800.0, dynamicWaterLevelCorrectionRampEnd = 1296000.0, dynamicWaterLevelCorrectionRampReferenceTime = "coldstart", dynamicWaterLevelCorrectionSkipSnaps = 0 /</code>

and the corresponding file would look like something like the following:
# bias correction values for GFS 20161002 from cycle 00Z to cycle 06Z
21600.0 # 6 hour time increment in seconds
0.0 # default nodal value applied to any node not specified below
234 0.5
1223 0.6
1789 -0.2
4000 0.1
##
512 0.3
1001 -0.5
2346 0.74
4000 -0.1
##

At the end of the 15.0 day tidal spinup in this example the bias correction at node 234 would be 0.5. Three hours later (after the hotstart) it would be 0.25. Six hours after the hotstart it would be zero.

At the end of the 15.0 day tidal spinup in this example the bias correction at node 1001 would be 0.0. Three hours later (after the hotstart) it would be -0.25. Six hours after the hotstart it would be -0.5.

At the end of the 15.0 day tidal spinup in this example the bias correction at node 4000 would be 0.1. Three hours later (after the hotstart) it would be 0.0. Six hours after the hotstart it would be -0.1.

==Frequently Asked Questions==
'''Question: '''When writing the &dynamicWaterLevelCorrectionControl namelist, should I write the parameters on a single line, comma separated? 
'''Answer: '''I always put fortran namelist parameters on a single line and separate the assignments with commas, but other formatting may be possible depending on the compiler you are using. Commas has always worked for me, but I've not tried any other way.

'''Question: '''Do I need to ramp the correction, i.e., is it wise to do so for some reason? 
'''Answer: '''It should behave the same as a sudden application of atmospheric pressure forcing, which could lead to (presumably spurious) waves. Our shortest ramp up period is 12 hours but you might get away with 6 hours or even less. We have seen that rapidly ramping in the correction can lead to two outcomes that may be undesirable. One is a strong geostrophic current response. The other is that the water level response can lag behind the correction. This is most common for large water bodies with narrow connections to the open ocean, such as Pamlico Sound in North Carolina. Further details are in Asher et al. 2019<ref name="asher2019"></ref>.

'''Question: '''Does the application of a dynamic water level correction surface affect the velocity solution (not just the elevation solution as it is primarily intended)? 
'''Answer: '''Yes, hopefully in a physically realistic manner. As an example, when applying a water level correction to a back bay area with a nearby tidal inlet, the water level change in the back bay must be reflected in the velocity in the inlet in order to maintain continuity (conservation of mass). In the case of an initial application of a temporally steady water level correction, this velocity effect should be a one-time occurrence. On the other hand, for a time varying water level correction surface, the continuous adjustments to the water level will be continuously reflected in the velocity solution. This should be physically realistic when the water ''should have'' come from offshore, but if the elevated water level is due to rainfall, then the model is directing flow in the wrong direction. Further details are in Asher et al. 2019<ref name="asher2019"></ref>.

==Notes==
<references group="note"/>

==References==
<references />

Supplemental meteorological/wave/ice parameters

2023-06-01T16:42:14Z

Taylorgasher: updated wiki formatting in NWS = 6

This table is helpful for understanding file requirements and how the [[Fort.15_file_format#WTIMINC|meteorological parameter line]] (informally, the <code>[[WTIMINC]]</code> line) should look in the [[fort.15 file]]. These are principally determined by the value of the <code>[[NWS]]</code> line (also in the fort.15 file), though note that the "NWS" values below are for the [[NWS#Value_Seen_in_fort.15_File|full-length value]] in the fort.15 file. Useful information is also contained in the [[fort.22 file format]] and [[wind stress]] pages.

{| class="wikitable" border="1" style="text-align: center"
|-
! Meteorological Data Format
! [[#Forcing Abbreviations|Forcing]]
! <code>[[NWS]]</code> Value
! <code>[[WTIMINC]]</code> Line
! [[#Requirements|Requirements]]
! [[#Notes|Notes]]
|-
| '''none'''
| nonexistent
| 0
| nonexistent
| none
| none
|- style="background:#efefef;"
| '''wind stress, every node, every timestep'''
| m
| 1
| nonexistent
| f22
| <ref group="note" name="c"><code>NWS</code> formats 1, 2, and 7 do not support the use of ice coverage (fort.25) files.</ref>
|- style="background:#efefef;"
|
| m, rs
| 101
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a">Radiation stress time increment (<code>RSTIMINC</code>) represents the time increment between the datasets in the fort.23 file (in seconds).</ref>
|- style="background:#efefef;"
|
| m, sw
| 301
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"><code>RSTIMINC</code> represents the span of ADCIRC simulation time that passes between calls to the coupled wave model.</ref>
|- style="background:#efefef;"
|
| m, st
| 401
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''wind stress, every node, every <code>WTIMINC</code>'''
| m
| 2
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|-
|
| m, rs
| 102
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 302
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 402
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''US Navy Fleet Numeric'''
| m
| 3
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12003
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''PBL/JAG'''
| m
| 4
| <code>WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 104
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 304
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 404
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12004
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12104
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12304
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12404
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''wind velocity, every node, every <code>WTIMINC</code>'''
| m
| 5
| <code>WTIMINC</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 105
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 305
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 405
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12005
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12105
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12305
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12405
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''wind velocity, rectangular grid, every <code>WTIMINC</code>'''
| m
| 6
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 106
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 306
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 406
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12006
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12106
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC RSTIMINC cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12306
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC RSTIMINC cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st ,ic
| 12406
| <code>NWLAT NWLON WLATMAX WLONMIN WLATINC WLONINC WTIMINC RSTIMINC cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''wind stress, regular grid, every <code>WTIMINC</code>'''
| m
| 7
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|- style="background:#efefef;"
|
| m, rs
| 107
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 307
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 407
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''symmetric vortex model'''
| m
| 8
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| f22
| none
|-
|
| m, rs
| 108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12008
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''asymmetric vortex model (no longer available)'''
| n/a
| 9
| n/a
| n/a
| none
|-
| '''National Climatic Data Center GFS'''
| m
| 10
| <code>WTIMINC</code>
| f2xx+
| none
|-
|
| m, rs
| 110
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 310
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 410
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12010
| <code>WTIMINC</code> <code>cice_timinc</code>
| f2xx+, f25
| none
|-
|
| m, rs, ic
| 12110
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12310
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12410
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''National Weather Service ETA 29km'''
| m
| 11
| nonexistent
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 111
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 311
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 411
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m,ic
| 12011
| <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12111
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12311
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12411
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Oceanweather Inc (OWI)'''
| m
| 12
| <code>WTIMINC</code>
| f22x
| none
|-
|
| m, rs
| 112
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 312
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 412
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12012
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22x, f25
| none
|-
|
| m, rs, ic
| 12112
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12312
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12412
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Oceanweather Inc (OWI) NetCDF'''
| m
| 13
| <code>WTIMINC</code>
| f22nc
| [[NWS13]]
|- style="background:#efefef;"
|
| m, rs
| 113
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 313
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 413
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12013
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22nc, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12113
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12313
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12413
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''H*Wind'''
| m
| 15
| <code>WTIMINC</code>
| hwind+,f22
| none
|-
|
| m, rs
| 115
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 315
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 415
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12015
| <code>WTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f25
| none
|-
|
| m, rs, ic
| 12115
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12315
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12415
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Geophysical Fluid Dynamics Laboratory (GFDL) Model'''
| m
| 16
| <code>WTIMINC</code>
| gfdl+,f22
| none
|- style="background:#efefef;"
|
| m, rs
| 116
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 316
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 416
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12016
| <code>WTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12116
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12316
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12416
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Dynamic Asymmetric Model'''
| m
| 19
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| pp,f22
| none
|-
|
| m, rs
| 119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12019
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|-
|
| m, rs, ic
| 12119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Generalized Asymmetric Holland Model (GAHM)'''
| m
| 20
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code>
| pp, f22
| none
|- style="background:#efefef;"
|
| m, rs
| 120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12020
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Blended GAHM and OWI'''
| m
| 30
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22
| none
|-
|
| m, rs
| 130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12030
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f25
| none
|-
|
| m, rs, ic
| 12130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW, f25
| <ref group="note" name="b"></ref>
|-
|}

===Forcing Abbreviations===
: '''m''' - meteorology
: '''rs''' - Wave radiation stress in an analyst-supplied [[fort.23]] input file
: '''sw''' - Wave coupling using a simultaneously executing coupled SWAN model
: '''st''' - Wave coupling using a simultaneously executing ESMF coupled STWAVE model
: '''ic''' - Ice coverage using an analyst-supplied ice coverage data files

===Requirements===
: '''f22''' - Requires analyst-supplied [[fort.22]] meteorological forcing file.
: '''f2xx+''' - Requires at least two fort.2xx meteorological forcing files from the GFS model. See fort.22 documentation for file naming and formatting details.
: '''f22x''' - Requires datasets of pressure and wind data in OWI formatted [[fort.221]] and [[fort.222]] files respectively, optionally including nested wind and pressure in [[fort.223]] and [[fort.224]] files. See fort.22 documentation for details.
: '''hwind+''' - Requires two or more meteorological forcing files from the H*Wind model. See fort.22 documentation for details.
: '''gfdl+''' - Requires two or more meteorological forcing files from the GFDL model. See fort.22 documentation for details.
: '''nwsf22''' - Requires analyst-supplied [[NWS_20_fort.22]] meteorological forcing file.
: '''pp''' - Requires preprocessing of the ATCF formatted track file using the ASymmetric Wind Input Preprocessor (aswip) program (distributed with ADCIRC) prior to use as input for this parametric vortex model.
: '''f23''' - Requires analyst-supplied fort.23 wave radiation stress input file.
: '''A+S''' - Requires ADCIRC+SWAN executable and input files for the coupled version of SWAN.
: '''STW''' - Requires ESMF-coupled ADCIRC and STWAVE and input files for STWAVE.
: '''f25''' - Requires analyst-supplied [[fort.25]] ice coverage input file as well as a [[fort.225]] basin scale ice coverage file and possibly an optional [[fort.227]] region scale ice coverage file.

===Notes===
<references group="note" />

Supplemental meteorological/wave/ice parameters

2023-06-01T16:34:22Z

Taylorgasher: fixing typos in NWS = 6

This table is helpful for understanding file requirements and how the [[Fort.15_file_format#WTIMINC|meteorological parameter line]] (informally, the <code>[[WTIMINC]]</code> line) should look in the [[fort.15 file]]. These are principally determined by the value of the <code>[[NWS]]</code> line (also in the fort.15 file), though note that the "NWS" values below are for the [[NWS#Value_Seen_in_fort.15_File|full-length value]] in the fort.15 file. Useful information is also contained in the [[fort.22 file format]] and [[wind stress]] pages.

{| class="wikitable" border="1" style="text-align: center"
|-
! Meteorological Data Format
! [[#Forcing Abbreviations|Forcing]]
! <code>[[NWS]]</code> Value
! <code>[[WTIMINC]]</code> Line
! [[#Requirements|Requirements]]
! [[#Notes|Notes]]
|-
| '''none'''
| nonexistent
| 0
| nonexistent
| none
| none
|- style="background:#efefef;"
| '''wind stress, every node, every timestep'''
| m
| 1
| nonexistent
| f22
| <ref group="note" name="c"><code>NWS</code> formats 1, 2, and 7 do not support the use of ice coverage (fort.25) files.</ref>
|- style="background:#efefef;"
|
| m, rs
| 101
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a">Radiation stress time increment (<code>RSTIMINC</code>) represents the time increment between the datasets in the fort.23 file (in seconds).</ref>
|- style="background:#efefef;"
|
| m, sw
| 301
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"><code>RSTIMINC</code> represents the span of ADCIRC simulation time that passes between calls to the coupled wave model.</ref>
|- style="background:#efefef;"
|
| m, st
| 401
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''wind stress, every node, every <code>WTIMINC</code>'''
| m
| 2
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|-
|
| m, rs
| 102
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 302
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 402
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''US Navy Fleet Numeric'''
| m
| 3
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12003
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''PBL/JAG'''
| m
| 4
| <code>WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 104
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 304
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 404
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12004
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12104
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12304
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12404
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''wind velocity, every node, every <code>WTIMINC</code>'''
| m
| 5
| <code>WTIMINC</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 105
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 305
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 405
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12005
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12105
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12305
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12405
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''wind velocity, rectangular grid, every <code>WTIMINC</code>'''
| m
| 6
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 106
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 306
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 406
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12006
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12106
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12306
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st ,ic
| 12406
| <code>NWLAT</code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''wind stress, regular grid, every <code>WTIMINC</code>'''
| m
| 7
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|- style="background:#efefef;"
|
| m, rs
| 107
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 307
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 407
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''symmetric vortex model'''
| m
| 8
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| f22
| none
|-
|
| m, rs
| 108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12008
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''asymmetric vortex model (no longer available)'''
| n/a
| 9
| n/a
| n/a
| none
|-
| '''National Climatic Data Center GFS'''
| m
| 10
| <code>WTIMINC</code>
| f2xx+
| none
|-
|
| m, rs
| 110
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 310
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 410
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12010
| <code>WTIMINC</code> <code>cice_timinc</code>
| f2xx+, f25
| none
|-
|
| m, rs, ic
| 12110
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12310
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12410
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''National Weather Service ETA 29km'''
| m
| 11
| nonexistent
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 111
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 311
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 411
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m,ic
| 12011
| <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12111
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12311
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12411
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Oceanweather Inc (OWI)'''
| m
| 12
| <code>WTIMINC</code>
| f22x
| none
|-
|
| m, rs
| 112
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 312
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 412
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12012
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22x, f25
| none
|-
|
| m, rs, ic
| 12112
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12312
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12412
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Oceanweather Inc (OWI) NetCDF'''
| m
| 13
| <code>WTIMINC</code>
| f22nc
| [[NWS13]]
|- style="background:#efefef;"
|
| m, rs
| 113
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 313
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 413
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12013
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22nc, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12113
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12313
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12413
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''H*Wind'''
| m
| 15
| <code>WTIMINC</code>
| hwind+,f22
| none
|-
|
| m, rs
| 115
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 315
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 415
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12015
| <code>WTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f25
| none
|-
|
| m, rs, ic
| 12115
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12315
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12415
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Geophysical Fluid Dynamics Laboratory (GFDL) Model'''
| m
| 16
| <code>WTIMINC</code>
| gfdl+,f22
| none
|- style="background:#efefef;"
|
| m, rs
| 116
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 316
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 416
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12016
| <code>WTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12116
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12316
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12416
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Dynamic Asymmetric Model'''
| m
| 19
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| pp,f22
| none
|-
|
| m, rs
| 119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12019
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|-
|
| m, rs, ic
| 12119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Generalized Asymmetric Holland Model (GAHM)'''
| m
| 20
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code>
| pp, f22
| none
|- style="background:#efefef;"
|
| m, rs
| 120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12020
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Blended GAHM and OWI'''
| m
| 30
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22
| none
|-
|
| m, rs
| 130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12030
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f25
| none
|-
|
| m, rs, ic
| 12130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW, f25
| <ref group="note" name="b"></ref>
|-
|}

===Forcing Abbreviations===
: '''m''' - meteorology
: '''rs''' - Wave radiation stress in an analyst-supplied [[fort.23]] input file
: '''sw''' - Wave coupling using a simultaneously executing coupled SWAN model
: '''st''' - Wave coupling using a simultaneously executing ESMF coupled STWAVE model
: '''ic''' - Ice coverage using an analyst-supplied ice coverage data files

===Requirements===
: '''f22''' - Requires analyst-supplied [[fort.22]] meteorological forcing file.
: '''f2xx+''' - Requires at least two fort.2xx meteorological forcing files from the GFS model. See fort.22 documentation for file naming and formatting details.
: '''f22x''' - Requires datasets of pressure and wind data in OWI formatted [[fort.221]] and [[fort.222]] files respectively, optionally including nested wind and pressure in [[fort.223]] and [[fort.224]] files. See fort.22 documentation for details.
: '''hwind+''' - Requires two or more meteorological forcing files from the H*Wind model. See fort.22 documentation for details.
: '''gfdl+''' - Requires two or more meteorological forcing files from the GFDL model. See fort.22 documentation for details.
: '''nwsf22''' - Requires analyst-supplied [[NWS_20_fort.22]] meteorological forcing file.
: '''pp''' - Requires preprocessing of the ATCF formatted track file using the ASymmetric Wind Input Preprocessor (aswip) program (distributed with ADCIRC) prior to use as input for this parametric vortex model.
: '''f23''' - Requires analyst-supplied fort.23 wave radiation stress input file.
: '''A+S''' - Requires ADCIRC+SWAN executable and input files for the coupled version of SWAN.
: '''STW''' - Requires ESMF-coupled ADCIRC and STWAVE and input files for STWAVE.
: '''f25''' - Requires analyst-supplied [[fort.25]] ice coverage input file as well as a [[fort.225]] basin scale ice coverage file and possibly an optional [[fort.227]] region scale ice coverage file.

===Notes===
<references group="note" />

Fort.15 file format

2023-05-18T14:23:35Z

Taylorgasher: /* Namelists */ added invertedBarometerOnElevationBoundary

The basic file structure of the [[fort.15 file]] is shown below. Each line of input data is represented by a line containing the input variable name(s). Inputs in the [[fort.15 file]] must be entered in the exact order shown on this page. '''Blank lines and headings are only to enhance readability.''' Loops indicate multiple lines of input. 
==Main Controls==
===Metadata and Logging===
'''<code>[[RUNDES]]'''</code> - alphanumeric run description 1, 32 characters or less 
'''<code>[[RUNID]]'''</code> - alphanumeric run description 2, 24 characters or less 
'''<code>[[NFOVER]]'''</code> - non-fatal error override option 
'''<code>[[NABOUT]]'''</code> - verbosity of run log output, <code>= -1</code> is debug mode, higher is less output, up to <code>3</code> for errors only 
'''<code>[[NSCREEN]]'''</code> - directs log messages to the screen (<code>> 0</code>), the adcirc.log file (<code>< 0</code>), or disables them (<code>= 0</code>) 


===Numerics & Physics===
'''<code>[[IHOT]]'''</code> - whether to read a hotstart file 
'''<code>[[ICS]]</code>''' - coordinate projection to run in 
'''<code>[[IM]]</code>''' - model run mode 
'''<code>[[IDEN]]</code>''' - density forcing mode, ''include this line only if:'' <code>[[IM]] = 20, 21, 30, 31</code>, or if <code>IM</code>'s last 6-digit entry is > 4 (e.g., <code>513115</code>). 
'''<code>[[NOLIBF]]</code>''' - bottom stress parameterization mode 
'''<code>[[NOLIFA]]</code>''' - finite amplitude term and wetting/drying mode, off if <code>= 0</code> 
'''<code>[[NOLICA]]</code>''' - advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NOLICAT]]</code>''' - time-derivative advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NWP]]</code>''' - number of [[nodal attribute]]s 
''for j=1 to <code>[[NWP]]</code>'' 
: '''<code>[[AttrName(j)]]</code>''' - nodal attributes to use, ''include this line only if:'' <code>[[NWP]] > 0</code> 
''end j loop'' 
'''<code>[[NCOR]]</code>''' - Coriolis control, spatially constant if <code>= 0</code>, varies with latitude if <code>= 1</code> 
'''<code>[[NTIP]]</code>''' - tidal potential forcing control, off if <code>= 0</code> 
'''<code>[[NWS#Value_Seen_in_fort.15_File|NWS]]</code>''' - meteorological, wave, and ice forcing control 
'''<code>[[NRAMP]]</code>''' - forcing ramping control 
'''<code>[[G]]</code>''' - acceleration due to gravity 
'''<code>[[TAU0]]</code>''' - affects numerical diffusion/stability of governing equations 
'''<code>[[Tau0FullDomainMin]] [[Tau0FullDomainMax]]</code>''' - limits on <code>[[TAU0]]</code>, ''include this line only if:''<code>TAU0 = -5.0</code>. 
'''<code>[[DTDP]]</code>''' - model time step (seconds) and predictor-corrector control 
'''<code>[[STATIM]]</code>''' - shifts numeric value of starting simulation time (days) 
'''<code>[[REFTIM]]</code>''' - shifts reference time (days) for tidal harmonic analysis 
'''[[Supplemental_Meteorological/Wave/Ice_Parameters|Meteorological controls including <code>WTIMINC, RSTIMINC</code>]]''' - ''include this line:'' for most cases of <code>NWS ≠ 0</code>, see linked page for details. 
'''<code>[[RNDAY]]</code>''' - end time of simulation (days) 
'''[[Ramping|Ramping controls including <code>DRAMP, FluxSettlingTime</code>]]''' - ''include this line only if:'' <code>NRAMP > 0</code>, see linked page for details 
'''<code>[[A00 B00 C00]]</code>''' - time weighting factors in GWCE 
'''<code>[[H0]]</code>''' - minimum depth, ''include this line only if:'' <code>[[NOLIFA]] = 0</code> or <code>1</code>'' 
'''<code>[[H0]]</code> <code>INTEGER</code> <code>INTEGER</code> <code>[[VELMIN]]</code>''' - alternate minimum depth controls, ''include this line only if:'' <code>[[NOLIFA]] = 2</code> or <code>3</code>'' 
'''<code>[[SLAM0]] [[SFEA0]]</code>''' - longitude and latitude for center of CPP coordinate projection 
'''<code>[[TAU]]</code>''' - linear bottom friction coefficient, ''include this line only if:'' <code>[[NOLIBF]] = 0</code>'' 
'''<code>[[CF]]</code>''' - quadratic bottom friction coefficient or limit, ''include this line only if:'' <code>[[NOLIBF]] = 1</code>'' 
'''<code>[[CF]]</code> <code>[[HBREAK]]</code> <code>[[FTHETA]]</code> <code>[[FGAMMA]]</code>''' - alternate quadratic bottom friction controls, ''include this line only if:'' <code>[[NOLIBF]] = 2</code>'' 
'''<code>[[ESLM]]</code>''' - horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 0</code>, <code>1</code>, or <code>2</code>'' 
'''<code>[[ESLM]]</code> <code>[[ESLC]]</code>''' - alternate horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 10</code>'' 
'''<code>[[CORI]]</code>''' - constant Coriolis coefficient, ''only used if'' <code>NCOR=0</code>

===Periodic (Tidal) Body Forcing===
[[NTIF]] 
for k=1 to [[NTIF]]
: [[TIPOTAG(k)]]
: [[TPK(k)]], [[AMIGT(k)]], [[ETRF(k)]], [[FFT(k)]], [[FACET(k)]]
end k loop

===Periodic (Tidal) Boundary Elevations===
[[NBFR]] 
for k=1 to [[NBFR]] 
: [[BOUNTAG(k)]] 
: [[AMIG(k)]], [[FF(k)]], [[FACE(k)]] 
end k loop 
for k=1 to [[NBFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NETA]] 
:: [[EMO(k,j), EFA(k,j)]] 
: end j loop 
end k loop

===Periodic (Tidal) Boundary Velocities===
[[ANGINN]] 
[[NFFR]] - include this line only if [[IBTYPE]] = 2, 12, 22, 32 or 52 in the Grid and Boundary Information File 
for k=1 to [[NFFR]] 
: [[FBOUNTAG(k)]] 
: [[FAMIGT(k),FFF(k),FFACE(k)]] 
end k loop 
for k=1 to [[NFFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NVEL]] 
:: [[QNAM(k,j), QNPH(k,j)]] - use this line if [[IBTYPE]] = 2, 12, 22 in the Grid and Boundary Information File 
:: [[QNAM(k,j), QNPH(k,j)]], [[ENAM(k,j), ENPH(k,j)]] - use this line if [[IBTYPE]] = 32 in the Grid and Boundary Information File 
:end j loop 
end k loop

===Model Output===
[[NOUTE]], [[TOUTSE]], [[TOUTFE]], [[NSPOOLE]] 
[[NSTAE]] 
for k=1 to [[NSTAE]] 
: [[XEL(k), YEL(k)]] - use these lines if [[NSTAE]] is positive. If negative, stations are listed in the [[elev_stat.151]] file 
end k loop 
[[NOUTV]], [[TOUTSV]], [[TOUTFV]], [[NSPOOLV]] 
[[NSTAV]] 
for k=1 to [[NSTAV]] 
: [[XEV(k), YEV(k)]] - use these lines if [[NSTAV]] is positive. If negative, stations are listed in the [[vel_stat.151]] file 
end k loop 
[[NOUTC]], [[TOUTSC]], [[TOUTFC]], [[NSPOOLC]] - include this line only if IM =10 
[[NSTAC]] - include this line only if IM =10 
for k=1 to [[NSTAC]] 
: [[XEC(k), YEC(k)]] 
end k loop 
[[NOUTM]], [[TOUTSM]], [[TOUTFM]], [[NSPOOLM]] - include this line only if NWS is not equal to zero. 
[[NSTAM]] - include this line only if NWS is not equal to zero. 
for k=1 to [[NSTAM]] 
: [[XEM(k), YEM(k)]] - use these lines if [[NSTAM]] is positive. If negative, stations are listed in the [[met_stat.151]] file 
end k loop 
[[NOUTGE]], [[TOUTSGE]], [[TOUTFGE]], [[NSPOOLGE]] 
[[NOUTGV]], [[TOUTSGV]], [[TOUTFGV]], [[NSPOOLGV]] 
[[NOUTGC]], [[TOUTSGC]], [[TOUTFGC]], [[NSPOOLGC]] - include this line only if IM =10 
[[NOUTGW]], [[TOUTSGW]], [[TOUTFGW]], [[NSPOOLGW]] - include this line only if NWS is not equal to zero.

====Harmonic Analysis====
[[NFREQ]] 
for k=1 to [[NFREQ]] 
: [[NAMEFR(k)]] 
: [[HAFREQ(k), HAFF(k), HAFACE(k)]] 
end k loop 
[[THAS]], [[THAF]], [[NHAINC]], [[FMV]] 
[[NHASE]], [[NHASV]], [[NHAGE]], [[NHAGV]]

====Hotstart Output and Numeric Controls====
[[NHSTAR]], [[NHSINC]] 
[[ITITER]], [[ISLDIA]], [[CONVCR]], [[ITMAX]] 

''For a 2DDI ADCIRC run that does not use netCDF nor namelists, the file ends here. For those controls, see further below in the [[#NetCDF Controls|NetCDF Controls]] and [[#Namelists|Namelists]] sections.''

==3D Model Run==
[[IDEN]] 
[[ISLIP]], [[KP]] 
[[Z0S,Z0B]] 
[[ALP1,ALP2,ALP3]] 
[[IGC]], [[NFEN]] 
for k=1 to [[NFEN]] (include this loop only if [[IGC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[SIGMA(k)]] 
end k loop 
[[IEVC]], [[EVMIN]], [[EVCON]] 
for k=1 to [[NFEN]] (include this loop only if [[IEVC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[EVTOT(k)]] 
end k loop 
[[THETA1, THETA2]](include this line only if [[IEVC]] = 50 or 51) 
[[I3DSD,TO3DSDS,TO3DSDF,NSPO3DSD]] 
[[NSTA3DD]] 
for k=1 to [[NSTA3DD]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DSV,TO3DSVS,TO3DSVF,NSPO3DSV]] 
[[NSTA3DV]] 
for k=1 to [[NSTA3DV]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DST,TO3DSTS,TO3DSTF,NSPO3DST]] 
[[NSTA3DT]] 
for k=1 to [[NSTA3DT]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DGD]],[[TO3DGDS]],[[TO3DGDF]],[[NSPO3DGD]] 
[[I3DGV]],[[TO3DGVS]],[[TO3DGVF]],[[NSPO3DGV]] 
[[I3DGT]],[[TO3DGTS]],[[TO3DGTF]],[[NSPO3DGT]] 
The following line will be read in if [[IM]] is 21 or 31. 
[[RES_BC_FLAG]], [[BCFLAG_LNM]], [[BCFLAG_TEMP]] 
The following two lines will be read in if [[RES_BC_FLAG]] is negative. 
[[RBCTIMEINC]] 
[[BCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 2. 
[[RBCTIMEINC]], [[SBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3. 
[[RBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 4. 
[[RBCTIMEINC]], [[SBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3 or 4 and [[BCFLAG_TEMP]] is not equal to 0. 
[[TTBCTIMEINC]], [[TTBCSTATIM]] 
[[TTBCTIMEINC]] 
The following two lines will be read in only if [[IM]] is 21 or 31. 
[[SPONGEDIST]] 
[[EQNSTATE]] 
The following lines will be read in only if [[IDEN]] is > 0. 
[[NLSD, NVSD]] 
[[NLTD, NVTD]] 
[[ALP4]] 
The following line will be read in only if [[IDEN]] = 3 or 4. 
[[NTF]]

==NetCDF Controls==
The following lines will be read in only if the NetCDF output or hotstart format is chosen 
NCPROJ 
NCINST 
NCSOUR 
NCHIST 
NCREF 
NCCOM 
NCHOST 
NCCONV 
NCCONT 
NCDATE

==Namelists==
The following Fortran namelist lines are optional, but if they appear, they must appear at the very end of the fort.15 file. 
<code>&metControl WindDragLimit=floatValue, DragLawString='stringValue', rhoAir=floatValue, outputWindDrag=logicalValue /</code> 
<code>&timeBathyControl NDDT=integerValue, BTIMINC=floatValue, BCHGTIMINC=floatValue, invertedBarometerOnElevationBoundary=logicalValue /</code> 
<code>&waveCoupling WindWaveMultiplier=floatValue /</code> 
<code>&SWANOutputControl SWAN_OutputHS=logicalValue, SWAN_OutputDIR=logicalValue, SWAN_OutputTM01=logicalValue, SWAN_OutputTPS=logicalValue, SWAN_OutputWIND=logicalValue, SWAN_OutputTM02=logicalValue, SWAN_OutputTMM10=logicalValue /</code> 
<code>&subdomainModeling subdomainOn=logicalValue/</code> 
<code>&wetDryControl outputNodeCode=logicalValue, outputNOFF=logicalValue, noffActive=logicalValue /</code> 
<code>&inundationOutputControl inundationOutput=logicalValue0, inunThresh =floatValue /</code> 
<code>&TVWControl use_TVW=logicalValue, TVW_file='stringValue', nout_TVW =integerValue, touts_TVW =floatValue, toutf_TVW=floatValue, nspool_TVW =integerValue /</code> 
<code>&WarnElevControl WarnElev=floatValue, ErrorElev=floatValue, WarnElevDump=logicalValue, WarnElevDumpLimit=integerValue /</code> 
<code>[[Dynamic_water_level_correction#Controlling_Water_Level_Correction|&dynamicWaterLevelCorrectionControl]] dynamicWaterLevelCorrectionFileName='stringValue' dynamicWaterLevelCorrectionMultiplier=floatValue, dynamicWaterLevelCorrectionRampStart=floatValue, dynamicWaterLevelCorrectionRampEnd=floatValue, dynamicWaterLevelCorrectionRampReferenceTime='stringValue', dynamicWaterLevelCorrectionSkipSnaps=integerValue /</code> 
<code>&[[AliDispersionControl]] CAliDisp=logicalValue, Cs=floatValue, Ad=floatValue, Bd=floatValue /</code> 
[[category:input files]]

Fort.13 file

2023-02-02T20:22:19Z

Taylorgasher: /* Advection State */ Added a note to ease comprehension

The fort.13 file contains nodal attributes, which can vary spatially. For each attribute, one or more values are specified at each node. The number of values and their meaning(s) varies by attribute.

== File Format ==
See [[fort.13 file format]] for details. This file is only read when [[NWP]] > 0 in the Model Parameter and Periodic Boundary Condition File ([[fort.15 file]]).

== Nodal Attributes ==
Note that units for nodal attributes are specified by the user in the fort.13 file, though ADCIRC may require that attributes be supplied in certain units.

===Advection State===
'''Nodal attribute name:''' advection_state 
'''Description:''' The advection_state nodal attribute is used to provide fine grained control over the NOLICA and NOLICAT parameters, so that they can be set on an element-by-element basis. The bathymetric depth at the three nodes of an element are compared to the corresponding nodal attribute values, and if the bathymetric depth at all three nodes is greater than or equal to the corresponding nodal attribute value, the values of NOLICA and NOLICAT will be set to the value indicated in the Model Parameter and Periodic Boundary Condition (fort.15) file. If the bathymetric depth at any of the three nodes of a particular element is less than the corresponding nodal attribute value, the values of NOLICA and NOLICAT will be set to zero on that element.

The most common application of this is to set advection_state to a very large positive value (greater than any depth in the mesh) at selected nodes in the fort.13 file at which you want advection to be off. Then, to turn on advection at all other nodes, set the default value in the fort.13 file to a very large negative value, and set NOLICA=1 and NOLICAT=1 in the fort.15 file. 
'''Requirement:''' Optional. 
'''Units:''' Length. 
'''Values:''' Any. 
'''ADCIRC Variable:''' AdvectionState 

===Bottom Roughness===
'''Nodal attribute name:''' bottom_roughness_length 
'''Description:''' Roughness length for 3D bottom friction calculations. Has no effect on a 2DDI ADCIRC run. 
'''Requirement:''' Optional. 
'''Units:''' Length (m) 
'''Values:''' Greater than zero. A reasonable range for the bottom_roughness_length would be 0.001m -0.2m , (densely vegetated overland values would have an upper limit of about 0.2-0.5m and smooth muddy bottoms could have values as low as 0.0001 m). 
'''ADCIRC Variable:''' Z0b_var 

=== Bridge Pilings Friction Parameters ===
'''Nodal attribute name:''' bridge_pilings_friction_parameters 
'''Description:''' Extra friction from bridge pilings. See Note below. 
'''Requirement:''' Very optional. 
'''Units:''' Vary, see note below and BK, BALPHA, BDELX and POAN. 
'''Values:''' Vary, see note below and BK, BALPHA, BDELX and POAN. 
'''ADCIRC Variable:''' BK, BAlpha, BDelX, POAN 
'''Note:''' Special considerations must be used when designing a grid for an ADCIRC application that includes the effects of bridge pilings. Specifically, it is necessary to build the grid to provide at least three rows of nodes that parallel the bridge span. One row of nodes (centerline nodes) should lie along the approximate centerline of the bridge while the second and third rows of nodes (adjacent nodes) should lie on either side of the centerline nodes in the along steam direction. An initial implementation of obstruction drag in ADCIRC placed this drag entirely at the row of centerline nodes. However, tests showed that this arrangement led to significant oscillations in the numerical solution. The oscillations abated when the obstruction drag was distributed in the along stream direction so that 25 percent was located at each row of adjacent nodes and 50 percent was located at the row of centerline nodes. Node numbers and coefficient values at all nodes on the centerline and two adjacent rows must be entered in this input file. It is not necessary for centerline nodes to correspond to actual piling positions, (i.e., in the cross stream direction), since the overall effect of the pilings on the large scale circulation is all that is being represented. It is important, however, to construct a grid that is as uniform as possible in the vicinity of the bridge. 

===Chezy Friction Coefficient===
'''Nodal attribute name:''' chezy_friction_coefficient_at_sea_floor 
'''Description:''' Chezy friction coefficient. If the user elects to use this nodal attribute, NOLIBF must be set to 1 or the run will terminate. 
'''Requirement:''' Optional. 
'''Units:''' Specified by user. 
'''Values:''' Greater than zero. 
'''ADCIRC Variable:''' ChezyFric''' 

===Eddy Viscosity===
'''Nodal attribute name:''' average_horizontal_eddy_viscosity_in_sea_water_wrt_depth 
'''Description:''' See description [[horizontal eddy viscosity]]. 
'''Requirement:''' Optional. 
'''Units:''' For standard eddy viscosity, units are specified by the user,((length**2)/time). For Smagorinsky-type, unitless. 
'''Values:''' Greater than or equal to zero. 
'''ADCIRC Variable:''' EVC 

===Elemental Slope Limiter===
'''Nodal attribute name:''' elemental_slope_limiter 
'''Description:''' This nodal attribute is used to selectively limit the maximum elevation gradient that can occur across an element, thus improving numerical stability. Alternatively, it is also capable of merely logging individual elements where a specified elemental slope is exceeded at some point during the simulation. When this nodal attribute is loaded, warning messages will be written to the screen and to the fort.16 log file whenever the elevation gradient meets or exceeds the threshold value for the first time at a particular node. When the elemental slope limiter is active at a node, the water surface elevation at that node is reset to the average of the water surface elevations of the surrounding nodes. At the end of the run, a file called ESLNodes.63 will be written to indicate the nodes where the threshold elevation gradient was met or exceeded. Furthermore, If there is an ESLNodes.63 file in the input directory when ADCIRC starts, ADCIRC will load the existing ESLNodes.63 file along with the hotstart file so that the simulation can pick up where it left off, in terms of the elements where the slope is actively limited. When such a simulation finishes, it will overwrite the existing ESLNodes.63 file with a new one that reflects the updated state of limited elemental slopes. 
'''Requirement:''' Optional. 
'''Units:''' length/length or unitless. 
'''Values:''' Zero indicates that slope limiting is always active at that node, because a zero elevation gradient will always be met or exceeded; a positive value indicates the maximum gradient to be allowed at that node, at or beyond which the slope limiter is activated; a negative number indicates that the elevation gradients should be compared to the absolute value of the nodal attribute at this node. In the case of a negative number, ADCIRC will log a warning to the screen and to the fort.16 file the first time the elemental slope is exceeded, but ESLNodes.63 file will not be affected, and the elemental slope limiting will not actually occur at the node. A suggested value for this nodal attribute is 0.001. 
'''ADCIRC Variable:''' elemental_slope_limiter_grad_max 

'''Version Notes:'''
{{ADC version|version=51.47|relation=ge}}
Any activated elemental slope limiter from the previous time step is deactivated and reassessed whether the elevation gradient meets or exceeds the threshold value for the current time step.
{{ADC version|version=51.47|relation=lt}}
Once the elevation gradient is met or exceeded at a node, the elemental slope limiter remains active at that node for the remainder of the ADCIRC run.

===Initial River Elevation===
'''Nodal attribute name:''' initial_river_elevation 
'''Description:''' The initial_river_elevation nodal attribute is used to set the initial water surface elevation at specified nodes. This attribute is functionally identical to the [[Sea Surface Height Above Geoid|<code>sea_surface_height_above_geoid</code>]] attribute, except that any values assigned to elevation-specified boundary conditions in this attribute '''do not''' persist after the start of the simulation. As a result, this attribute is more appropriate for initializing rivers. If both attributes are specified, then the assigned elevation is their sum. Currently, this attribute is only applied if the value supplied at a given node is above zero (i.e. depth less than zero). From cstart.F:
where (River_et_WSE.GT.0.d0)
eta2 = eta2 + River_et_WSE
end where
ADCIRC assumes by default that vertices with negative depths will be dry when the simulation starts. This is, of course, not the case for an inland river whose bed is above mean sea level. This nodal attribute is used in those cases to provide the initial water surface elevation of the river at cold start, and is typically used in conjunction with a flux or elevation [[boundary conditions|boundary condition]] at the inland boundary. See also [[initial conditions]]. 
'''Requirement:''' Optional, but recommended if the domain contains a river with an upstream flux boundary condition and a bed elevation above ADCIRC's starting water elevation (zero unless otherwise specified). 
'''Units:''' Length. 
'''Values:''' Any. 
'''ADCIRC Variable:''' <code>River_et_WSE</code>. 

===[[Internal Tide Energy Conversion]]===
{{ADC version|version=53.01|relation=ge}}
'''Nodal attribute name:''' internal_tide_friction 
'''Description:''' Linear friction term that accounts for energy conversion from barotropic modes to baroclinic modes as surface tides flow over steep and rough topography in the deep ocean generating internal tides. 
'''Requirement:''' Important when simulating tides in computational domains that cover large portions of the deep ocean. 
'''Units:''' 1/sec. 
'''Values:''' Computed through analytical formulations that are spatially dependent on buoyancy frequencies and topographic gradients. 
'''ADCIRC Variable:''' IT_Fric 
'''Note:''' IT_Fric can have 1 (scalar) or 3 (tensor) dimensions. The scalar form dissipates equally in all flow directions. The tensor form dissipates asymmetrically to account for the fact that internal tides are generated as surface tides flow across topographic slopes but not along them. 

===[[Manning's n at sea floor]]===
'''Nodal attribute name:''' mannings_n_at_sea_floor 
'''Description:''' Manning's n. If the user elects to use this nodal attribute, [[NOLIBF]] must be set to 1 or the run will terminate. During execution, the Manning’s n value specified here is converted to an equivalent quadratic friction coefficient before the bottom stress is calculated. The equivalent quadratic friction coefficient is calculated according to the following formula at each node at each time step: Cd(t)=(g*n^2)/cuberoot(depth[+eta(t)]) where depth is the bathymetric depth and [eta(t)] is the water surface elevation. The addition of the water surface elevation is conditional upon the setting of NOLIFA: eta(t) is treated as zero if NOLIFA is set to zero in the fort.15 file. Finally, the value of CF in the fort.15 is used to set a lower limit on the resulting equivalent quadratic friction coefficient, since the Cd calculated from this formula tends to become small in deep water. 
'''Requirement:''' Optional. 
'''Units:''' Specified by user. 
'''Values:''' Greater than zero. 
'''ADCIRC Variable:''' ManningsN 

===Min and Max Primitive Weighting in Continuity Equation===
'''Nodal attribute name:''' min_and_max_primitive_weighting_in_continuity_equation 
'''Description:''' Controls upper and lower bounds on [[TAU0]], which affects numerical damping and stability. 
'''Requirement:''' Optional. 
'''Units:''' Specified by the user, 1/time. 
'''Values:''' Information and suggested range supplied in description of [[TAU0]]. 
'''ADCIRC Variable:''' Tau0MinMax 

===Primitive Weighting in Continuity Equation===
'''Nodal attribute name:''' primitive_weighting_in_continuity_equation 
'''Description:''' Related to [[TAU0]], affects numerical damping and stability. 
'''Requirement:''' Optional. 
'''Units:''' Specified by the user, 1/time. 
'''Values:''' Information and suggested range supplied in description of [[TAU0]]. 
'''ADCIRC Variable:''' Tau0Var 

===Quadratic Friction coefficient===
'''Nodal attribute name:''' quadratic_friction_coefficient_at_sea_floor 
'''Description:''' See the description of CF in the Model Parameter and Periodic Boundary Condition File. If the user elects to load this from the fort.13 file, [[NOLIBF]] must be set to 1 or the run will terminate. 
'''Requirement:''' Optional. 
'''Units:''' Unitless. 
'''Values:''' Same as CF. 
'''ADCIRC Variable:''' Fric 

===Sea Surface Height Above Geoid===
'''Nodal attribute name:''' sea_surface_height_above_geoid 
'''Description:''' Creates an initial offset of the sea surface from ADCIRC's reference water level (informally, the geoid). If the offset is specified at an elevation boundary such as an open-ocean tidal boundary, it will remain throughout the simulation. Except for that trait, this attribute is functionally identical to the [[initial river elevation|<code>initial_river_elevation</code>]] attribute. Since this attribute does persist along boundaries, it is often used to simulate a steric effect, where water levels are higher in warm seasons because of thermal expansion. See also [[initial conditions]]. 
'''Requirement:''' Optional. 
'''Units:''' Specified by the user (length). 
'''Values:''' Any. 
'''ADCIRC Variable:''' <code>GeoidOffset</code> 

=== Surface Canopy coefficient ===
'''Nodal attribute name:''' surface_canopy_coefficient 
'''Description:''' This attribute allows the user to turn off wind stress in heavily forested areas that have been flooded, like a swamp. The canopy shields the water from the effect of the wind. 
'''Requirement:''' Optional. 
'''Units:''' Unitless. 
'''Values:''' Zero if the wind stress should be zero because of a canopy. One otherwise. 
'''ADCIRC Variable:''' VCanopy 

===[[Wind_Stress#Roughness_Reductions|Surface Roughness]]===
'''Nodal attribute name:''' surface_directional_effective_roughness_length 
'''Description:''' A measure of the “roughness” of the land that can impede wind flow and reduce the surface stress that the wind applies. The ocean would be considered very smooth, and skyscrapers would be considered very rough. This attribute is directional, and the twelve values represent the roughness lengths “seen” by winds blowing from twelve different compass directions at each node. The orientation of the twelve values follows the trigonometric convention, that is, zero degrees represents due east, and the values proceed counter clockwise. In other words, the first value at a node is applied to winds blowing from west to east, the second value applies to winds blowing East-Northeast, etc. 
'''Requirement:''' Optional. 
'''Units:''' Specified by the user, as is the case for all nodal attributes. The data we use is provided in meters. 
'''Values:''' Greater than or equal to zero. 
'''ADCIRC Variable:''' z0Land 

===Surface Submergence State===
'''Nodal attribute name:''' surface_submergence_state 
'''Description:''' This attribute can force a node to be categorized as dry at the start of the simulation, even if it is below the geoid. This is important for simulating places like New Orleans that are below sea level but are not underwater. 
'''Requirement:''' Optional. 
'''Units:''' Unitless. 
'''Values:''' If set to 1, the node is categorized as dry at the cold start of the simulation. If set to zero, the node is categorized as wet or dry depending on whether its depth is below or above the geoid. 
'''ADCIRC Variable:''' StartDry 

===Wave Refraction in SWAN===
'''Nodal attribute name:''' wave_refraction_in_swan 
'''Description:''' to turn wave refraction on or off in the SWAN calculations during a coupled ADCIRC+SWAN run. In an ADCIRC-only run, this nodal attribute is ignored. 
'''Requirement:''' Optional. 
'''Units:''' Unitless. 
'''Values:''' If set to 1 at a node, wave refraction will be active at that node in the SWAN calculations during a coupled ADCIRC+SWAN run. If set to 0, wave refraction will be deactivated at that node in a coupled ADCIRC+SWAN run. 
'''ADCIRC Variable:''' SwanWaveRefrac 

'''Version Notes:'''
{{ADC version|version=53.00|relation=lt}}
Starting with version v41.01B of SWAN and version 53.00 of ADCIRC, this nodal attribute should no longer be used. See post by Casey Dietrich, [https://ccht.ccee.ncsu.edu/updates-to-spectral-propagation-velocities/ here].

===Absorption-generation Sponge Layer===
'''Nodal attribute name:''' sponge_generator_layer 
'''Description:''' 
'''Requirement:''' Optional. 
'''Units:''' Unitless. 
'''Values:''' 

[[Category:input files]]
[[Category:nodal attributes]]

Wind Stress

2022-11-17T04:53:57Z

Taylorgasher: /* Powell Drag Formulation */

When wind blows over the water, it exerts a shear stress at the water surface that transfers horizontal momentum vertically downward across the air–sea interface, driving circulation. In ADCIRC, wind stress is an input forcing term, with several different formats provided. See the <code>[[NWS]]</code> parameter for available formats. In most cases, the exact wind stress to be applied to the model is not provided, therefore ADCIRC must determine how to convert a given wind speed to the actual stress applied at the ocean surface. This page covers the various aspects of this process, as well as the options available to the user.

== Definition of Winds ==
The characteristics of wind forcing are often broken down in three ways:
# Whether the winds are considered to be over-water (termed "marine exposure") or over-land
# The elevation above the sea (or ground) surface of the winds
# The time-averaging (if any) that has been applied

ADCIRC generally expects 10-meter, 10-minute winds at their actual exposure, although the exact expectations vary depending on the input type. For instance, when Holland-type wind inputs are provided (e.g. <code>NWS=8</code> or <code>NWS=20</code>), the wind speed is expected to be the '''1-minute [https://en.wikipedia.org/wiki/Maximum_sustained_wind maximum sustained wind]''' at 10 meters elevation. If marine-exposure winds are provided, then [[Fort.13_file#Surface_Roughness|surface roughness]] reductions may be needed
<ref name="simiu1996">Simiu, E., Scanlan, R.H., 1996. Wind effects on structures: fundamentals and applications to design, 3rd ed. ed. John Wiley, New York.</ref>
<ref name="simiu2018">Simiu, E., Yeo, D., 2018. Wind effects on structures: modern structural design for wind, Fourth edition. ed. John Wiley & Sons, Hoboken, NJ.</ref>
. If winds are provided with a different averaging time, then an appropriate correction may be needed, though winds with averaging times of 10 to 60 minutes are generally considered to be quite similar; this is the so-called mesoscale gap. For recommendations on wind time-scale conversions not handled internally by ADCIRC, for tropical cyclones, see the WMO guidelines of Harper et al.
<ref name="wmotcaveraging">Harper, B., Kepert, J., Ginger, J., 2010. Guidelines for converting between various wind averaging periods in tropical cyclone conditions (No. WMO/TD-No. 1555). WMO, Geneva, Switzerland.</ref>

== Roughness Reductions ==
Reductions in wind speed to convert to the appropriate exposure come from a logarithmic boundary layer formulation (see, e.g. <ref name="simiu1996" /> <ref name="simiu2018" />) to determine a fraction <math>f</math> to reduce the winds,
:<math>f=\left ( \frac{z_{0l}}{z_{0m}}\right ) ^{0.0706} \left ( \frac{\ln \frac{10}{z_{0l}}}{\ln \frac{10}{z_{0m}}} \right ) </math>
for marine roughness length <math>z_{0m}</math> and reduced ("land") roughness length <math>z_{0l}</math>. Wind speed is then reduced as,
:<math>\mathbf{w}'=f\mathbf{w}=f [u,v]</math>
for x- and y- wind vector components <math>u</math> and <math>v</math>. The marine roughness length is,
:<math>z_{0m}=\frac{0.018}{g} c_d \left \Vert \mathbf{w} \right \| </math>
for Charnock parameter <math>0.018</math>, drag coefficient <math>c_d</math> and acceleration due to gravity <math>g</math>. The wind drag coefficient is addressed below in [[#Converting Wind Velocity to Wind Stress|this section]]. As previously noted, the reduced ("land") roughness length <math>z_{0l}</math> is specified by the user via the [[Fort.13_file#Surface_Roughness|surface roughness]] nodal attribute. The fraction <math>f</math> is bounded on <math>[0,1]</math>, meaning the winds cannot be increased, nor change direction.

=== Older Behavior ===
====Interpolating Roughness Lengths Before v55====
[[File:WindTraceV2.png|right|thumb|Comparison of output wind velocities using old and new methods.]]
{{ADC version|version=55|relation=lt}}Before version 55, the directional wind reductions were applied by determining which of the 12 directional bins the wind velocity (at each time step) fell into, and using that roughness reduction, i.e. nearest neighbor interpolation. Starting in version 55, the roughness length is linearly (in angle space) interpolated between directional bins. In testing, this has been found to generally have a very small effect on water levels, but a notable effect on wind speeds, since time evolution of winds is smoother. It can have large localized effects on water levels in rare cases in cases where there are large changes in neighboring roughness length bins coinciding with well-aligned winds, as in [[:File:MaxeleDiffRun13MinusRun12View1.png|this test case]] with Hurricane Isaac.
 

====Roughness Reduction Bug Before v54====
{{ADC version|version=54|relation=lt}}Before version 54, there was a bug in this calculation. The mistake and its effects are addressed in this PDF document: '''ADD A LINK TO A PDF HERE YOOOOO'''.

== Converting Wind Velocity to Wind Stress ==
In ADCIRC, four formulations are available to convert wind velocities to the wind stresses applied in the momentum equations. Although there are several ways to control this, users are generally encouraged to use the [[metControl]] namelist in the [[fort.15]] file. The default drag formulation is the Garratt
<ref name=garratt1977>Garratt, J.R., 1977. Review of Drag Coefficients over Oceans and Continents. Mon. Wea. Rev. 105, 915–929. https://doi.org/10.1175/1520-0493(1977)105<0915:RODCOO>2.0.CO;2</ref>
linear formula. An alternative for use with tropical cyclones is the Powell formulation,
<ref>Powell, M.D., Vickery, P.J., Reinhold, T.A., 2003. Reduced drag coefficient for high wind speeds in tropical cyclones. Nature 422, 279–283. https://doi.org/10.1038/nature01481</ref>
which varies drag by the sector of the tropical cyclone. When ice coverage is included in the model, a wind drag formulation that accounts for this effect should be used. By default, if ice coverage input data are supplied, ADCIRC uses a cubic function of ice coverage, termed the "IceCube" drag formulation. Lastly, the "swell" drag law option allows users to utilize SWAN's drag formulation when employing the coupled model.

In all cases, the actual wind drag coefficients determined by ADCIRC can be output to a [[fort.63]]-type file named [[winddrag.173]]. Output settings (file format, output start/end times, and output interval) match those of either the fort.63 or fort.73/74 files, ''I think'' fort.73/74. Outputting of this file is enabled by setting <code>outputWindDrag=.TRUE.</code> in the <code>&metControl</code> namelist of the [[Fort.15_file_format#Namelists|fort.15 file's namelist section]].

=== Garratt Drag Formulation ===
This is the default wind drag formulation in ADCIRC. From Garratt (1977)<ref name=garratt1977></ref>, the formula is,
:<math>c_d=0.001 \left ( 0.75+0.067 \left \Vert \mathbf{w} \right \| \right ) </math>

By default, ADCIRC puts an upper bound on the drag coefficient of <math>c_d\le0.0035</math>. This upper bound <code>WindDragLimit</code> can be changed via the [[metControl]] fort.15 namelist.

=== Powell Drag Formulation ===
CONTRIBUTOR NEEDED
Note that the code for the Powell drag law has not been configured to reverse orientation in the southern hemisphere, and so will produce the wrong results. For details on Powell, see [https://ccht.ccee.ncsu.edu/wind-drag-based-on-storm-sectors/ this post].

=== IceCube Drag Formulation ===
CONTRIBUTOR NEEDED

==References==
<references />

[[Category:meteorology]]
[[Category:physics]]

Tools

2022-11-12T17:56:20Z

Taylorgasher: Added a bunch of stuff

There are a wide host of tools within the ADCIRC community, covering many purposes, and there is not yet a single centralized repository for all of them. This page serves as a host for organizing and linking to these various tools. Tools specifically for model visualization are discussed on the [[visualization]] page.

Did we miss something? Let us know!

==Multi-Purpose==
*[https://github.com/jasonfleming/asgs ASGS] enables automated operational simulations of ADCIRC, including acquisition of National Hurricane Center advisory data.
*[https://github.com/natedill/ourPerl/tree/master/AdcircUtils A suite of Perl utilities] can be found on Nate Dill's Github.
*[https://github.com/BrianOBlanton/adcirc_util adcirc_util] is a suite of utilities in Matlab.
*[https://github.com/noaa-ocs-modeling/adcircpy adcircpy] is a suite of utilities in Python.
*[https://github.com/zcobell/ADCIRCModules ADCIRCModules] is a suite of utilities in C++ and Python.

==Uncategorized==
*[http://adcirc.org/home/related-software/adcirc-utility-programs/ The ADCIRC utilities webpage] hosts several basic and more advanced tools.

==File Construction==
*[https://github.com/CHLNDDEV/OceanMesh2D OceanMesh2D] facilitates mesh construction and editing.
*[http://adcirc.org/home/related-software/adcirc-utility-programs/ f13builder] helps easily create nodal attributes and the [[fort.13 file]].
*[https://www.aquaveo.com/software/sms-surface-water-modeling-system-introduction SMS] is a commercial software specially designed for constructing ADCIRC input files and visualizing model outputs.

Visualization

2022-11-12T17:53:24Z

Taylorgasher: Added some small items

For more general tools and utilities, see [[Tools]]. In the course of running ADCIRC you may wish to visualize or plot data pertaining to your model. Visualizing data can help you fine tune the mesh design, conduct QA/QC on results, and communicate key facets of the modeling to others. Examples of datasets you might plot include mesh elevation; [[nodal attribute]]s such as [[Manning's n at sea floor|Manning’s n]]; or modeled results such as water surface elevation. For visualizing on a 2D flexible mesh, ADCIRC users often choose to plot them as color contours that follow the mesh triangulation.

== Plotting Considerations ==
Options abound for generating plots, and the best tool for the job depends on project goals and available resources/software. Some factors to consider in choosing a visualization tool include:
*Interactive vs. static image – do you intend to zoom and pan around your visualized data and/or change contour intervals on the fly, or would you prefer to batch process image files at fixed zoom extents and contour limits?
*Data transfer – do you intend to run simulations on the same computer you visualize results?
*Desired processing speed – does the speed of plotting matter to you? This can be important, e.g. when making videos.
*NetCDF vs. ASCII data – while ADCIRC mesh and nodal attributes input files must take ASCII form, outputs can be ASCII or NetCDF. Consider this since some plotting tools only work with one or the other. A few considerations:
**Multiple applications can read a NetCDF4 file simultaneously, which could save considerable time if you can run your plotting tool concurrently on multiple processors within one compute node.
**NetCDF ADCIRC output files self-contain mesh node, connectivity, and boundary information.
**The learning curve to coding with netCDF files can be much steeper than ASCII.
*Projection – ADCIRC is often run in geographic coordinate system, which references a spherical object; do you need the plotting tool to accurately project geographic coordinates, or is distortion acceptable?
*Which files do you need to visualize? Do you need to plot nodal attribute (fort.13) data, or just ADCIRC output?
*Effort – do you prefer a DIY, high customization approach or a ready-to-run program? Somewhat related question: do you want to buy software or leverage open source libraries? Common items:
**Overlaying a vector field showing wind magnitude and direction or wave direction
**Adding background aerial imagery
**Auto-calculating contour bounds within the specified zoom extents
**Overlaying shapefiles showing county boundaries, inshore waterways, storm track, etc.

==SMS (Surface-water Modeling System)==
Aquaveo’s SMS software features a suite of many GUI-based pre- and post-processing tools that allow for interactive visualization. SMS requires a license, but out of the box you can easily open and view an ADCIRC mesh and any associated data, including nodal attributes files. SMS plots mesh data as a triangulated irregular network (TIN) surface, allowing the user to change contour intervals as desired. You will need to download files from the HPC you run ADCIRC onto your desktop to plot them with SMS. A few notes about SMS:
*ADCIRC output NetCDF support is “coming soon” as of version 12.1. SMS supports other types of NetCDF data but cannot open a *.63.nc file.
*When ADCIRC output files are opened, SMS automatically converts them from ASCII to binary HDF5 format. This format allows data to load quickly – anecdotal reports estimate this speed to be faster than the same data displayed as a TIN in ArcMap.
*SMS can...
**project data in geographic coordinates properly.
**download zoom-specific aerial imagery to display as a background layer.
**supports vector overlays for fort.74-style ADCIRC data (u v format only, so you need to reformat swan_DIR.63 before displaying as vector field).
**display shapefiles, but with limited options for changing their symbology.

==FigureGen==
[https://ccht.ccee.ncsu.edu/figuregen-v-49/ FigureGen] (by Casey Dietrich of NC State) batch produces images of model data. FigureGen is a Fortran program that uses the Generic Mapping Tools (GMT) library. To use FigureGen, you must first install GMT and any of its auxiliary programs that don’t already exist on your system. These may already be installed if on a supercomputer. When you compile FigureGen, you can use flags to enable Google Earth output, NetCDF support, and parallel processing. You’ll then edit a text file of input parameters, including zoom extent and required output snaps (for time-varying ADCIRC output file), and FigureGen will generate the series of requested images. A few notes about FigureGen:
*FigureGen is a triple threat – it’s fast, easy to use, and free (but please cite as appropriate!)
*You can typically run FigureGen on the same machine you run ADCIRC, no need to download large output files.
*GMT supports map projections so FigureGen plots geographic coordinates correctly.
*Features options for overlaying a vector field ([[fort.74 file|fort.74]]-style data) including automatically finding the maximum vector magnitude present within the zoom extent.
**Can automatically find the maximum data value present within the zoom extent to set the contour maximum.
**Can overlay a GSHHS shoreline. If your mesh includes detailed inshore waterways, this shoreline may not include sufficient resolution.
**Can add a time bar.
**Can plot the difference between two (scalar?) files.
**Can plot nodal attribute data (except for ''elemental_slope_limiter'', but that is easy to add yourself)
**Can produce several types of image files, and the user can set resolution to control file size.

==Kalpana==
[https://ccht.ccee.ncsu.edu/kalpana/ Kalpana] (by Rosemary Cyriac) produces either a shapefile or a Google Earth kml file of ADCIRC netCDF output or mesh bathymetry. Kalpana is a Python script that generates color contours using the mesh triangulation via the 2D plotting library Matplotlib, then converts the contours to either shapefile via the Fiona/Shapely libraries, or to kmz via the Simplekml library. Both the shapefile option and kml option produce polygons that enclose areas with data values that fall into one contour bin.
*How-to instructions can be found [https://ccht.ccee.ncsu.edu/how-to-run-kalpana/ here]
*Kalpana is free (but cite as appropriate!)
*No support for plotting nodal attributes parameters yet.
*Shapely/Fiona and Simplekml support map projections and thus properly plot geographic coordinates.
*Like many Python scripts, Kalpana should be run in a virtual environment. Setting up this virtual environment can be simple or frustrating depending on existing system installations on your HPC. Jason Fleming wrote a [https://ccht.ccee.ncsu.edu/installing-python-modules-for-kalpana/ great post on his experience] in installing the various Python libraries within a virtual environment.
*Kalpana runs on an HPC, so you don’t need to download data to your desktop to plot.
*There exists a file size and speed trade-off to the two file format options – the kml option is slower to generate, but the file size is relatively small; the shapefile option generates very quickly (nearly as fast as FigureGen) but the file size is on the order of the size of the file it’s plotting. Also note that the speed of the kml generation depends on the number of lat/long bins you set up in the command line, and the number of bins depends on mesh extent and resolution.
*The shapefiles and kml files produced allow the user to zoom and pan around, but not to dynamically change contour intervals on the fly – the polygons represent an instance or a snapshot of the data.
*Both shapefile and kml are popular file formats with the outside world, so they’re good choices for communicating your model results to others.
*Neither file format supports vector fields. If you want vector fields, you should edit the Kalpana script to skip the Shapely/Fiona or Simplekml parts and use Matplotlib directly to add the vector field and save the Matplotlib plot as a png.

==ArcGIS==
Esri’s classic software contains no canned tools to read or write ADCIRC data. The user must develop scripts to read ADCIRC files via ArcMap's integrated Python package (ArcPy). Once you’ve imported ADCIRC mesh geometry, nodal attributes, and model results data into a geodatabase, you can easily create a TIN using the mesh triangulation as hard breaklines to view your data in a similar fashion to SMS. Note that the license for ArcMap costs significantly more than an SMS license. So why the heck would you ever consider using ArcStuff for your visualization needs?
*Esri is everywhere – you might already have access to a network license or to colleagues with advanced GIS knowledge.
*While ArcMap doesn’t feature canned tools to read ADCIRC data, it does feature canned geoprocessing tools that can aid greatly in assigning nodal attribute data or interpolating mesh node elevations. For example, you can map data showing land use/land cover in raster or polygon format onto your nodes to assign Manning’s ''n'', or you can create custom schemes for interpolating DEM data onto your mesh nodes.
*As of version 10.3, ArcPy includes the netCDF4 library.
*ArcMap allows for a very high level of customization in your image layout. North arrows, scales, legends, infinite symbology and overlays – wow!
*But, you must download ADCIRC output data from your HPC to wherever your ArcGIS license exists.

==Python==
See [[tools]].

==Matlab==
See [[tools]].

==Paraview==
Super powerful, but can be a pain. Tough to generalize here, email the listserv if interested.

==External Links==
* [https://www.aquaveo.com/software/sms-surface-water-modeling-system-introduction SMS by Aquaveo]
* [https://ccht.ccee.ncsu.edu/figuregen-v-49/ FigureGen v49] NC State Coastal & Computational Hydraulics Team
* [https://ccht.ccee.ncsu.edu/kalpana/ Kalpana] NC State Coastal & Computational Hydraulics Team
* [http://www.adcirc.io/ ADCIRC.io]
* [http://desktop.arcgis.com/en/arcmap/ ArcMap]
* [https://www.mathworks.com/products/matlab.html Matlab]
* [https://www.paraview.org/ Paraview]
* [https://github.com/GenericMappingTools/gmt Generic Mapping Tools (GMT)]
* [https://matplotlib.org/ Matplotlib]

Visualization

2022-11-12T17:40:34Z

Taylorgasher: tools link

For more general tools and utilities, see [[Tools]]. In the course of running ADCIRC you may wish to visualize or plot data pertaining to your model. Visualizing data can help you fine tune the mesh design, conduct QA/QC on results, and communicate key facets of the modeling to others. Examples of datasets you might plot include mesh elevation; [[nodal attribute]]s such as [[Manning's n at sea floor|Manning’s n]]; or modeled results such as water surface elevation. For visualizing on a 2D flexible mesh, ADCIRC users often choose to plot them as color contours that follow the mesh triangulation.

== Plotting Considerations ==
Options abound for generating plots, and the best tool for the job depends on project goals and available resources/software. Some factors to consider in choosing a visualization tool include:
*Interactive vs. static image – do you intend to zoom and pan around your visualized data and/or change contour intervals on the fly, or would you prefer to batch process image files at fixed zoom extents and contour limits?
*Data transfer – do you intend to run simulations on the same computer you visualize results?
*Desired processing speed – does the speed of plotting matter to you? This can be important, e.g. when making videos.
*NetCDF vs. ASCII data – while ADCIRC mesh and nodal attributes input files must take ASCII form, outputs can be ASCII or NetCDF. Consider this since some plotting tools only work with one or the other. A few considerations:
**Multiple applications can read a NetCDF4 file simultaneously, which could save considerable time if you can run your plotting tool concurrently on multiple processors within one compute node.
**NetCDF ADCIRC output files self-contain mesh node, connectivity, and boundary information.
**The learning curve to coding with netCDF files can be much steeper than ASCII.
*Projection – ADCIRC is often run in geographic coordinate system, which references a spherical object; do you need the plotting tool to accurately project geographic coordinates, or is distortion acceptable?
*Which files do you need to visualize? Do you need to plot nodal attribute (fort.13) data, or just ADCIRC output?
*Effort – do you prefer a DIY, high customization approach or a ready-to-run program? Somewhat related question: do you want to buy software or leverage open source libraries? Common items:
**Overlaying a vector field showing wind magnitude and direction or wave direction
**Adding background aerial imagery
**Auto-calculating contour bounds within the specified zoom extents
**Overlaying shapefiles showing county boundaries, inshore waterways, storm track, etc.

==SMS (Surface-water Modeling System)==
Aquaveo’s SMS software features a suite of many GUI-based pre- and post-processing tools that allow for interactive visualization. SMS requires a license, but out of the box you can easily open and view an ADCIRC mesh and any associated data, including nodal attributes files. SMS plots mesh data as a triangulated irregular network (TIN) surface, allowing the user to change contour intervals as desired. You will need to download files from the HPC you run ADCIRC onto your desktop to plot them with SMS. A few notes about SMS:
*ADCIRC output NetCDF support is “coming soon” as of version 12.1. SMS supports other types of NetCDF data but cannot open a *.63.nc file.
*When ADCIRC output files are opened, SMS automatically converts them from ASCII to binary HDF5 format. This format allows data to load quickly – anecdotal reports estimate this speed to be faster than the same data displayed as a TIN in ArcMap.
*SMS can...
**project data in geographic coordinates properly.
**download zoom-specific aerial imagery to display as a background layer.
**supports vector overlays for fort.74-style ADCIRC data (u v format only, so you need to reformat swan_DIR.63 before displaying as vector field).
**display shapefiles, but with limited options for changing their symbology.

==FigureGen==
[https://ccht.ccee.ncsu.edu/figuregen-v-49/ FigureGen] (by Casey Dietrich of NC State) batch produces images of model data. FigureGen is a Fortran program that uses the Generic Mapping Tools (GMT) library. To use FigureGen, you must first install GMT and any of its auxiliary programs that don’t already exist on your system. These may already be installed if on a supercomputer. When you compile FigureGen, you can use flags to enable Google Earth output, NetCDF support, and parallel processing. You’ll then edit a text file of input parameters, including zoom extent and required output snaps (for time-varying ADCIRC output file), and FigureGen will generate the series of requested images. A few notes about FigureGen:
*FigureGen is a triple threat – it’s fast, easy to use, and free (but please cite as appropriate!)
*You can typically run FigureGen on the same machine you run ADCIRC, no need to download large output files.
*GMT supports map projections so FigureGen plots geographic coordinates correctly.
*Features options for overlaying a vector field ([[fort.74 file|fort.74]]-style data) including automatically finding the maximum vector magnitude present within the zoom extent.
**Can automatically find the maximum data value present within the zoom extent to set the contour maximum.
**Can overlay a GSHHS shoreline. If your mesh includes detailed inshore waterways, this shoreline may not include sufficient resolution.
**Can add a time bar.
**Can plot the difference between two (scalar?) files.
**Can plot nodal attribute data (except for ''elemental_slope_limiter'', but that is easy to add yourself)
**Can produce several types of image files, and the user can set resolution to control file size.

==Kalpana==
[https://ccht.ccee.ncsu.edu/kalpana/ Kalpana] (by Rosemary Cyriac) produces either a shapefile or a Google Earth kml file of ADCIRC netCDF output or mesh bathymetry. Kalpana is a Python script that generates color contours using the mesh triangulation via the 2D plotting library Matplotlib, then converts the contours to either shapefile via the Fiona/Shapely libraries, or to kmz via the Simplekml library. Both the shapefile option and kml option produce polygons that enclose areas with data values that fall into one contour bin.
*How-to instructions can be found [https://ccht.ccee.ncsu.edu/how-to-run-kalpana/ here]
*Kalpana is free (but cite as appropriate!)
*No support for plotting nodal attributes parameters yet.
*Shapely/Fiona and Simplekml support map projections and thus properly plot geographic coordinates.
*Like many Python scripts, Kalpana should be run in a virtual environment. Setting up this virtual environment can be simple or frustrating depending on existing system installations on your HPC. Jason Fleming wrote a [https://ccht.ccee.ncsu.edu/installing-python-modules-for-kalpana/ great post on his experience] in installing the various Python libraries within a virtual environment.
*Kalpana runs on an HPC, so you don’t need to download data to your desktop to plot.
*There exists a file size and speed trade-off to the two file format options – the kml option is slower to generate, but the file size is relatively small; the shapefile option generates very quickly (nearly as fast as FigureGen) but the file size is on the order of the size of the file it’s plotting. Also note that the speed of the kml generation depends on the number of lat/long bins you set up in the command line, and the number of bins depends on mesh extent and resolution.
*The shapefiles and kml files produced allow the user to zoom and pan around, but not to dynamically change contour intervals on the fly – the polygons represent an instance or a snapshot of the data.
*Both shapefile and kml are popular file formats with the outside world, so they’re good choices for communicating your model results to others.
*Neither file format supports vector fields. If you want vector fields, you should edit the Kalpana script to skip the Shapely/Fiona or Simplekml parts and use Matplotlib directly to add the vector field and save the Matplotlib plot as a png.

==ArcGIS==
Esri’s classic software contains no canned tools to read or write ADCIRC data. The user must develop scripts to read ADCIRC files via ArcMap's integrated Python package (ArcPy). Once you’ve imported ADCIRC mesh geometry, nodal attributes, and model results data into a geodatabase, you can easily create a TIN using the mesh triangulation as hard breaklines to view your data in a similar fashion to SMS. Note that the license for ArcMap costs significantly more than an SMS license. So why the heck would you ever consider using ArcStuff for your visualization needs?
*Esri is everywhere – you might already have access to a network license or to colleagues with advanced GIS knowledge.
*While ArcMap doesn’t feature canned tools to read ADCIRC data, it does feature canned geoprocessing tools that can aid greatly in assigning nodal attribute data or interpolating mesh node elevations. For example, you can map data showing land use/land cover in raster or polygon format onto your nodes to assign Manning’s ''n'', or you can create custom schemes for interpolating DEM data onto your mesh nodes.
*As of version 10.3, ArcPy includes the netCDF4 library.
*ArcMap allows for a very high level of customization in your image layout. North arrows, scales, legends, infinite symbology and overlays – wow!
*But, you must download ADCIRC output data from your HPC to wherever your ArcGIS license exists.

==Matlab==

==Paraview==

==External Links==
* [https://www.aquaveo.com/software/sms-surface-water-modeling-system-introduction SMS by Aquaveo]
* [https://ccht.ccee.ncsu.edu/figuregen-v-49/ FigureGen v49] NC State Coastal & Computational Hydraulics Team
* [https://ccht.ccee.ncsu.edu/kalpana/ Kalpana] NC State Coastal & Computational Hydraulics Team
* [http://www.adcirc.io/ ADCIRC.io]
* [http://desktop.arcgis.com/en/arcmap/ ArcMap]
* [https://www.mathworks.com/products/matlab.html Matlab]
* [https://www.paraview.org/ Paraview]
* [https://github.com/GenericMappingTools/gmt Generic Mapping Tools (GMT)]
* [https://matplotlib.org/ Matplotlib]

Dynamic water level correction

2022-08-23T14:48:57Z

Taylorgasher: /* Water Level Correction Input File */ tweak

'''Dynamic Water Level Correction''' is a process by which modeled water levels are dynamically adjusted by use of a forcing term. The correction can be applied as constant or varying in space and/or time. The correction is applied as a forcing term in the momentum equations whose mathematical form is equivalent to that of an atmospheric pressure term. This means that, for gradually-varying corrections, corrected water levels should closely follow the input correction, though these may deviate if a correction is applied very quickly or to an area that has a very weak connection to an open boundary through which water can flow. Further discussion is below in the [[#FAQ|FAQ]].

Overviews and examples of this capability have been provided in multiple presentations (Luettich et al. 2017<ref name="luettichPres2017">Luettich, R.L., T.G. Asher, B.O. Blanton, J.G. Fleming. Representing Low Frequency, Spatially Varying Water Level Anomalies in Storm Surge Computations. 2017 American Meteorological Society Annual Meeting. [https://ams.confex.com/ams/97Annual/webprogram/Paper316033.html Link to talk]</ref>, Asher et al. 2018<ref name="asherPres2018">Asher, T.G., R.L. Luettich, J.G. Fleming, B.O.Blanton. Assimilation of Observed Water Levels into Storm Surge Model Predictions. 2018 American Meteorological Society Annual Meeting. [https://ams.confex.com/ams/98Annual/webprogram/Paper334044.html Link to talk]</ref>) and a journal article (Asher et al. 2019<ref name="asher2019">Asher, T.G., Luettich Jr., R.A., Fleming, J.G., Blanton, B.O., 2019. Low frequency water level correction in storm surge models using data assimilation. Ocean Modelling 144, 101483. https://doi.org/10.1016/j.ocemod.2019.101483</ref>) with details and an application to Hurricane Matthew. Users looking for ways to generate water level correction surfaces can look to that same article and this digital publication/data repository<ref>Asher, T., 2019. Hurricane Matthew (2016) Storm Surge and Wave Simulations with Data Assimilation. https://doi.org/10.17603/2Z8H-7K90</ref>, which holds the code base used in the aforementioned paper.

== Version ==
{{ADC version|version=54|relation=ge}}
Early versions of this feature were implemented in v53, however important bug fixes and a renaming of related variables<ref group="note">If using an older version, note that in the fort.15 file, instances of "dynamicWaterLevelCorrection" should be changed to "offset" in the namelist parameter names, e.g. "offsetControl". </ref> were done later, so users are strongly encouraged to not use these earlier versions.

==Controlling Water Level Correction==
The water level correction feature is triggered by the presence of the &dynamicWaterLevelCorrectionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used: 
<code>&dynamicWaterLevelCorrectionControl dynamicWaterLevelCorrectionFileName="hsofs_offset_test_ft.dat" dynamicWaterLevelCorrectionMultiplier=0.3048, dynamicWaterLevelCorrectionRampStart=0.0, dynamicWaterLevelCorrectionRampEnd=259200.0 dynamicWaterLevelCorrectionRampReferenceTime="hotstart", dynamicWaterLevelCorrectionSkipSnaps=0 /</code>

* <code>dynamicWaterLevelCorrectionMultiplier</code> allows one to easily change the entire dataset by a single factor, e.g. if the data were provided in feet; ADCIRC requires meters.
* <code>dynamicWaterLevelCorrectionRampStart</code> and <code>dynamicWaterLevelCorrectionRampEnd</code> are the time in seconds for a linear ramp up period.
* <code>dynamicWaterLevelCorrectionRampReferenceTime</code> controls whether the ramp times are relative to the hotstart time or the coldstart time. Prior to the start of the ramp, the correction values are multiplied by 0.0, eliminating the correction until the ramp period starts.
* <code>dynamicWaterLevelCorrectionSkipSnaps</code> is used to skip the specified number of initial data sets in the corrections data file. It can also be used to insert blank snaps at the beginning of the run if it is negative.

===Water Level Correction Input File===
ADCIRC looks for the water level correction input file in the same directory as the other full-domain files, both in serial and in parallel. In parallel, each subdomain does domain decomposition of the correction data on the fly, so the only change to adcprep is the read/write of the new namelist to the subdomain fort.15 files. The water level correction input file starts with the following three header lines:

<nowiki>#</nowiki> test file for 1ft correction on hsofs mesh during matthew
14400.0 # time increment between datasets, must be positive -- read but ignored if constant correction
0.0 # default correction value

The first line is a comment line. The second line is the time interval in seconds between successive datasets. The third line is the default correction value; this allows us to create correction input files in a "sparse" format where only the non-default values are provided.If there is only one dataset in the correction file, then the values are treated as temporally constant. If there is more than one dataset, ADCIRC linearly interpolates between them in time. If ADCIRC runs out of correction data, it continues with the last dataset as a set of constant values for the remainder of the run.

Because each correction dataset may have a different number of values, the # (hash, pound, or number) symbol is used as a separator. Specifically, users should place a line containing # in the first and second columns, i.e. <code>##</code>, of the file after the end of the current time snap of data. When ADCIRC sees this, it understands the next line is the start of the next time snap of data.

===Output===
If a water level correction input file is specified, then the time interpolated water level correction values will be written to a file called [[offset.63]] on the same schedule as output to the [[fort.63]]. This file can then be used as a diagnostic to check that the correction values have been applied as expected.

==Compatibility==
Although the correction is implemented as a pseudo barometric pressure, it is entirely independent of any/all meteorological forcing and meteorological data. The values do not show up in the fort.71 (barometric pressure stations) or fort.73 (fulldomain barometric pressure field) output files. The correction can be used with any meteorological forcing data, or with no meteorological forcing data at all.

==Example==
An ADCIRC model is coldstarted with a tide only run that uses a 10 day ramp, and runs for 15 days. How should the water level correction be configured?

In this case, I suggest that you apply your bias correction after reaching full strength tidal forcing (i.e., after the 10 day tidal ramp). So to have your bias correction ramp completed at the end of the 15 day tidal spinup, start the ramp period at 10.0 days and end it at 13.0 days. This should ensure you clearly see the correction occurring when you look at the output data, while avoiding applying the correction too rapidly. In summary, set your ramp period in the fort.15 file to <code>dynamicWaterLevelCorrectionRampStart =864000.0, dynamicWaterLevelCorrectionRampEnd = 1036800.0</code>

Since this is the model spin-up period, using a time-constant correction is likely sufficient. That means a single time snap of correction data can be supplied, for example:
<nowiki>#</nowiki> bias correction values test for GFS 20161002 cycle 00Z
99999.9 # time increment in seconds; not used in this case
0.0 # default nodal value applied to any node not specified below
234 0.5
1223 0.6
1789 -0.2
4000 0.1
##

After the spinup, in preparation for a forecast run, when you want to migrate from one set of bias correction values to another over a 6 hour time period, the fort.15 file's <code>dynamicWaterLevelCorrectionControl</code> line would be something like this: 
<code>&dynamicWaterLevelCorrectionControl dynamicWaterLevelCorrectionFileName= "offset_migration_from_00Z_to_06Z.dat", dynamicWaterLevelCorrectionMultiplier = 1.0, dynamicWaterLevelCorrectionRampStart = 1252800.0, dynamicWaterLevelCorrectionRampEnd = 1296000.0, dynamicWaterLevelCorrectionRampReferenceTime = "coldstart", dynamicWaterLevelCorrectionSkipSnaps = 0 /</code>

and the corresponding file would look like something like the following:
# bias correction values for GFS 20161002 from cycle 00Z to cycle 06Z
21600.0 # 6 hour time increment in seconds
0.0 # default nodal value applied to any node not specified below
234 0.5
1223 0.6
1789 -0.2
4000 0.1
##
512 0.3
1001 -0.5
2346 0.74
4000 -0.1
##

At the end of the 15.0 day tidal spinup in this example the bias correction at node 234 would be 0.5. Three hours later (after the hotstart) it would be 0.25. Six hours after the hotstart it would be zero.

At the end of the 15.0 day tidal spinup in this example the bias correction at node 1001 would be 0.0. Three hours later (after the hotstart) it would be -0.25. Six hours after the hotstart it would be -0.5.

At the end of the 15.0 day tidal spinup in this example the bias correction at node 4000 would be 0.1. Three hours later (after the hotstart) it would be 0.0. Six hours after the hotstart it would be -0.1.

==Frequently Asked Questions==
'''Question: '''When writing the &dynamicWaterLevelCorrectionControl namelist, should I write the parameters on a single line, comma separated? 
'''Answer: '''I always put fortran namelist parameters on a single line and separate the assignments with commas, but other formatting may be possible depending on the compiler you are using. Commas has always worked for me, but I've not tried any other way.

'''Question: '''Do I need to ramp the correction, i.e., is it wise to do so for some reason? 
'''Answer: '''It should behave the same as a sudden application of atmospheric pressure forcing, which could lead to (presumably spurious) waves. Our shortest ramp up period is 12 hours but you might get away with 6 hours or even less. We have seen that rapidly ramping in the correction can lead to two outcomes that may be undesirable. One is a strong geostrophic current response. The other is that the water level response can lag behind the correction. This is most common for large water bodies with narrow connections to the open ocean, such as Pamlico Sound in North Carolina. Further details are in Asher et al. 2019<ref name="asher2019"></ref>.

'''Question: '''Does the application of a dynamic water level correction surface affect the velocity solution (not just the elevation solution as it is primarily intended)? 
'''Answer: '''Yes, hopefully in a physically realistic manner. As an example, when applying a water level correction to a back bay area with a nearby tidal inlet, the water level change in the back bay must be reflected in the velocity in the inlet in order to maintain continuity (conservation of mass). In the case of an initial application of a temporally steady water level correction, this velocity effect should be a one-time occurrence. On the other hand, for a time varying water level correction surface, the continuous adjustments to the water level will be continuously reflected in the velocity solution. This should be physically realistic when the water ''should have'' come from offshore, but if the elevated water level is due to rainfall, then the model is directing flow in the wrong direction. Further details are in Asher et al. 2019<ref name="asher2019"></ref>.

==Notes==
<references group="note"/>

==References==
<references />

User:Taylorgasher

2022-06-24T17:36:05Z

Taylorgasher:

My user page

== etc. ==
<nowiki><nowiki>'''not bold text''' ''not italic text'' not ADC version {{ADC version|version=-4E7|relation=ge}} </nowiki></nowiki>

<nowiki>A redirect: #REDIRECT [[Fort.13_file#Nodal_Attributes]]</nowiki>

<nowiki></nowiki>

== syntax highlivin ==
monty
<syntaxhighlight lang="python" line='line'>
def quick_sort(arr):
less = []
pivot_list = []
more = []
if len(arr) <= 1:
return arr
else:
pass
</syntaxhighlight>

fortless
<syntaxhighlight lang="fortran" line='line'>
! I N I T W I N D M O D U L E
! ----------------------------------------------------------------
subroutine initWindModule()
use mesh, only : np
call setMessageSource("initWindModule")
#if defined(WIND_TRACE) || defined(ALL_TRACE)
call allMessage(DEBUG,"Enter.")
#endif
allocate ( wvnx1(np),wvny1(np) )
allocate ( wvnx2(np),wvny2(np) )
allocate ( prn1(np) )
allocate ( prn2(np) )

C well this commenting approach does not work
if(yourMom.eq.fat)then
write(*,*)'ahahahahaha'
endif !looks like this doesn't work
IF((EyeLat(1).EQ.0.D0).OR.(EyeLon(1).EQ.0.D0).OR.
& (EyeLat(2).EQ.0.D0).OR.(EyeLon(2).EQ.0.D0).OR.
& (EyeLat(3).EQ.0.D0).OR.(EyeLon(3).EQ.0.D0))THEN
FoundEye = .FALSE.
ENDIF

!.... tcm v49.16 20100617 added
!.... convert background pressure from millibars to meters of water
PRBCKGRND_MH2O = 100.0D0*PRBCKGRND/(RHOWAT0*G)
prn1 = PRBCKGRND_MH2O
prn2 = PRBCKGRND_MH2O

CALL checkWindDragType()
CALL mapWindDragFunctionPointer()

#if defined(WIND_TRACE) || defined(ALL_TRACE)
call allMessage(DEBUG,"Return.")
#endif
call unsetMessageSource()

! ----------------------------------------------------------------
END SUBROUTINE initWindModule
! ----------------------------------------------------------------
</syntaxhighlight>
== some mats ==
:<math>a_b(c)=\left ( \frac{de^2}{\sqrt[6]{f+\alpha(\beta)}} \right ) ^{\Tau^\tau}</math>



:<math>\{ A \mid A \in \mathbb{E} \land \mathbb{E} - (N \cup R) \} </math>
for <math>A</math> Andrew, <math>\mathbb{E}</math> the entire space, <math>N</math> Nickelback fans, and <math>R</math> Republicans.

== linky ==
<nowiki>[[#test table| link to subsection or anchor in same page]]</nowiki>[[#test table| link to subsection or anchor in same page]]

== test table ==
but

{| class="wikitable"
|-
| apple || pear
|-
| orange || grape
|}

srsly

{| style="background-color: orange; border-style: solid; border-width: 2px"
|-
|
{| style="border-style: solid; border-width: 4px"
| ap || ple
|}
|
{| style="border-style: solid; border-width: 4px"
| pe || ar
|}
|-
|
{| style="border-style: solid; border-width: 4px"
| ora || nge
|}
|
{| style="border-style: solid; border-width: 4px"
| gr || ape
|}
|}

Some norma text

== wind drag in/out notes ==
see email with John, subject line "Outputting wind drag coefficients"

winddrag.173
or
winddrag.173.nc

outputWindDrag=.true.

&metControl

from ncdump -h winddrag.173.nc:

double winddrag(time, node) ;
winddrag:long_name = "wind drag coefficient at sea level" ;
winddrag:standard_name = "wind drag coefficient" ;
winddrag:coordinates = "time y x" ;
winddrag:location = "node" ;
winddrag:mesh = "adcirc_mesh" ;
winddrag:units = "unitless" ;
winddrag:_FillValue = -99999. ;

== test transclus ==


== yup ==
Internal tide energy conversion refers to the energy conversion from barotropic to baroclinic modes as surface tides flow over steep and rough topography in the deep ocean generating internal tides. The "lost" barotropic tidal energy is often accounted for through a linear friction term in large-scale numerical models that are barotropic or not fine-scaled enough to resolve the energy conversion. It is implemented in ADCIRC through a spatially varying [[nodal attribute]] called [[internal_tide_friction]], in the [[fort.13 file]].

== Background and Theory ==
For a review.<ref>C. Garrett, E. Kunze, Internal Tide Generation in the Deep Ocean, Annu. Rev. Fluid Mech. 39 (2007) 57–87. doi:10.1146/annurev.fluid.39.050905.110227.</ref>

How it was known that internal energy conversion is important to the global energy balance of the surface tides.<ref>G.D. Egbert, R.D. Ray, Significant dissipation of tidal energy in the deep ocean inferred from satellite altimeter data, Nature. 405 (2000) 775–778. doi:10.1038/35015531</ref><ref>G.D. Egbert, R.D. Ray, Estimates of M2 tidal energy dissipation from TOPEX/Poseidon altimeter data, J. Geophys. Res. Ocean. 106 (2001) 22475–22502. doi:10.1029/2000JC000699.</ref>

== Attribute Summary ==
In a computational domain covering a large portion of the deep ocean it is critical to include the effect of internal tide energy conversion to obtain more accurate tidal solutions. The user should only elect to use the internal_tide_friction nodal attribute when tides are included in the simulation through tidal boundary conditions and tidal potential functions. The attribute is unnecessary for domains that are small in size and/or do not cover a significant portion of the deep ocean (taken here to mean the portion of the ocean excluding the continental shelf).

ADCIRC reads the internal_tide_friction attribute in as the ''IT_Fric'' variable, which can have 1 (scalar) or 3 (tensor) dimensions. The attribute has dimensions of [1/time], meaning that it is a linear friction term which is multiplied by the velocity in the governing equations, and is normalized by the ocean depth prior to simulation. Hence, it ignores the water surface elevation portion of the total water depth, which is reasonable since the term and theory it is based on is only applicable to deep ocean. Typically, it is only applied to ocean depths greater than 100-500 m.

== Specifying ''IT_Fric'' Values ==
''IT_Fric'' values are determined through analytical formulations based on Bell's linear theory<ref name="Bell1975">{{cite journal|last1=Bell|first1=T.H.|title=Topographically generated internal waves in the open ocean|journal=Journal of Geophysical Research|volume=80|year=1975|pages=320–327|doi=10.1029/JC080i003p00320}}</ref>, valid in what is called sub-critical topography.

Recent publications using ADCIRC<ref>W.J. Pringle, D. Wirasaet, A. Suhardjo, J. Meixner, J.J. Westerink, A.B. Kennedy, S. Nong, Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities, Ocean Model. 129 (2018) 13–38. doi:10.1016/j.ocemod.2018.07.003.</ref><ref>W.J. Pringle, D. Wirasaet, J.J. Westerink, Modifications to Internal Tide Conversion Parameterizations and Implementation into Barotropic Ocean Models, EarthArXiv. (2018) 9. doi:10.31223/osf.io/84w53.</ref> provide relevant formulation and implementation details.

==References==
{{Reflist}}

Fort.15 file format

2022-06-23T19:35:23Z

Taylorgasher: /* Main Controls */ updated formatting in top sections

The basic file structure of the [[fort.15 file]] is shown below. Each line of input data is represented by a line containing the input variable name(s). Inputs in the [[fort.15 file]] must be entered in the exact order shown on this page. '''Blank lines and headings are only to enhance readability.''' Loops indicate multiple lines of input. 
==Main Controls==
===Metadata and Logging===
'''<code>[[RUNDES]]'''</code> - alphanumeric run description 1, 32 characters or less 
'''<code>[[RUNID]]'''</code> - alphanumeric run description 2, 24 characters or less 
'''<code>[[NFOVER]]'''</code> - non-fatal error override option 
'''<code>[[NABOUT]]'''</code> - verbosity of run log output, <code>= -1</code> is debug mode, higher is less output, up to <code>3</code> for errors only 
'''<code>[[NSCREEN]]'''</code> - directs log messages to the screen (<code>> 0</code>), the adcirc.log file (<code>< 0</code>), or disables them (<code>= 0</code>) 


===Numerics & Physics===
'''<code>[[IHOT]]'''</code> - whether to read a hotstart file 
'''<code>[[ICS]]</code>''' - coordinate projection to run in 
'''<code>[[IM]]</code>''' - model run mode 
'''<code>[[IDEN]]</code>''' - density forcing mode, ''include this line only if:'' <code>[[IM]] = 20, 21, 30, 31</code>, or if <code>IM</code>'s last 6-digit entry is > 4 (e.g., <code>513115</code>). 
'''<code>[[NOLIBF]]</code>''' - bottom stress parameterization mode 
'''<code>[[NOLIFA]]</code>''' - finite amplitude term and wetting/drying mode, off if <code>= 0</code> 
'''<code>[[NOLICA]]</code>''' - advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NOLICAT]]</code>''' - time-derivative advection term mode, off if <code>= 0</code>, on if <code>= 1</code> 
'''<code>[[NWP]]</code>''' - number of [[nodal attribute]]s 
''for j=1 to <code>[[NWP]]</code>'' 
: '''<code>[[AttrName(j)]]</code>''' - nodal attributes to use, ''include this line only if:'' <code>[[NWP]] > 0</code> 
''end j loop'' 
'''<code>[[NCOR]]</code>''' - Coriolis control, spatially constant if <code>= 0</code>, varies with latitude if <code>= 1</code> 
'''<code>[[NTIP]]</code>''' - tidal potential forcing control, off if <code>= 0</code> 
'''<code>[[NWS#Value_Seen_in_fort.15_File|NWS]]</code>''' - meteorological, wave, and ice forcing control 
'''<code>[[NRAMP]]</code>''' - forcing ramping control 
'''<code>[[G]]</code>''' - acceleration due to gravity 
'''<code>[[TAU0]]</code>''' - affects numerical diffusion/stability of governing equations 
'''<code>[[Tau0FullDomainMin]] [[Tau0FullDomainMax]]</code>''' - limits on <code>[[TAU0]]</code>, ''include this line only if:''<code>TAU0 = -5.0</code>. 
'''<code>[[DTDP]]</code>''' - model time step (seconds) and predictor-corrector control 
'''<code>[[STATIM]]</code>''' - shifts numeric value of starting simulation time (days) 
'''<code>[[REFTIM]]</code>''' - shifts reference time (days) for tidal harmonic analysis 
'''[[Supplemental_Meteorological/Wave/Ice_Parameters|Meteorological controls including <code>WTIMINC, RSTIMINC</code>]]''' - ''include this line:'' for most cases of <code>NWS ≠ 0</code>, see linked page for details. 
'''<code>[[RNDAY]]</code>''' - end time of simulation (days) 
'''[[Ramping|Ramping controls including <code>DRAMP, FluxSettlingTime</code>]]''' - ''include this line only if:'' <code>NRAMP > 0</code>, see linked page for details 
'''<code>[[A00 B00 C00]]</code>''' - time weighting factors in GWCE 
'''<code>[[H0]]</code>''' - minimum depth, ''include this line only if:'' <code>[[NOLIFA]] = 0</code> or <code>1</code>'' 
'''<code>[[H0]]</code> <code>INTEGER</code> <code>INTEGER</code> <code>[[VELMIN]]</code>''' - alternate minimum depth controls, ''include this line only if:'' <code>[[NOLIFA]] = 2</code> or <code>3</code>'' 
'''<code>[[SLAM0]] [[SFEA0]]</code>''' - longitude and latitude for center of CPP coordinate projection 
'''<code>[[TAU]]</code>''' - linear bottom friction coefficient, ''include this line only if:'' <code>[[NOLIBF]] = 0</code>'' 
'''<code>[[CF]]</code>''' - quadratic bottom friction coefficient or limit, ''include this line only if:'' <code>[[NOLIBF]] = 1</code>'' 
'''<code>[[CF]]</code> <code>[[HBREAK]]</code> <code>[[FTHETA]]</code> <code>[[FGAMMA]]</code>''' - alternate quadratic bottom friction controls, ''include this line only if:'' <code>[[NOLIBF]] = 2</code>'' 
'''<code>[[ESLM]]</code>''' - horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 0</code>, <code>1</code>, or <code>2</code>'' 
'''<code>[[ESLM]]</code> <code>[[ESLC]]</code>''' - alternate horizontal eddy viscosity controls, ''include this line only if:'' <code>[[IM]] = 10</code>'' 
'''<code>[[CORI]]</code>''' - constant Coriolis coefficient, ''only used if'' <code>NCOR=0</code>

===Periodic (Tidal) Body Forcing===
[[NTIF]] 
for k=1 to [[NTIF]]
: [[TIPOTAG(k)]]
: [[TPK(k)]], [[AMIGT(k)]], [[ETRF(k)]], [[FFT(k)]], [[FACET(k)]]
end k loop

===Periodic (Tidal) Boundary Elevations===
[[NBFR]] 
for k=1 to [[NBFR]] 
: [[BOUNTAG(k)]] 
: [[AMIG(k)]], [[FF(k)]], [[FACE(k)]] 
end k loop 
for k=1 to [[NBFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NETA]] 
:: [[EMO(k,j), EFA(k,j)]] 
: end j loop 
end k loop

===Periodic (Tidal) Boundary Velocities===
[[ANGINN]] 
[[NFFR]] - include this line only if [[IBTYPE]] = 2, 12, 22, 32 or 52 in the Grid and Boundary Information File 
for k=1 to [[NFFR]] 
: [[FBOUNTAG(k)]] 
: [[FAMIGT(k),FFF(k),FFACE(k)]] 
end k loop 
for k=1 to [[NFFR]] 
: [[ALPHA(k)]] 
: for j=1 to [[NVEL]] 
:: [[QNAM(k,j), QNPH(k,j)]] - use this line if [[IBTYPE]] = 2, 12, 22 in the Grid and Boundary Information File 
:: [[QNAM(k,j), QNPH(k,j)]], [[ENAM(k,j), ENPH(k,j)]] - use this line if [[IBTYPE]] = 32 in the Grid and Boundary Information File 
:end j loop 
end k loop

===Model Output===
[[NOUTE]], [[TOUTSE]], [[TOUTFE]], [[NSPOOLE]] 
[[NSTAE]] 
for k=1 to [[NSTAE]] 
: [[XEL(k), YEL(k)]] - use these lines if [[NSTAE]] is positive. If negative, stations are listed in the [[elev_stat.151]] file 
end k loop 
[[NOUTV]], [[TOUTSV]], [[TOUTFV]], [[NSPOOLV]] 
[[NSTAV]] 
for k=1 to [[NSTAV]] 
: [[XEV(k), YEV(k)]] - use these lines if [[NSTAV]] is positive. If negative, stations are listed in the [[vel_stat.151]] file 
end k loop 
[[NOUTC]], [[TOUTSC]], [[TOUTFC]], [[NSPOOLC]] - include this line only if IM =10 
[[NSTAC]] - include this line only if IM =10 
for k=1 to [[NSTAC]] 
: [[XEC(k), YEC(k)]] 
end k loop 
[[NOUTM]], [[TOUTSM]], [[TOUTFM]], [[NSPOOLM]] - include this line only if NWS is not equal to zero. 
[[NSTAM]] - include this line only if NWS is not equal to zero. 
for k=1 to [[NSTAM]] 
: [[XEM(k), YEM(k)]] - use these lines if [[NSTAM]] is positive. If negative, stations are listed in the [[met_stat.151]] file 
end k loop 
[[NOUTGE]], [[TOUTSGE]], [[TOUTFGE]], [[NSPOOLGE]] 
[[NOUTGV]], [[TOUTSGV]], [[TOUTFGV]], [[NSPOOLGV]] 
[[NOUTGC]], [[TOUTSGC]], [[TOUTFGC]], [[NSPOOLGC]] - include this line only if IM =10 
[[NOUTGW]], [[TOUTSGW]], [[TOUTFGW]], [[NSPOOLGW]] - include this line only if NWS is not equal to zero.

====Harmonic Analysis====
[[NFREQ]] 
for k=1 to [[NFREQ]] 
: [[NAMEFR(k)]] 
: [[HAFREQ(k), HAFF(k), HAFACE(k)]] 
end k loop 
[[THAS]], [[THAF]], [[NHAINC]], [[FMV]] 
[[NHASE]], [[NHASV]], [[NHAGE]], [[NHAGV]]

====Hotstart Output and Numeric Controls====
[[NHSTAR]], [[NHSINC]] 
[[ITITER]], [[ISLDIA]], [[CONVCR]], [[ITMAX]] 

''For a 2DDI ADCIRC run that does not use netCDF nor namelists, the file ends here. For those controls, see further below in the [[#NetCDF Controls|NetCDF Controls]] and [[#Namelists|Namelists]] sections.''

==3D Model Run==
[[IDEN]] 
[[ISLIP]], [[KP]] 
[[Z0S,Z0B]] 
[[ALP1,ALP2,ALP3]] 
[[IGC]], [[NFEN]] 
for k=1 to [[NFEN]] (include this loop only if [[IGC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[SIGMA(k)]] 
end k loop 
[[IEVC]], [[EVMIN]], [[EVCON]] 
for k=1 to [[NFEN]] (include this loop only if [[IEVC]] = 0, k=1 at bottom, k= [[NFEN]] at surface) 
: [[EVTOT(k)]] 
end k loop 
[[THETA1, THETA2]](include this line only if [[IEVC]] = 50 or 51) 
[[I3DSD,TO3DSDS,TO3DSDF,NSPO3DSD]] 
[[NSTA3DD]] 
for k=1 to [[NSTA3DD]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DSV,TO3DSVS,TO3DSVF,NSPO3DSV]] 
[[NSTA3DV]] 
for k=1 to [[NSTA3DV]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DST,TO3DSTS,TO3DSTF,NSPO3DST]] 
[[NSTA3DT]] 
for k=1 to [[NSTA3DT]] 
: [[X3DS(k), Y3DS(k)]] 
end k loop 
[[I3DGD]],[[TO3DGDS]],[[TO3DGDF]],[[NSPO3DGD]] 
[[I3DGV]],[[TO3DGVS]],[[TO3DGVF]],[[NSPO3DGV]] 
[[I3DGT]],[[TO3DGTS]],[[TO3DGTF]],[[NSPO3DGT]] 
The following line will be read in if [[IM]] is 21 or 31. 
[[RES_BC_FLAG]], [[BCFLAG_LNM]], [[BCFLAG_TEMP]] 
The following two lines will be read in if [[RES_BC_FLAG]] is negative. 
[[RBCTIMEINC]] 
[[BCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 2. 
[[RBCTIMEINC]], [[SBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3. 
[[RBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 4. 
[[RBCTIMEINC]], [[SBCTIMEINC]], [[TBCTIMEINC]] 
[[BCSTATIM]], [[SBCSTATIM]], [[TBCSTATIM]] 
The following two lines will be read in if [[RES_BC_FLAG]] = 3 or 4 and [[BCFLAG_TEMP]] is not equal to 0. 
[[TTBCTIMEINC]], [[TTBCSTATIM]] 
[[TTBCTIMEINC]] 
The following two lines will be read in only if [[IM]] is 21 or 31. 
[[SPONGEDIST]] 
[[EQNSTATE]] 
The following lines will be read in only if [[IDEN]] is > 0. 
[[NLSD, NVSD]] 
[[NLTD, NVTD]] 
[[ALP4]] 
The following line will be read in only if [[IDEN]] = 3 or 4. 
[[NTF]]

==NetCDF Controls==
The following lines will be read in only if the NetCDF output or hotstart format is chosen 
NCPROJ 
NCINST 
NCSOUR 
NCHIST 
NCREF 
NCCOM 
NCHOST 
NCCONV 
NCCONT 
NCDATE

==Namelists==
The following Fortran namelist lines are optional, but if they appear, they must appear at the very end of the fort.15 file. 
<code>&metControl WindDragLimit=floatValue, DragLawString='stringValue', rhoAir=floatValue, outputWindDrag=logicalValue /</code> 
<code>&timeBathyControl NDDT=integerValue, BTIMINC=floatValue, BCHGTIMINC=floatValue /</code> 
<code>&waveCoupling WindWaveMultiplier=floatValue /</code> 
<code>&SWANOutputControl SWAN_OutputHS=logicalValue, SWAN_OutputDIR=logicalValue, SWAN_OutputTM01=logicalValue, SWAN_OutputTPS=logicalValue, SWAN_OutputWIND=logicalValue, SWAN_OutputTM02=logicalValue, SWAN_OutputTMM10=logicalValue /</code> 
<code>&subdomainModeling subdomainOn=logicalValue/</code> 
<code>&wetDryControl outputNodeCode=logicalValue, outputNOFF=logicalValue, noffActive=logicalValue /</code> 
<code>&inundationOutputControl inundationOutput=logicalValue0, inunThresh =floatValue /</code> 
<code>&TVWControl use_TVW=logicalValue, TVW_file='stringValue', nout_TVW =integerValue, touts_TVW =floatValue, toutf_TVW=floatValue, nspool_TVW =integerValue /</code> 
<code>&WarnElevControl WarnElev=floatValue, ErrorElev=floatValue, WarnElevDump=logicalValue, WarnElevDumpLimit=integerValue /</code> 
<code>[[Dynamic_water_level_correction#Controlling_Water_Level_Correction|&dynamicWaterLevelCorrectionControl]] dynamicWaterLevelCorrectionFileName='stringValue' dynamicWaterLevelCorrectionMultiplier=floatValue, dynamicWaterLevelCorrectionRampStart=floatValue, dynamicWaterLevelCorrectionRampEnd=floatValue, dynamicWaterLevelCorrectionRampReferenceTime='stringValue', dynamicWaterLevelCorrectionSkipSnaps=integerValue /</code> 
<code>&[[AliDispersionControl]] CAliDisp=logicalValue, Cs=floatValue, Ad=floatValue, Bd=floatValue /</code> 
[[category:input files]]

Fort.15 file

2022-06-23T19:13:21Z

Taylorgasher: /* Ramping Meteorological Forcing at Hot-Start */

This file contains the majority of the parameters required to run both the 2DDI and 3D versions of ADCIRC and the information to drive the model with harmonic boundary conditions (either elevation or flux). This file is required to run the ADCIRC model.

== File Format ==
See [[fort.15 file format]] for details.

== Tips and Tricks ==
=== Meteorological-Only Mode ===
By turning off all ocean state-related outputting and disabling wave coupling, ADCIRC will run in "met.-only" mode, a quick and convenient way to read in and write out meteorological data files. In this mode, only routines necessary for meteorological forcing are called, i.e. no water levels nor velocities are computed. Note that by changing <code>DT</code>, you can speed up this "simulation". More specifically, since the only things being output are meteorological data, you can set <code>DT</code> equal to the time interval you wish met. data to be output, and then set the <code>[[NSPOOLM]]</code> and/or <code>[[NSPOOLGW]]</code> (the local and global met. output intervals) to <code>1</code> (i.e. output every time step). For typical 2D ADCIRC runs, this requires setting the following in the fort.15 file: 
<code>[[NOUTE]] = 0</code> 
<code>[[NOUTV]] = 0</code> 
<code>[[NOUTGE]] = 0</code> 
<code>[[NOUTGV]] = 0</code> 
<code>[[NHSTAR]] = 0</code> 
<code>[[NHASE]] = 0</code> 
<code>[[NHASV]] = 0</code> 
<code>[[NHAGE]] = 0</code> 
<code>[[NHAGV]] = 0</code> 

For passive scalar transport (<code>[[IM]] = 10</code>), also set: 
<code>[[NOUTC]] = 0</code> 
<code>[[NOUTGC]] = 0</code> 

while for barotropic or baroclinic 3D ADCIRC, also set: 
<code>[[I3DSD]] = 0</code> 
<code>[[I3DSV]] = 0</code> 
<code>[[I3DST]] = 0</code> 
<code>[[I3DGD]] = 0</code> 
<code>[[I3DGV]] = 0</code> 
<code>[[I3DGT]] = 0</code> 

=== Ramping Meteorological Forcing at Hot-Start ===
It is generally best to [[ramping]] in forcing terms to the model to avoid shocking the system, but ramping parameters like <code>[[DRAMP]]</code> define the start of ramp time as being cold-start time. Since it is common-place to initialize meteorological forcing at hotstart time, there is a special parameter to facilitate hotstart ramping of met. data. Let's say you run a 15-day tide-only run and output a hotstart file. Setting 
<code>[[NRAMP]] = 8</code> 
means you can supply <code>[[DRAMPUnMete]]</code>, which is the number of delays at which to start met. ramping, on the <code>DRAMP</code> line. Here's an example: 
<code>5 0 0 0 0 0 0.5 0 15 ! DRAMP, DRAMPExtFlux, FluxSettlingTime, DRAMPIntFlux, DRAMPElev, DRAMPTip, DRAMPMete, DRAMPWRad, DRAMPUnMete</code> 
What this says is that a 0.5-day ramp will be applied to the met. forcing, starting at run day 15.0 (the hotstart simulation's start time).

[[Category:input files]]

Global Storm Tide - Hurricane Katrina

2022-06-23T19:01:12Z

Taylorgasher: added test cases category

This example tests ADCIRC version 55 (and beyond). It tests the simulation of the storm tides on the spherical Earth under astronomical and atmospheric forcing during August 2005 when Hurricane Katrina impacted the Gulf of Mexico. The results of interest are the global elevations, velocities and meteorology. The test finishes in about 5 minutes in serial ADCIRC for a full month of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_global-tide%2Bsurge-2d GitHub test suite].

== Mesh ==
The mesh is a coarse representation of the spherical Earth with minimum resolution of approximately 50 km, comprised of 27,330 vertices and 50,859 triangular elements.

== Options/Features Tested ==
*<code>[[ICS]]</code> = -22: Uses the Mercator projection with a coordinate rotation to remove the pole singularity (need to provide a [[fort.rotm]]).
*<code>[[IM]]</code> = 513113: Uses the fully implicit scheme for the gravity wave term (computational time step is 12 minutes).
*<code>[[NTIP]]</code> = 2: Equilibrium tide + self-attraction and loading tide (read from a [[fort.24 file]]) forcing for 10 tidal constituents.
*<code>[[NWS]]</code> = -14: Reads from GRIB2 files that specify the global atmospheric forcing (6-hourly CFS reanalysis data) in addition to OWI ASCII files that specify the 3-hourly atmospheric forcing in the Hurricane Katrina landfall region.
*<code>[[WTIMINC]]</code> = 21600, 10800: First value gives the temporal interval of the GRIB2 met data (6 hours), second value gives the temporal interval of the OWI met data (3 hours) in seconds.
*<code>[[A00, B00, C00]]</code> = 0.5, 0.5, 0: Ensures that the fully implicit scheme is stable with a large time step.
*<code>[[ESLM]]</code> = -0.2: Enables the Smagorinsky turbulence closure with a coefficient of 0.2.
*<code>[[NOUTGE]]</code> = 5: Outputs the global elevations into a netCDF4 [[fort.63 file]].
*<code>[[NOUTGV]]</code> = 5: Outputs the global velocities into a netCDF4 [[fort.64 file]].
*<code>[[NOUTGM]]</code> = 5: Outputs the global meteorology into a netCDF4 [[fort.73 file]] (pressure) and a netCDF4 [[fort.74 file]] (velocity).
*[[fort.13_file#Internal_Tide_Energy_Conversion|internal_tide_friction]]: Spatially varying linear wave drag [[fort.13 file]] attribute accounting for energy conversion due to internal tide generation in the deep ocean.
*[[fort.13_file#Quadratic_Friction_coefficient|quadratic_friction_coefficient]]: Spatially varying quadratic bottom friction [[fort.13 file]] attribute.

[[Category:test cases]]

Fort.22 file

2021-11-30T14:43:30Z

Taylorgasher: Added NWS = 30 info

A single meteorological input file (wind velocity and atmospheric pressure) is read when meteorological forcing has been indicated by the <code>[[NWS]]</code> parameter in the [[fort.15 file]]. More precisely, the format of and need for the fort.22 file depend on the ones and tens (i.e. the last 2) digits and the sign (positive/negative) of <code>NWS</code> (see [[NWS#Value_Seen_in_fort.15_File|here]]). See also the [[supplemental meteorological/wave/ice parameters]] and [[wind stress]] pages.

== General Notes ==
Unless otherwise specified for a given format, ADCIRC expects wind data to represent [[Wind_Stress#Definition_of_Winds|specific conditions]] and pressure data to be sea level pressure. Where necessary, ADCIRC assumes a "background" atmospheric pressure of 1013 millibars.

Meteorological data in most formats must be provided for the entire model run, otherwise the run will crash. Exceptions include OWI (<code>NWS=12</code>) and GFDL (<code>NWS=16</code>).

For most formats, latitude and longitude coordinates describing the spatial extents of the meteorological data must follow the convention of the ADCIRC model domain. For example, if the [[fort.14 file|mesh]] uses negative longitude values to indicate locations West of the Greenwich meridian, the meteorological file must be similarly organized. Any grid that crosses the Greenwich Meridian should be organized so that the seam occurs at 180 deg longitude. Therefore, the meteorological and ADCIRC grids should use negative longitudes West of the Greenwich Meridian and positive longitudes to the East.

== File Format ==
The remainder of this page is devoted to the formats of the fort.22 file for the different values of <code>NWS</code>. Each line of input data is represented by a line containing the input variable name(s). Blank lines are only to enhance readability. Loops indicate multiple lines of input. Conditional input is indicated by an if clause.

==NWS = 1 Wind Stress & Pressure at All Nodes and Timesteps==

===File Structure===

for k=1,[[NP]]

: [[JN]], [[WSX(k), WSY(k)]], [[PRN(k,j)]]

end k loop

===Notes===

Meteorological data is input directly to all nodes in the ADCIRC grid.

The units for pressure are meters of water.

The first set of met. data corresponds to <code>TIME=[[STATIM]]+[[DTDP]]</code>. Additional sets of met data must be provided at every time step, <code>([[WTIMINC]] = [[DTDP]])</code>.

Wind stress must be input in units of velocity squared (consistent with the units of gravity) and surface atmospheric pressure must be input in units of equivalent height of water (e.g., meters of water, feet of water that are consistent with the units of gravity). Stress in these units is obtained by dividing stress in units of force/area by the reference density of water. Pressure in these units is obtained by dividing pressure in units of force/area by the gravitational constant and the reference density of water. For example, 10^5Pa =10^5 N/m^2 =10^5 kg m/(s m)^2 divided by 9.81 m/s^2 and 10^3 kg/m^3 equals 10.2 meters of water.

==NWS = ±2 Wind Stress & Pressure at All Nodes and Specified Time Interval==

===File Structure===
for k=1, NP

: [[JN]], [[WSX(k), WSY(k)]], [[PRN(k,j)]]

end k loop

===Notes===

Meteorological data is input directly to all nodes in the ADCIRC grid.

The units for pressure are meters of H2O.

If <code>[[NWS]]=2</code>, the first set of met. data corresponds to <code>TIME=[[STATIM]]</code>. If <code>NWS=-2</code>, the first set of met data corresponds to <code>TIME=HOT START TIME</code>. Additional sets of met. data must be provided every <code>[[WTIMINC]]</code>, where <code>[[WTIMINC]]</code> is the met. data time interval and is specified in the Model Parameter and Periodic Boundary Condition File. Met data is interpolated in time to the ADCIRC time step.

Wind stress must be input in units of velocity squared (consistent with the units of gravity) and surface atmospheric pressure must be input in units of equivalent height of water (e.g., meters of water, feet of water that are consistent with the units of gravity).Stress in these units is obtained by dividing stress in units of force/area by the reference density of water. Pressure in these units is obtained by dividing pressure in units of force/area by the gravitational constant and the reference density of water. For example,

<code>10^5Pa =10^5 N/m^2 =10^5 kg m/(s m)^2 divided by 9.81 m/s^2 and 10^3 kg/m^3 equals 10.2 meters of water</code>

==NWS = 3 Fleet Numeric Format==

===File Structure===

[[IWTIME]]

for k = 1,[[NWLAT]]

: for j = 1,[[NWLON]]

:: [[WSPEED(k,j)]]

: end j loop

end k loop

for k = 1, NWLAT

: for j = 1, NWLON

:: [[WDIR(k,j)]]

: end j loop

end k loop

===Notes===

Meteorological data is input to a longitude, latitude grid and interpolated in space onto the ADCIRC grid.The ADCIRC grid must be in lon, lat coordinates.

The first set of met. data must be at or before the date and time listed in the Model Parameter and Periodic Boundary Condition File as the beginning time of the simulation. Additional sets of met. data must be provided every <code>WTIMINC</code>, where <code>[[WTIMINC]]</code> is the met. data time interval.Values for <code>[[NWLAT]], [[NWLON]], [[WTIMINC]]</code>, and several other parameters must be set in the Model Parameter and Periodic Boundary Condition File. Met data is interpolated in time to the ADCIRC time step.

Wind velocity (@ 10 m above the water surface) must be input in units of m/s (regardless of the units of gravity).

The following relations are used to compute wind stress from the input wind velocity.

<code>WIND_SPEED = magnitude of WIND_VEL</code>

<code>DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)</code>

<code>If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003</code>

<code>WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED</code>

==NWS = ±4 PBL Hurricane Model format==

Meteorological data is input directly to a subset of nodes in the ADCIRC grid (as specified by the node number JN).The ADCIRC grid must be either in lon, lat coordinates or in meter-based Cartesian coordinates.

===File Structure===

FOR EACH WIND TIME INCREMENT

: DO UNTIL LINE = ” #”

:: [[JN]], [[WVNX(JN), WVNY(JN)]], [[PRN(k,j)]]

: END DO UNTIL

END FOR EACH

===Notes===

If <code>[[NWS]] = 4</code>, the first set of met. data corresponds to <code>TIME=[[STATIM]]</code>. If <code>[[NWS]] = -4</code>, the first set of met data corresponds to <code>TIME=HOT START TIME</code>. Additional sets of met. data must be provided every <code>[[WTIMINC]]</code>, where <code>[[WTIMINC]]</code> is the met. data time interval and is specified in the Model Parameter and Periodic Boundary Condition File. Met data is interpolated in time to the ADCIRC time step.

Each data line must have the format I8, 3E13.5. Data input lines are repeated for as many nodes as desired. A line containing the # symbol in column 2 indicates met data at the next time increment begins on the following
line. At each new time, any node that is not specified in the input file is assumed to have zero wind velocity and pressure = 1013.

Wind velocity (assumed to be 10m 10 minute averaged value) must be input in knots and surface atmospheric pressure must be input in hundredths of a millibar.

The following relations are used to compute wind stress from wind velocity:

<code>WIND_VEL{m/s @ 10m} = WIND_VEL{knots @ bl average}*0.5144</code> (In prior ADCIRC versions, an additional factor of 1.04 was included in the formulation to convert from 30 minute avg winds to 10 minute avg winds. This factor was removed and it is currently assumed that the input wind data uses a 10 minute averaging period. Note, this is unrelated to the value of WTIMINC).

<code>WIND_SPEED = magnitude of WIND_VEL</code>

<code>DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)</code>

<code>if(DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003</code>

<code>WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED</code>

The following relationship is used in ADCIRC to convert to pressure in meters of water from pressure in hundredths of a millibar:

<code>PRESSURE{m H2O}=PRESSURE{Pa/100}*100/(GRAVITY*DENSITY H2O)</code>

==NWS = ±5 Wind Velocity & Pressure at All Nodes and Specified Time Interval==

===File Structure===

for k = 1, NP

: [[JN]], [[WVX(k), WVY(k)]], [[PRN(k,j)]]

end k loop

===Notes===

Meteorological data is input directly to all nodes in the ADCIRC grid.The ADCIRC grid must be either in lon, lat coordinates or in meter-based Cartesian coordinates.

If <code>[[NWS]]=5</code>, the first set of met. data corresponds to <code>TIME=[[STATIM]]</code>. If <code>[[NWS]]=-5</code>, the first set of met data corresponds to <code>TIME=HOT START TIME</code>. Additional sets of met. data must be provided every <code>[[WTIMINC]]</code>, where <code>[[WTIMINC]]</code> is the met. data time interval and is specified in the Model Parameter and Periodic Boundary Condition File. Met data is interpolated in time to the ADCIRC time step.

Wind velocity (@ 10 m above the water surface) must be input in m/s and surface atmospheric pressure must be input in meters of water.

The following relations are used to compute wind stress from wind velocity:

<code>WIND_SPEED = magnitude of WIND_VEL</code>

<code>DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)</code>

<code>if(DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003</code>

<code>WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED</code>

==NWS = 6 Wind Velocity and Pressure on Rectangular Grid==

===File Structure===

for k=1, NWLAT

: for j=1, NWLON

:: [[WVXFN(k,j), WVYFN(k,j)]], [[PRN(k,j)]]

: end j loop

end k loop

===Notes===

In versions 43 and earlier the format of input was P, U, V. The input has now changed to U, V, P to be consistent with other NWS formats.

Meteorological data is input on a rectangular grid (either in Longitude, Latitude or Cartesian coordinates, consistent with the grid coordinates) and interpolated in space onto the ADCIRC grid. In setting up the meteorological grid it is assumed that y (e.g., latitude) varies from north (<code>k=1</code>) to south (<code>k=[[NWLAT]]</code>) and x (e.g., longitude) varies from west (<code>j=1</code>) to east (<code>j=[[NWLON]]</code>). The spatial extents of the meteorological grid must be consistent with the ADCIRC model domain. For example, if ADCIRC uses negative longitude values to indicate locations W of the Greenwich meridian, the meteorological file must be similarly organized. Any grid that crosses the Greenwich Meridian should be organized so that the seam occurs @ 180 deg longitude. Therefore, the meteorological and ADCIRC grids should use negative longitudes W of the Greenwich Meridian and positive longitudes to the E.

The meteorological grid MUST cover the entire ADCIRC mesh; that is, '''the ADCIRC mesh must be entirely within the meteorological grid''' or an error will result.

The first set of met. data corresponds to the beginning time of the current simulation. If the model is cold started this corresponds to <code>TIME=[[STATIM]] </code>. If the model is hot started, this corresponds to <code>TIME=HOT START TIME</code>. Additional sets of met. data must be provided every <code>[[WTIMINC]]</code>, where <code>[[WTIMINC]]</code> is the met. data time interval.Values for <code>[[NWLAT]], [[NWLON]], [[WTIMIN]]C</code>, and several other parameters must be set in the [[fort.15_file_format|fort.15 file]]. Met data is interpolated in time to the ADCIRC time step.

Wind velocity (@ 10 m above the water surface) must be input in units of m/s and surface atmospheric pressure must be input in units of Pascals = Newtons/square meter.

The following relations are used to compute wind stress from the input wind velocity.

<code>WIND_SPEED = magnitude of WIND_VEL</code>

<code>DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)</code>

<code>If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003</code>

<code>WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED</code>

The following relationship is used in ADCIRC to convert to pressure in meters of water from pressure in Pascal:

<code>PRESSURE{m H2O}=PRESSURE{Pascal}/(GRAVITY*DENSITY H2O)</code>

==NWS = ±7 Wind Stress and Pressure on Rectangular Grid==
'''This format has not been fully implemented, though it is expected in v55.'''{{ADC version|version=?55?|relation=ge}}

===File Structure===
for k=1, NWLAT

: for j=1, NWLON

:: WVXFN(K,J),WVYFN(K,J),PRN(K,J)

: END DO

END DO

=== Notes ===

==NWS = 8 Dynamic Symmetric Holland Vortex Model==

===File Structure===
Use the [https://www.nrlmry.navy.mil/atcf_web/docs/database/new/abrdeck.html ATCF Best Track/Objective Aid/Wind Radii Format].

===Notes===
Hurricane parameters are read in from the Single File Meteorological Forcing Input File. Wind velocity and atmospheric pressure are calculated at every node on the fly by ADCIRC internally using the Dynamic Holland model. The input file is fixed width (not comma separated values or csv) and is assumed to correspond to the <code>ATCF Best Track/Objective Aid/Wind Radii Format</code>. Historical tracks, real-time hindcast tracks and real-time forecast tracks may be found in this format. Selecting <code>[[NWS]] = 8</code> also requires the specification of the cold start time, storm number, and boundary layer adjustment (see <code>[[YYYY MM DD HH24 StormNumber BLAdj]]</code>). Garret’s formula is used to compute wind stress from the wind velocity.

The symmetric vortex model (<code>[[NWS]]=8</code>) in ADCIRC assumes that the longitudes in the fort.22 are west longitude, so it multiplies the longitude values by -1. It ignores the ‘E’ or ‘W’ in the longitude column of the fort.22.

The symmetric vortex model (<code>[[NWS]]=8</code>) does not use any of the isotach wind speeds or wind radii data. When reading lines labeled “BEST” from the fort.22, it obtains timing information from the year, month, day, and hour in column 3. When reading lines labeled “OFCL” from the fort.22, it uses the forecast increment (a.k.a. TAU) from column 6. The use of these two different columns by ADCIRC <code>[[NWS]]=8</code> is to maintain consistency with the official file structure for the ATCF file format.

For <code>[[NWS]]=8</code>, ADCIRC knows the current time because the user provides the year, month, day, and hour of cold start on the <code>[[WTIMINC]]</code> line in your fort.15. It also has the time that has elapsed since cold start, because that is provided in the hotstart file, if any. It then compares the current time with the date/times in the fort.22 (as described in the previous paragraph) to automatically find the right place to begin reading data from the fort.22.

So, in summary, if the whole fort.22 consists of “BEST” lines, the symmetric vortex model (<code>NWS=8</code>) only looks at column 3 for time information. And it automatically knows where to start reading cyclone data, based on the coldstart date/time the user provides in the fort.15 file.

==NWS = 9 Asymmetric Holland Vortex Model==
'''This has been deprecated and is no longer available.''' {{ADC version|version=???|relation=lt}}

==NWS = 10 National Climatic Data Center GFS==
It appears there is no fort.22 file for this format, and users should consult the [[fort.200]] page, but this hasn't been confirmed. 

Wind velocity and atmospheric pressure are read in from a sequence of National Weather Service (NWS) Aviation (AVN) model output files. Each AVN file is assumed to contain data on a Gaussian longitude, latitude grid at a single time.

===File Structure===

for k=1, [[LONB*LATB]]

: [[PG(k)]], [[UG(k)]], [[VG(k)]]

end j loop

==NWS = 11 Stripped National Weather Service (NWS) ETA 29km==
It appears there is no fort.22 file for this format, and users should consult the [[fort.200]] page, but this hasn't been confirmed. 

Wind velocity (10 m) and atmospheric pressure are read in from a sequence of stripped down National Weather Service (NWS) ETA 29km model output files.

===File Structure===

for k=1, LONB*LATB

: PG(k), UG(k), VG(k)

end j loop

==NWS = ±12 Oceanweather ASCII Format Gridded Wind and Pressure==

Oceanweather Inc (OWI) ASCII "WIN"/"PRE" format , details can be found at [[NWS12]]

==NWS = 13 Oceanweather NetCDF Format Gridded Wind and Pressure==

Oceanweather Inc (OWI) NetCDF format , details can be found at [[NWS13]] {{ADC version|version=55|relation=ge}}

==NWS = ±14 Gridded GRIB2 or NetCDF Wind and Pressure==
When using NetCDF files (fort.221.nc, fort.222.nc) as met inputs, the fort.22 is required in order to list the relevant variable names so that the internal NetCDF read routines can find the pertinent variables. In the case of GRIB2 input files (fort.221.grb2, fort.222.grb2) the fort.22 is not required because the variable names are standardized and on start-up the internal wgrb2api library prints out inventory look-up files (*.inv) that it uses to find the information contained within the *.grb2 files. {{ADC version|version=55|relation=eq}}

===File Structure===
Temporal dimension name 
Datetime variable name 
Format of the datetime time variable [special note, if first character is not a '%' then it will ignore this variable and will assume to start from the first time snap] 
Zonal (east-west) dimension name 
Longitude variable name 
Meridional (north-south) dimension name 
Latitude variable name 
Sea-level Pressure variable name 
Zonal 10-m Wind Velocity name 
Meridional 10-m Wind Velocity name 
Ice area-fraction name [optional, only if fort.225.nc present for ice area fraction]

===Example (WRF output)===
Time 
Times [if no datetime variable then set to dummy such as 'none'] 
%Y-%m-%d_%H:%M:%S [if no datetime variable then set to dummy such as 'none'] 
west_east 
XLONG 
south_north 
XLAT 
PSFC 
U10 
V10 
aice [optional] 

===Notes===
If the time variable is not in a datetime format (e.g., is a float in minutes since..) the datetime format can be set to a dummy name, e.g., 'minutes'. The code checks to see if the first character of the datetime format is '%'. If not the code will assume to simply begin reading from the first time snap. If the datetime variable is available the code will work out which time snap to start reading from based on the reference date, [[NCDATE]] located near or at the bottom of the [[fort.15 file]].

==NWS = 15 H*Wind Gridded Wind and Inferred Pressure==
The goal of the implementation of the HWind capability within ADCIRC was to allow HWind files to be used as-is, without resorting to an intermediate format. As a result, the fort.22 file consists of a header line to provide some configuration parameters, and then a list of the filenames of the HWind files to be used in the ADCIRC run.

===File Structure===

comment line

[[hWindMultiplier]]

[[presssureWindRelationship]]

for i=1 to numHWindFiles

: [[hours(i)]] [[centralPressure(i)]] [[rampMult(i)]] [[filename(i)]]

end i loop

===Notes===
HWind files are data assimilated snapshots of the wind velocity fields of tropical cyclones that were produced by the NOAA Hurricane Research Division (HRD) through 2013, before becoming a private sector data product. The files have the following characteristics:

<code>the format explicitly indicates the center of the storm</code>

<code>the (u,v) data are on a regular grid</code>

<code>the regular grid is a mercator projection with origin at storm center</code>

<code>the mercator grid spacing is in meters and is uniform in x and y (dx=dy)</code>

<code>the dimensions (nx,ny) of the mercator grid are equal (nx=ny)</code>

<code>the grid dimensions change from snapshot to snapshot; for example, the first shapshot may be 161×161 while the 2nd snapshot may be 121×121 (etc)</code>

<code>sequential hwind snapshots will not be evenly spaced in time for a particular storm</code>

H*Wind data do not contain barometric pressure information. For the dvorak, knaffzehr, and specified Pc options, the barometric pressure field is computed by determining the radius to maximum winds Rmax (i.e., the distance of Vmax from the center of the storm), calculating the Holland B parameter, and then using the Holland formulation to calculate barometric pressure as a function of the distance from the center of the storm.

To illustrate the definitions and descriptions provided, a concrete example of an HWind fort.22 file is provided as follows:

<code>! first line is a comment line, max length 1024 characters</code>

<code>1.0 ! 2nd line is a velocity magnitude multiplier</code>

<code>dvorak ! 3rd line: one word for the pressure-wind relationship</code>

<code>0.0 -1 0.0 “/home/jason/hwind/al092011_0828_1330” ! time (hours), Pc (mb), ramp mult, filename</code>

<code>6.0 -1 0.5 “/home/jason/hwind/al092011_0828_1930”</code>

<code>12.0 -1 1.0 “/home/jason/hwind/al092011_0829_0130”</code>

==NWS = 16 ASCII NOAA GFDL Gridded Wind And Pressure==
The GFDL input capability uses GFDL model output files as-is; as a result, the fort.22 file consists of a list of GFDL model output files to be used in ADCIRC.

===File Structure===

comment line

[[GFDLWindMultplier]]

[[MaxExtrapolationDistance]]

for i=1 to numGFDLFiles

: [[hours(i)]] [[rampMult(i)]] [[filename(i)]]

end i loop

===Notes===

GFDL model output files are produced by the Geophysical Fluid Dynamics Laboratory at NOAA. Each ASCII GFDL model output file contains one or more nested grid dataset where the nested grids are allowed to change in time. Coarse grid data is not stored where finer nest data is given. The files are formatted as follows:

<code>Line 1: Number of grid cells (f10.4) NCELLS</code>

<code>Lines 2 through NCELLS+1: Ten columns of data formatted as 10f10.4 as follows:</code>

<code>column 1: u (m/s)</code>

<code>column 2: v (m/s)</code>

<code>column 3: Temperature (K)</code>

<code>column 4: mixing ratio(kg/kg)</code>

<code>column 5: storm accum precipitation (cm)</code>

<code>column 6: sea level pressure (hPa)</code>

<code>column 7: longitude (decimal deg)</code>

<code>column 8: latitude (decimal deg)</code>

<code>column 9: hurricane hour</code>

<code>column 10: nest number (this is not always present)</code>

To illustrate the definitions and descriptions provided, a concrete example of a GFDL fort.22 file is provided as follows:

<code>! first line is a comment line, max length 1024 characters</code>

<code>1.0 ! 2nd line is a velocity magnitude multiplier</code>

<code>100.0 ! 3rd line: maximum extrapolation distance (m)</code>

<code>0.0 -1 0.0 “/home/jason/hwind/al092011_0828_1330″ ! time (hours), Pc (mb), ramp mult, filename</code>

<code>6.0 -1 0.5 “/home/jason/hwind/al092011_0828_1930″</code>

If the ADCIRC time falls outside the interval of time covered by the GFDL model output files, ADCIRC will insert “blank snaps”, i.e., it will set the wind velocity at all mesh vertices to 0.0 m/s and the barometric pressure to a uniform background pressure of 1013mb.

==NWS = 19 Dynamic Asymmetric Holland Vortex Model==
'''Note that use of this [[Typical_ADCIRC_Parameter_Selections#Discouraged_Parameter_Selections|is discouraged]].'''

===File Structure===
The file needs to be in the [https://www.nrlmry.navy.mil/atcf_web/docs/database/new/abrdeck.html ATCF Best Track/Objective Aid/Wind Radii Format].

===Notes===
User has the ability to select which isotach to use in each of the 4 quadrants. User also has ability to modify <code>RMAX</code> and <code>Holland’s B parameter</code> using the ASWIP program. The auxiliary preprocessing program ASWIP.F (located in the /wind directory and executable is created by typing, make aswip, in the work folder after adcirc executable has been generated), will generate the fort.22 input file for <code>NWS=19</code> from a <code>NWS= 9</code> formatted input file.

Hurricane parameters are read in from the Single File Meteorological Forcing Input File. It is assumed that the line in the fort.22 file with a zero as the forecast increment (i.e., column 6) corresponds to the start of the current simulation run, whether it is a hotstart or cold start. In other words, there is no option to set the NWS value negative to indicate that the file starts at the ADCIRC hotstart time. Rather, the forecast increment in hours (column 6) is used to indicate the relationship between the ADCIRC time and the data in the fort.22 file. Wind velocity and atmospheric pressure are calculated at exact finite element mesh node locations and directly coupled to ADCIRC at every time step using the asymmetric hurricane vortex formulation (Mattocks et al, 2006; Mattocks and Forbes, 2008) based on the Holland gradient wind model. The input file is assumed to correspond to the <code>ATCF Best Track/Objective Aid/Wind Radii Format</code>. Historical tracks, real-time hindcast tracks and real-time forecast tracks may be found in this format. This option uses the radii at specific wind speeds (34, 50, 64, 100 knots) reported in the four quadrants (NE, SE, SW, NW) of the storm to calculate the radius of maximum winds as a function of the azimuthal angle. Garret’s formula is used to compute wind stress from the wind velocity. The <code>NWS=19</code> option allows the user to set a value for <code>Rmax</code> and <code>Holland B Parameter</code>. Additionally the user can select the isotachs to be used for each of the 4 quadrants. The utility program aswip_1.0.3.F located in the /wind folder will generate the <code>NWS=19</code> fomatted file from a <code>NWS=9</code> formatted fort.22 input file.

In order to use the <code>NWS=19</code> option, the file needs to be in best track format. The forecast period (column #6) needs to be edited to reflect the time of the forecast/nowcast for each track location (each line) in hours from the start of the simulation (0, 6, 12, 18, etc). The original data in that column depends on what type of best track format data is being used. The original data might have 0 or other numbers in that column. See: [https://www.nrlmry.navy.mil/atcf_web/docs/database/new/abrdeck.html ATCF Best Track/Objective Aid/Wind Radii Format]. It is suggested that users change the “BEST” tech type to “ASYM” in column 5 in the fort.22 file to denote that the file has been modified to accommodate the asymmetric wind formulation (the simulation time in hours in the 6th column has been added, etc.) so it will not get confused in the future with a best track file.

The <code>NWS=19</code> option requires the following variables in the fort.22 file in a best track format:

<code>Forecast time in hours (column 6); enter the time in hours in each record starting at 0</code>

<code>Latitude of the eye (column 7)</code>

<code>Longitude of the eye (column 8)</code>

<code>Maximum sustained wind speed in knots (column 9)</code>

<code>Minimum sea level pressure in MB (column 10)</code>

<code>Wind intensity in knots of the radii defined in the record (34, 50, 64 or 100 knots) (column 12)</code>

<code>Radius of specified wind intensity for quadrants 1, 2, 3, 4 in NM (columns 14, 15, 16, 17); ? 0</code>

<code>Background pressure in MB (column 18); a standard value of 1013 can be used</code>

<code>Rmax as reported in the ATCF BEST TRACK file in column 20</code>

<code>Storm Name in Column 28 ATCF file format</code>

<code>Time Record number in column 29. There can be multiple lines for a given time record depending on the number of isotachs reported in the ATCF File</code>

<code>number of isotachs reported in the ATCF file for the corresponding Time record.</code>

<code>Columns 31-34 indicate the selection of radii for that particular isotach. 0 indicates do not use this radius, and 1 indicates use this radius and corresponding wind speed.</code>

<code>Columns 35-38 are the designated Rmax values computed for each of the quadrants selected for each particular isotach.</code>

<code>Column 39 is the Holland B parameter computed using the formulas outlines in the Holland paper, and implemented using the aswip program.</code>

Available files:

* [ftp://ftp.nhc.noaa.gov/atcf/archive/ Historical storm files]

* [ftp://ftp.nhc.noaa.gov/atcf/btk/ Forecast tracks]

The format of the file is fixed and users will want to use the aswip program to be sure that the input fort.22 file is properly formatted.

<code>The command line for NWS=19 is ./aswip -n 19 -m 2 -z 1</code>

==NWS = 20 Generalized Asymmetric Holland Vortex Model (GAHM)==

===File Structure===
The file needs is similar to the NWS = 19 format with 8 additional columns of data, see notes below for more information.

===Notes===

The Generalized Asymmetric Holland Model (GAHM) provides a set of theoretical and practical improvements over previous parametric meteorological vortex models in ADCIRC.

<code>Forecast time in hours (column 6); enter the time in hours in each record starting at 0</code>

<code>Latitude of the eye (column 7)</code>

<code>Longitude of the eye (column 8)</code>

<code>Maximum sustained wind speed in knots (column 9)</code>

<code>Minimum sea level pressure in MB (column 10)</code>

<code>Wind intensity in knots of the radii defined in the record (34, 50, 64 or 100 knots) (column 12)</code>

<code>Radius of specified wind intensity for quadrants 1, 2, 3, 4 in NM (columns 14, 15, 16, 17); ? 0</code>

<code>Background pressure in MB (column 18); a standard value of 1013 can be used</code>

<code>Rmax as reported in the ATCF BEST TRACK file in column 20</code>

<code>Storm Name in Column 28 ATCF file format</code>

<code>Time Record number in column 29. There can be multiple lines for a given time record depending on the number of isotachs reported in the ATCF File</code>

<code>number of isotachs reported in the ATCF file for the corresponding Time record.</code>

<code>Columns 31-34 indicate the selection of radii for that particular isotach. 0 indicates do not use this radius, and 1 indicates use this radius and corresponding wind speed.</code>

<code>Columns 35-38 are the designated Rmax values computed for each of the quadrants selected for each particular isotach.</code>

<code>Column 39 is the Holland B parameter computed using the formulas outlines in the Holland paper, and implemented using the aswip program.</code>

<code>Column 40-43 is the quadrant-varying Holland B parameter</code>

<code>Column 44-47 are the quadrant-varying Vmax calculated at the top of the planetary boundary (a wind reduction factor is applied to reduce the wind speed at the boundary to the 10-m surface)</code>

Historical storm files can be found archived here.

Forecast tracks can be found here.

The format of the file is fixed and users will want to use the aswip program to be sure that the input fort.22 file is properly formatted.

Options for the aswip program using NWS = 20 are the following:

<code>./aswip -n # -m # -z #</code>

;-n = nws option

;-m = methods of selecting isotachs for use in computation of radius/radii to maximum winds

:1: always use the 34kt isotach</code>

:2: use the highest available isotach in any quadrant each time

:3: use the 50kt isotach if it is available; otherwise use the 34kt isotach

:4: use all available isotachs (must choose this for GAHM/NWS=20)

;-z = approaches solving for Rmax

:1 = only rotate wind vectors afterward

:2 = rotate wind vectors before and afterwards (use this for NWS=20)

So the command line for <code>NWS=20</code> is: <code>./aswip -n 20 -m 4 -z 2</code>

==NWS = 30 Blended GAHM & Background Gridded Wind and Pressure==
This format is a combination of GAHM (<code>NWS=12</code>) and a gridded background meteorological field (<code>NWS=20</code>). The core of a tropical cyclone is represented using the GAHM model and read in from a file named NWS_20_fort.22, which should be created following the procedure presented in the [[#NWS = 20 Generalized Asymmetric Holland Vortex Model (GAHM)|section on <code>NWS=20</code>]]. The user must also supply gridded wind and pressure files in the form of an OWI-style fort.22 file, a fort.221 file, and a fort.222 file, details on these are in the [[#NWS = ±12 Oceanweather ASCII Format Gridded Wind and Pressure|section on <code>NWS=12</code>]]. ADCIRC internally blends the wind and pressure fields from these two sets of inputs over a user-controlled distance. Specifically, the <code>[[pureVortex]]</code> and <code>[[pureBackground]]</code> inputs in the [[fort.15 file]] (for formatting, see info on the [[Supplemental meteorological/wave/ice parameters|meteorological parameter line]]) are coefficients used to define where transitions between the vortex and background meteorology occur. At or within the distance <code>pureVortex*vortexRMW</code> of the storm's center, the GAHM meteorology is used. At or beyond the distance <code>pureBackground*vortexRMW</code> of the storm's center, the background meteorology is used. In between these, a linear distance-weighted average of the two sets of meteorology is used to define the forcing.

[[Category:input files]]
[[Category:meteorology]]
[[Category:unverified behavior]]

Supplemental meteorological/wave/ice parameters

2021-11-30T14:09:38Z

Taylorgasher: Reordered entries so they're in order

This table is helpful for understanding file requirements and how the [[Fort.15_file_format#WTIMINC|meteorological parameter line]] (informally, the <code>[[WTIMINC]]</code> line) should look in the [[fort.15 file]]. These are principally determined by the value of the <code>[[NWS]]</code> line (also in the fort.15 file), though note that the "NWS" values below are for the [[NWS#Value_Seen_in_fort.15_File|full-length value]] in the fort.15 file. Useful information is also contained in the [[fort.22 file format]] and [[wind stress]] pages.

{| class="wikitable" border="1" style="text-align: center"
|-
! Meteorological Data Format
! [[#Forcing Abbreviations|Forcing]]
! <code>[[NWS]]</code> Value
! <code>[[WTIMINC]]</code> Line
! [[#Requirements|Requirements]]
! [[#Notes|Notes]]
|-
| '''none'''
| nonexistent
| 0
| nonexistent
| none
| none
|- style="background:#efefef;"
| '''wind stress, every node, every timestep'''
| m
| 1
| nonexistent
| f22
| <ref group="note" name="c"><code>NWS</code> formats 1, 2, and 7 do not support the use of ice coverage (fort.25) files.</ref>
|- style="background:#efefef;"
|
| m, rs
| 101
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a">Radiation stress time increment (<code>RSTIMINC</code>) represents the time increment between the datasets in the fort.23 file (in seconds).</ref>
|- style="background:#efefef;"
|
| m, sw
| 301
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"><code>RSTIMINC</code> represents the span of ADCIRC simulation time that passes between calls to the coupled wave model.</ref>
|- style="background:#efefef;"
|
| m, st
| 401
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''wind stress, every node, every <code>WTIMINC</code>'''
| m
| 2
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|-
|
| m, rs
| 102
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 302
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 402
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''US Navy Fleet Numeric'''
| m
| 3
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12003
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''PBL/JAG'''
| m
| 4
| <code>WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 104
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 304
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 404
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12004
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12104
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12304
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12404
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''wind velocity, every node, every <code>WTIMINC</code>'''
| m
| 5
| <code>WTIMINC</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 105
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 305
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 405
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12005
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12105
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12305
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12405
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''wind velocity, rectangular grid, every <code>WTIMINC</code>'''
| m
| 6
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 106
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 306
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 406
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12006
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12106
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12306
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st ,ic
| 12406
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''wind stress, regular grid, every <code>WTIMINC</code>'''
| m
| 7
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|- style="background:#efefef;"
|
| m, rs
| 107
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 307
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 407
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''symmetric vortex model'''
| m
| 8
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| f22
| none
|-
|
| m, rs
| 108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12008
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| f22, f25
| none
|-
|
| m, rs, ic
| 12108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''asymmetric vortex model (no longer available)'''
| n/a
| 9
| n/a
| n/a
| none
|-
| '''National Climatic Data Center GFS'''
| m
| 10
| <code>WTIMINC</code>
| f2xx+
| none
|-
|
| m, rs
| 110
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 310
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 410
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12010
| <code>WTIMINC</code> <code>cice_timinc</code>
| f2xx+, f25
| none
|-
|
| m, rs, ic
| 12110
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12310
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12410
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''National Weather Service ETA 29km'''
| m
| 11
| nonexistent
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 111
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 311
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 411
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m,ic
| 12011
| <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12111
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12311
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12411
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Oceanweather Inc (OWI)'''
| m
| 12
| <code>WTIMINC</code>
| f22x
| none
|-
|
| m, rs
| 112
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 312
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 412
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12012
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22x, f25
| none
|-
|
| m, rs, ic
| 12112
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12312
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12412
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Oceanweather Inc (OWI) NetCDF'''
| m
| 13
| <code>WTIMINC</code>
| f22nc
| [[NWS13]]
|- style="background:#efefef;"
|
| m, rs
| 113
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 313
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 413
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12013
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22nc, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12113
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12313
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12413
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''H*Wind'''
| m
| 15
| <code>WTIMINC</code>
| hwind+,f22
| none
|-
|
| m, rs
| 115
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 315
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 415
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12015
| <code>WTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f25
| none
|-
|
| m, rs, ic
| 12115
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12315
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12415
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Geophysical Fluid Dynamics Laboratory (GFDL) Model'''
| m
| 16
| <code>WTIMINC</code>
| gfdl+,f22
| none
|- style="background:#efefef;"
|
| m, rs
| 116
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 316
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 416
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12016
| <code>WTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12116
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12316
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12416
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Dynamic Asymmetric Model'''
| m
| 19
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| pp,f22
| none
|-
|
| m, rs
| 119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12019
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|-
|
| m, rs, ic
| 12119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''Generalized Asymmetric Holland Model (GAHM)'''
| m
| 20
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code>
| pp, f22
| none
|- style="background:#efefef;"
|
| m, rs
| 120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12020
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|- style="background:#efefef;"
|
| m, rs, ic
| 12120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|-
| '''Blended GAHM and OWI'''
| m
| 30
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22
| none
|-
|
| m, rs
| 130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12030
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f25
| none
|-
|
| m, rs, ic
| 12130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW, f25
| <ref group="note" name="b"></ref>
|-
|}

===Forcing Abbreviations===
: '''m''' - meteorology
: '''rs''' - Wave radiation stress in an analyst-supplied [[fort.23]] input file
: '''sw''' - Wave coupling using a simultaneously executing coupled SWAN model
: '''st''' - Wave coupling using a simultaneously executing ESMF coupled STWAVE model
: '''ic''' - Ice coverage using an analyst-supplied ice coverage data files

===Requirements===
: '''f22''' - Requires analyst-supplied [[fort.22]] meteorological forcing file.
: '''f2xx+''' - Requires at least two fort.2xx meteorological forcing files from the GFS model. See fort.22 documentation for file naming and formatting details.
: '''f22x''' - Requires datasets of pressure and wind data in OWI formatted [[fort.221]] and [[fort.222]] files respectively, optionally including nested wind and pressure in [[fort.223]] and [[fort.224]] files. See fort.22 documentation for details.
: '''hwind+''' - Requires two or more meteorological forcing files from the H*Wind model. See fort.22 documentation for details.
: '''gfdl+''' - Requires two or more meteorological forcing files from the GFDL model. See fort.22 documentation for details.
: '''nwsf22''' - Requires analyst-supplied [[NWS_20_fort.22]] meteorological forcing file.
: '''pp''' - Requires preprocessing of the ATCF formatted track file using the ASymmetric Wind Input Preprocessor (aswip) program (distributed with ADCIRC) prior to use as input for this parametric vortex model.
: '''f23''' - Requires analyst-supplied fort.23 wave radiation stress input file.
: '''A+S''' - Requires ADCIRC+SWAN executable and input files for the coupled version of SWAN.
: '''STW''' - Requires ESMF-coupled ADCIRC and STWAVE and input files for STWAVE.
: '''f25''' - Requires analyst-supplied [[fort.25]] ice coverage input file as well as a [[fort.225]] basin scale ice coverage file and possibly an optional [[fort.227]] region scale ice coverage file.

===Notes===
<references group="note" />

Supplemental meteorological/wave/ice parameters

2021-11-30T13:59:26Z

Taylorgasher: Added NWS = 30 and variants, various formatting changes

This table is helpful for understanding file requirements and how the [[Fort.15_file_format#WTIMINC|meteorological parameter line]] (informally, the <code>[[WTIMINC]]</code> line) should look in the [[fort.15 file]]. These are principally determined by the value of the <code>[[NWS]]</code> line (also in the fort.15 file), though note that the "NWS" values below are for the [[NWS#Value_Seen_in_fort.15_File|full-length value]] in the fort.15 file. Useful information is also contained in the [[fort.22 file format]] and [[wind stress]] pages.

{| class="wikitable" border="1" style="text-align: center"
|-
! Meteorological Data Format
! [[#Forcing Abbreviations|Forcing]]
! <code>[[NWS]]</code> Value
! <code>[[WTIMINC]]</code> Line
! [[#Requirements|Requirements]]
! [[#Notes|Notes]]
|-
| '''none'''
| nonexistent
| 0
| nonexistent
| none
| none
|- style="background:#efefef;"
| '''wind stress, every node, every timestep'''
| m
| 1
| nonexistent
| f22
| <ref group="note" name="c"><code>NWS</code> formats 1, 2, and 7 do not support the use of ice coverage (fort.25) files.</ref>
|- style="background:#efefef;"
|
| m, rs
| 101
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a">Radiation stress time increment (<code>RSTIMINC</code>) represents the time increment between the datasets in the fort.23 file (in seconds).</ref>
|- style="background:#efefef;"
|
| m, sw
| 301
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"><code>RSTIMINC</code> represents the span of ADCIRC simulation time that passes between calls to the coupled wave model.</ref>
|- style="background:#efefef;"
|
| m, st
| 401
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''wind stress, every node, every <code>WTIMINC</code>'''
| m
| 2
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|-
|
| m, rs
| 102
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 302
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 402
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
| '''US Navy Fleet Numeric'''
| m
| 3
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, rs, ic
| 12103
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12303
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12403
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12003
| <code>irefyr</code> <code>irefmo</code> <code>irefday</code> <code>irefhr</code> <code>irefmin</code> <code>refsec</code> <code>cice_timinc</code>
| f22, f25
| none
|-
| '''PBL/JAG'''
| m
| 4
| <code>WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 104
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 304
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 404
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12104
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12304
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12404
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12004
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
| '''wind velocity, every node, every <code>WTIMINC</code>'''
| m
| 5
| <code>WTIMINC</code>
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 105
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 305
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 405
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, rs, ic
| 12105
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12305
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12405
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12005
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|-
| '''wind velocity, rectangular grid, every <code>WTIMINC</code>'''
| m
| 6
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code>
| f22
| none
|-
|
| m, rs
| 106
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 306
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 406
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12106
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12306
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st ,ic
| 12406
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12006
| <code><code>NWLON</code></code> NWLON <code>WLATMAX</code> <code>WLONMIN</code> <code>WLATINC</code> <code><code>WLONINC</code></code> <code>WTIMINC</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
| '''wind stress, regular grid, every <code>WTIMINC</code>'''
| m
| 7
| <code>WTIMINC</code>
| f22
| <ref group="note" name="c"></ref>
|- style="background:#efefef;"
|
| m, rs
| 107
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 307
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 407
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
| '''symmetric vortex model'''
| m
| 8
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| f22
| none
|-
|
| m, rs
| 108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12108
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12308
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12408
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12008
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| f22, f25
| none
|- style="background:#efefef;"
| '''asymmetric vortex model (no longer available)'''
| n/a
| 9
| n/a
| n/a
| none
|-
| '''National Climatic Data Center GFS'''
| m
| 10
| <code>WTIMINC</code>
| f2xx+
| none
|-
|
| m, rs
| 110
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 310
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 410
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f2xx+, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12110
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12310
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12410
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f2xx+, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12010
| <code>WTIMINC</code> <code>cice_timinc</code>
| f2xx+, f25
| none
|- style="background:#efefef;"
| '''National Weather Service ETA 29km'''
| m
| 11
| nonexistent
| f22
| none
|- style="background:#efefef;"
|
| m, rs
| 111
| <code>RSTIMINC</code>
| f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 311
| <code>RSTIMINC</code>
| f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 411
| <code>RSTIMINC</code>
| f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, rs, ic
| 12111
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12311
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12411
| <code>RSTIMINC</code> <code>cice_timinc</code>
| f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m,ic
| 12011
| <code>cice_timinc</code>
| f22, f25
| none
|-
| '''Oceanweather Inc (OWI)'''
| m
| 12
| <code>WTIMINC</code>
| f22x
| none
|-
|
| m, rs
| 112
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 312
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 412
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22x, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12112
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12312
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12412
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22x, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12012
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22x, f25
| none
|- style="background:#efefef;"
| '''Oceanweather Inc (OWI) NetCDF'''
| m
| 13
| <code>WTIMINC</code>
| f22nc
| [[NWS13]]
|- style="background:#efefef;"
|
| m, rs
| 113
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 313
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 413
| <code>WTIMINC</code> <code>RSTIMINC</code>
| f22nc, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, rs, ic
| 12113
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12313
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12413
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| f22nc, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12013
| <code>WTIMINC</code> <code>cice_timinc</code>
| f22nc, f25
| none
|-
| '''H*Wind'''
| m
| 15
| <code>WTIMINC</code>
| hwind+,f22
| none
|-
|
| m, rs
| 115
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 315
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 415
| <code>WTIMINC</code> <code>RSTIMINC</code>
| hwind+,f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12115
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12315
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12415
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12015
| <code>WTIMINC</code> <code>cice_timinc</code>
| hwind+,f22, f25
| none
|- style="background:#efefef;"
| '''Geophysical Fluid Dynamics Laboratory (GFDL) Model'''
| m
| 16
| <code>WTIMINC</code>
| gfdl+,f22
| none
|- style="background:#efefef;"
|
| m, rs
| 116
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 316
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 416
| <code>WTIMINC</code> <code>RSTIMINC</code>
| gfdl+,f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, rs, ic
| 12116
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12316
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12416
| <code>WTIMINC</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12016
| <code>WTIMINC</code> <code>cice_timinc</code>
| gfdl+,f22, f25
| none
|-
| '''Dynamic Asymmetric Model'''
| m
| 19
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code>
| pp,f22
| none
|-
|
| m, rs
| 119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12119
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12319
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12419
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12019
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|- style="background:#efefef;"
| '''Generalized Asymmetric Holland Model (GAHM)'''
| m
| 20
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code>
| pp, f22
| none
|- style="background:#efefef;"
|
| m, rs
| 120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, f23
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw
| 320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, A+S
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st
| 420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code>
| pp, f22, STW
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, rs, ic
| 12120
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, f23, f25
| <ref group="note" name="a"></ref>
|- style="background:#efefef;"
|
| m, sw, ic
| 12320
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, A+S, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, st, ic
| 12420
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code>
| pp, f22, STW, f25
| <ref group="note" name="b"></ref>
|- style="background:#efefef;"
|
| m, ic
| 12020
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code>
| pp, f22, f25
| none
|-
| '''Blended GAHM and OWI'''
| m
| 30
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22
| none
|-
|
| m, rs
| 130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23
| <ref group="note" name="a"></ref>
|-
|
| m, sw
| 330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S
| <ref group="note" name="b"></ref>
|-
|
| m, st
| 430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW
| <ref group="note" name="b"></ref>
|-
|
| m, rs, ic
| 12130
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f23, f25
| <ref group="note" name="a"></ref>
|-
|
| m, sw, ic
| 12330
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, A+S, f25
| <ref group="note" name="b"></ref>
|-
|
| m, st, ic
| 12430
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>RSTIMINC</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, STW, f25
| <ref group="note" name="b"></ref>
|-
|
| m, ic
| 12030
| <code>YYYY</code> <code>MM</code> <code>DD</code> <code>HH24</code> <code>StormNumber</code> <code>BLAdj</code> <code>geofactor</code> <code>cice_timinc</code> <code>pureVortex</code> <code>pureBackground</code>
| pp, f22, nwsf22, f25
| none
|-
|}

===Forcing Abbreviations===
: '''m''' - meteorology
: '''rs''' - Wave radiation stress in an analyst-supplied [[fort.23]] input file
: '''sw''' - Wave coupling using a simultaneously executing coupled SWAN model
: '''st''' - Wave coupling using a simultaneously executing ESMF coupled STWAVE model
: '''ic''' - Ice coverage using an analyst-supplied ice coverage data files

===Requirements===
: '''f22''' - Requires analyst-supplied [[fort.22]] meteorological forcing file.
: '''f2xx+''' - Requires at least two fort.2xx meteorological forcing files from the GFS model. See fort.22 documentation for file naming and formatting details.
: '''f22x''' - Requires datasets of pressure and wind data in OWI formatted [[fort.221]] and [[fort.222]] files respectively, optionally including nested wind and pressure in [[fort.223]] and [[fort.224]] files. See fort.22 documentation for details.
: '''hwind+''' - Requires two or more meteorological forcing files from the H*Wind model. See fort.22 documentation for details.
: '''gfdl+''' - Requires two or more meteorological forcing files from the GFDL model. See fort.22 documentation for details.
: '''nwsf22''' - Requires analyst-supplied [[NWS_20_fort.22]] meteorological forcing file.
: '''pp''' - Requires preprocessing of the ATCF formatted track file using the ASymmetric Wind Input Preprocessor (aswip) program (distributed with ADCIRC) prior to use as input for this parametric vortex model.
: '''f23''' - Requires analyst-supplied fort.23 wave radiation stress input file.
: '''A+S''' - Requires ADCIRC+SWAN executable and input files for the coupled version of SWAN.
: '''STW''' - Requires ESMF-coupled ADCIRC and STWAVE and input files for STWAVE.
: '''f25''' - Requires analyst-supplied [[fort.25]] ice coverage input file as well as a [[fort.225]] basin scale ice coverage file and possibly an optional [[fort.227]] region scale ice coverage file.

===Notes===
<references group="note" />

Fort.15 file

2021-11-16T15:05:25Z

Taylorgasher: /* Ramping Meteorological Forcing at Hot-Start */

This file contains the majority of the parameters required to run both the 2DDI and 3D versions of ADCIRC and the information to drive the model with harmonic boundary conditions (either elevation or flux). This file is required to run the ADCIRC model.

== File Format ==
See [[fort.15 file format]] for details.

== Tips and Tricks ==
=== Meteorological-Only Mode ===
By turning off all ocean state-related outputting and disabling wave coupling, ADCIRC will run in "met.-only" mode, a quick and convenient way to read in and write out meteorological data files. In this mode, only routines necessary for meteorological forcing are called, i.e. no water levels nor velocities are computed. Note that by changing <code>DT</code>, you can speed up this "simulation". More specifically, since the only things being output are meteorological data, you can set <code>DT</code> equal to the time interval you wish met. data to be output, and then set the <code>[[NSPOOLM]]</code> and/or <code>[[NSPOOLGW]]</code> (the local and global met. output intervals) to <code>1</code> (i.e. output every time step). For typical 2D ADCIRC runs, this requires setting the following in the fort.15 file: 
<code>[[NOUTE]] = 0</code> 
<code>[[NOUTV]] = 0</code> 
<code>[[NOUTGE]] = 0</code> 
<code>[[NOUTGV]] = 0</code> 
<code>[[NHSTAR]] = 0</code> 
<code>[[NHASE]] = 0</code> 
<code>[[NHASV]] = 0</code> 
<code>[[NHAGE]] = 0</code> 
<code>[[NHAGV]] = 0</code> 

For passive scalar transport (<code>[[IM]] = 10</code>), also set: 
<code>[[NOUTC]] = 0</code> 
<code>[[NOUTGC]] = 0</code> 

while for barotropic or baroclinic 3D ADCIRC, also set: 
<code>[[I3DSD]] = 0</code> 
<code>[[I3DSV]] = 0</code> 
<code>[[I3DST]] = 0</code> 
<code>[[I3DGD]] = 0</code> 
<code>[[I3DGV]] = 0</code> 
<code>[[I3DGT]] = 0</code> 

=== Ramping Meteorological Forcing at Hot-Start ===
It is generally best to [[ramp|ramping]] in forcing terms to the model to avoid shocking the system, but ramping parameters like <code>[[DRAMP]]</code> define the start of ramp time as being cold-start time. Since it is common-place to initialize meteorological forcing at hotstart time, there is a special parameter to facilitate hotstart ramping of met. data. Let's say you run a 15-day tide-only run and output a hotstart file. Setting 
<code>[[NRAMP]] = 8</code> 
means you can supply <code>[[DRAMPUnMete]]</code>, which is the number of delays at which to start met. ramping, on the <code>DRAMP</code> line. Here's an example: 
<code>5 0 0 0 0 0 0.5 0 15 ! DRAMP, DRAMPExtFlux, FluxSettlingTime, DRAMPIntFlux, DRAMPElev, DRAMPTip, DRAMPMete, DRAMPWRad, DRAMPUnMete</code> 
What this says is that a 0.5-day ramp will be applied to the met. forcing, starting at run day 15.0 (the hotstart simulation's start time).

[[Category:input files]]

Fort.18 file

2021-11-16T14:58:03Z

Taylorgasher: Added note about being in PE* folders

The fort.18 file is a file with information needed for parallel (MPI) execution of ADCIRC (commonly termed PADCIRC). The file is created by the [[adcprep]] executable, which is run prior to launching a parallel ADCIRC run. The file is not located in the main run directory, but instead there is one copy of the file in each of the PE* (PE0000, PE0001, etc.) subdirectories created by adcprep.

[[Category:input files]]

Fort.18

2021-11-16T14:56:42Z

Taylorgasher: Created redirect

#REDIRECT [[fort.18 file]]

Fort.18 file

2021-11-16T14:56:29Z

Taylorgasher: Created page with a simple explanation

Fort.15 file

2021-02-12T23:43:11Z

Taylorgasher: /* Meteorological-Only Mode */

This file contains the majority of the parameters required to run both the 2DDI and 3D versions of ADCIRC and the information to drive the model with harmonic boundary conditions (either elevation or flux). This file is required to run the ADCIRC model.

== File Format ==
See [[fort.15 file format]] for details.

== Tips and Tricks ==
=== Meteorological-Only Mode ===
By turning off all ocean state-related outputting and disabling wave coupling, ADCIRC will run in "met.-only" mode, a quick and convenient way to read in and write out meteorological data files. In this mode, only routines necessary for meteorological forcing are called, i.e. no water levels nor velocities are computed. Note that by changing <code>DT</code>, you can speed up this "simulation". More specifically, since the only things being output are meteorological data, you can set <code>DT</code> equal to the time interval you wish met. data to be output, and then set the <code>[[NSPOOLM]]</code> and/or <code>[[NSPOOLGW]]</code> (the local and global met. output intervals) to <code>1</code> (i.e. output every time step). For typical 2D ADCIRC runs, this requires setting the following in the fort.15 file: 
<code>[[NOUTE]] = 0</code> 
<code>[[NOUTV]] = 0</code> 
<code>[[NOUTGE]] = 0</code> 
<code>[[NOUTGV]] = 0</code> 
<code>[[NHSTAR]] = 0</code> 
<code>[[NHASE]] = 0</code> 
<code>[[NHASV]] = 0</code> 
<code>[[NHAGE]] = 0</code> 
<code>[[NHAGV]] = 0</code> 

For passive scalar transport (<code>[[IM]] = 10</code>), also set: 
<code>[[NOUTC]] = 0</code> 
<code>[[NOUTGC]] = 0</code> 

while for barotropic or baroclinic 3D ADCIRC, also set: 
<code>[[I3DSD]] = 0</code> 
<code>[[I3DSV]] = 0</code> 
<code>[[I3DST]] = 0</code> 
<code>[[I3DGD]] = 0</code> 
<code>[[I3DGV]] = 0</code> 
<code>[[I3DGT]] = 0</code> 

=== Ramping Meteorological Forcing at Hot-Start ===
Let's say you run a 15-day tide-only run and output a hotstart file. Then, you want to hotstart a simulation with meteorological forcing. Initiating the hotstart simulation with full-strength met. forcing could apply a shock to the system, creating spurious waves. Therefore, it's best to ramp in the met. forcing. But, ramping parameters like <code>[[DRAMP]]</code> define the start of ramp time as being cold-start time. Setting 
<code>[[NRAMP]] = 8</code> 
means you can supply <code>[[DRAMPUnMete]]</code>, which is the number of delays at which to start met. ramping, on the <code>DRAMP</code> line. Here's an example: 
<code>5 0 0 0 0 0 0.5 0 15 ! DRAMP,DRAMPExtFlux,FluxSettlingTime,DRAMPIntFlux,DRAMPElev,DRAMPTip,DRAMPMete,DRAMPWRad,DRAMPUnMete</code> 
What this says is that a 0.5-day ramp will be applied to the met. forcing, starting at run day 15.0 (the hotstart simulation's start time).

[[Category:input files]]

Fort.15 file

2021-02-12T23:42:37Z

Taylorgasher:

This file contains the majority of the parameters required to run both the 2DDI and 3D versions of ADCIRC and the information to drive the model with harmonic boundary conditions (either elevation or flux). This file is required to run the ADCIRC model.

== File Format ==
See [[fort.15 file format]] for details.

== Tips and Tricks ==
=== Meteorological-Only Mode ===
By turning off all ocean state-related outputting and disabling wave coupling, ADCIRC will run in "met.-only" mode, a quick and convenient way to read in and write out meteorological data files. In this mode, only routines necessary for meteorological forcing are called, i.e. no water levels nor velocities are computed. Note that by changing <code>DT</code>, you can speed up this "simulation". More specifically, since the only things being output are meteorological data, you can set <code>DT</code> equal to the time interval you wish met. data to be output, and then set the <code>[[NSPOOLM]]</code> and/or <code>[[NSPOOLGW]]</code> (the local and global met. output intervals) to <code>1</code> (i.e. output every time step). For typical 2D ADCIRC runs, this requires setting the following in the fort.15 file: 
<code>[[NOUTE]] = 0</code> 
<code>[[NOUTV]] = 0</code> 
<code>[[NOUTGE]] = 0</code> 
<code>[[NOUTGV]] = 0</code> 
<code>[[NHSTAR]] = 0</code> 
<code>[[NHASE]] = 0</code> 
<code>[[NHASV]] = 0</code> 
<code>[[NHAgE]] = 0</code> 
<code>[[NHAGV]] = 0</code> 

For passive scalar transport (<code>[[IM]] = 10</code>), also set: 
<code>[[NOUTC]] = 0</code> 
<code>[[NOUTGC]] = 0</code> 

while for barotropic or baroclinic 3D ADCIRC, also set: 
<code>[[I3DSD]] = 0</code> 
<code>[[I3DSV]] = 0</code> 
<code>[[I3DST]] = 0</code> 
<code>[[I3DGD]] = 0</code> 
<code>[[I3DGV]] = 0</code> 
<code>[[I3DGT]] = 0</code> 

=== Ramping Meteorological Forcing at Hot-Start ===
Let's say you run a 15-day tide-only run and output a hotstart file. Then, you want to hotstart a simulation with meteorological forcing. Initiating the hotstart simulation with full-strength met. forcing could apply a shock to the system, creating spurious waves. Therefore, it's best to ramp in the met. forcing. But, ramping parameters like <code>[[DRAMP]]</code> define the start of ramp time as being cold-start time. Setting 
<code>[[NRAMP]] = 8</code> 
means you can supply <code>[[DRAMPUnMete]]</code>, which is the number of delays at which to start met. ramping, on the <code>DRAMP</code> line. Here's an example: 
<code>5 0 0 0 0 0 0.5 0 15 ! DRAMP,DRAMPExtFlux,FluxSettlingTime,DRAMPIntFlux,DRAMPElev,DRAMPTip,DRAMPMete,DRAMPWRad,DRAMPUnMete</code> 
What this says is that a 0.5-day ramp will be applied to the met. forcing, starting at run day 15.0 (the hotstart simulation's start time).

[[Category:input files]]

Fort.15 file

2021-02-12T23:40:49Z

Taylorgasher: updated met-only mode, per recommendations from Kyle Steffen

This file contains the majority of the parameters required to run both the 2DDI and 3D versions of ADCIRC and the information to drive the model with harmonic boundary conditions (either elevation or flux). This file is required to run the ADCIRC model.

== File Format ==
See [[fort.15 file format]] for details.

== Tips and Tricks ==
=== Meteorological-Only Mode ===
By turning off all ocean state-related outputting and disabling wave coupling, ADCIRC will run in "met.-only" mode, a quick and convenient way to read in and write out meteorological data files. In this mode, only routines necessary for meteorological forcing are called, i.e. no water levels nor velocities are computed. Note that by changing <code>DT</code>, you can speed up this "simulation". More specifically, since the only things being output are meteorological data, you can set <code>DT</code> equal to the time interval you wish met. data to be output, and then set the <code>[[NSPOOLM]]</code> and/or <code>[[NSPOOLGW]]</code> (the local and global met. output intervals) to <code>1</code> (i.e. output every time step). For typical 2D ADCIRC runs, this requires setting the following in the fort.15 file: 
<code>[[NOUTE]] = 0</code> 
<code>[[NOUTV]] = 0</code> 
<code>[[NOUTGE]] = 0</code> 
<code>[[NOUTGV]] = 0</code> 
<code>[[NHSTAR]] = 0</code> 
<code>[[NHASE]] = 0</code> 
<code>[[NHASV]] = 0</code> 
<code>[[NHAgE]] = 0</code> 
<code>[[NHAGV]] = 0</code> 

For passive scalar transport (<code>[[IM]] = 10</code>), also set: 
<code>[[NOUTC]] = 0</code> 
<code>[[NOUTGC]] = 0</code> 

while for barotropic or baroclinic 3D ADCIRC, also set:
<code>[[I3DSD]] = 0</code> 
<code>[[I3DSV]] = 0</code> 
<code>[[I3DST]] = 0</code> 
<code>[[I3DGD]] = 0</code> 
<code>[[I3DGV]] = 0</code> 
<code>[[I3DGT]] = 0</code> 

=== Ramping Meteorological Forcing at Hot-Start ===
Let's say you run a 15-day tide-only run and output a hotstart file. Then, you want to hotstart a simulation with meteorological forcing. Initiating the hotstart simulation with full-strength met. forcing could apply a shock to the system, creating spurious waves. Therefore, it's best to ramp in the met. forcing. But, ramping parameters like <code>[[DRAMP]]</code> define the start of ramp time as being cold-start time. Setting 
<code>[[NRAMP]] = 8</code> 
means you can supply <code>[[DRAMPUnMete]]</code>, which is the number of delays at which to start met. ramping, on the <code>DRAMP</code> line. Here's an example: 
<code>5 0 0 0 0 0 0.5 0 15 ! DRAMP,DRAMPExtFlux,FluxSettlingTime,DRAMPIntFlux,DRAMPElev,DRAMPTip,DRAMPMete,DRAMPWRad,DRAMPUnMete</code> 
What this says is that a 0.5-day ramp will be applied to the met. forcing, starting at run day 15.0 (the hotstart simulation's start time).

[[Category:input files]]

Template:ADC version

2020-07-10T20:13:54Z

Taylorgasher: updated examples

<onlyinclude>
{| style="border: 4px solid #AA00AA; float: right; font-size: 80%; margin: 0 0 .5em .5em; line-height: 1.2; text-align: right; border-collapse: collapse;" 
| ADCIRC version:
| <abbr style="font-weight: bold; font-size: 180%;"> {{#switch: {{{relation|}}} 
|eq|{{=}}={{=}}
|gt|>=>
|lt|<=<
|ge|+=≥
|le|-=≤
}} {{#ifeq: {{{version|}}} | {{{version}}} | {{{version}}} | ?????}} </abbr> 
|}
</onlyinclude>

This template will give a version number indicator on the right-hand side of a page (or table or whatever) it is added to, and is intended as a way to highlight what version(s) of ADCIRC something is relevant for. This was inspired by [https://www.mediawiki.org/wiki/Template:MW_version a much more advanced template on MediaWiki].

== Syntax ==
<code><nowiki>{{ADC version|version=</nowiki><nowiki>VERSION</nowiki><nowiki>|relation=</nowiki><nowiki>RELATION</nowiki><nowiki>}}</nowiki></code>

You specify the values for <code>VERSION</code> and <code>RELATION</code>, examples of which are given below.

== Examples ==
{| class="wikitable"
!you type
!you get
|-
| <code><nowiki>{{ADC version}}</nowiki></code> || {{ADC version}}
|-
| <code><nowiki>{{ADC version|version=52}}</nowiki></code> || {{ADC version|version=52}}
|-
| <code><nowiki>{{ADC version|version=44-47}}</nowiki></code> || {{ADC version|version=44-47}}
|-
| <code><nowiki>{{ADC version|version=52|relation=>}}</nowiki></code> || {{ADC version|version=52|relation=>}}
|-
| <code><nowiki>{{ADC version|version=52.dev, 53|relation=gt}}</nowiki></code> || {{ADC version|version=52.dev, 53|relation=gt}}
|-
| <code><nowiki>{{ADC version|version=53|relation=le}}</nowiki></code> || {{ADC version|version=53|relation=le}}
|-
| <code><nowiki>{{ADC version|version=50|relation=-}}</nowiki></code> || {{ADC version|version=50|relation=-}}
|-
| <code><nowiki>{{ADC version|version=a long, long time ago|relation=+}}</nowiki></code> || {{ADC version|version=a long, long time ago|relation=+}}
|}

Template:Version support box

2020-07-10T19:37:02Z

Taylorgasher: typo

<onlyinclude>{| style="border: 4px solid {{#switch: {{{support|}}}
|sup|yes|supported=#00BB00;
|tp|tech preview=#EEEE00;
|uns|no|unsupported=#FF9933;
|dep|deprecated=#FF0000;
| #default=#FF00FF;
}} float: right; font-size: 80%; margin: 0 0 .5em .5em; line-height: 1.2; text-align: right; border-collapse: collapse;" 
|-
| {{#switch: {{{size|}}} |full=ADCIRC version: |mini= | #default=ADCIRC version: }}
| rowspan="2" | <abbr style="font-weight: bold; font-size: 180%; vertical-align:middle;"> {{#switch: {{{relation|}}} 
|eq|{{=}}={{=}}
|gt|>=>
|lt|<=<
|ge|+=≥
|le|-=≤
}} {{#ifeq: {{{version|}}} | {{{version}}} | {{{version}}} | ?????}} </abbr> 
|-
| style="font-weight: bold; text-decoration:underline; text-align:center;" | {{#switch: {{{size|}}} |full={{Support level text|level={{{support}}}}} |mini= | #default={{Support level text|level={{{support}}}}}
}} 
|}</onlyinclude>

This template will give a box with version number indicator and feature support info on the right-hand side of a page (or table or whatever) that it is added to, and is intended as a way to highlight what version(s) of ADCIRC something is in and how supported/finalized the feature is in the code. This is a variant of [[Template:ADC version]].

== Syntax ==
<code><nowiki>{{Version support box|version=</nowiki><nowiki>VERSION</nowiki><nowiki>|relation=</nowiki><nowiki>RELATION</nowiki><nowiki>|support=</nowiki><nowiki>SUPPORT</nowiki><nowiki>|size=</nowiki><nowiki>SIZE</nowiki><nowiki>}}</nowiki></code>

You specify the values for <code>VERSION</code>, <code>RELATION</code>, <code>SUPPORT</code>, and <code>SIZE</code>, examples of which are given below.

== Examples ==
{| class="wikitable"
!you type
!you get
|-
| <code><nowiki>{{Version support box}}</nowiki></code> || {{Version support box}}
|-
| <code><nowiki>{{Version support box|version=52}}</nowiki></code> || {{Version support box|version=52}}
|-
| <code><nowiki>{{Version support box|version=52|relation=>}}</nowiki></code> || {{Version support box|version=52|relation=>}}
|-
| <code><nowiki>{{Version support box|version=52|relation=gt|support=sup}}</nowiki></code> || {{Version support box|version=52|relation=gt|support=sup}}
|-
| <code><nowiki>{{Version support box|version=44-47|relation=ge|support=tech preview|size=mini}}</nowiki></code> || {{Version support box|version=44-47|relation=ge|support=tech preview|size=mini}}
|-
| <code><nowiki>{{Version support box|version=52.dev, 53|relation=le|support=tp}}</nowiki></code> || {{Version support box|version=52.dev, 53|relation=le|support=tp}}
|-
| <code><nowiki>{{Version support box|version=50|relation=-|support=uns}}</nowiki></code> || {{Version support box|version=50|relation=-|support=uns}}
|-
| <code><nowiki>{{Version support box|relation=+|support=unsupported}}</nowiki></code> || {{Version support box|relation=+|support=unsupported}}
|-
| <code><nowiki>{{Version support box|version=a long, long time ago|relation=+|support=dep|size=full}}</nowiki></code> || {{Version support box|version=a long, long time ago|relation=+|support=dep|size=full}}
|-
| <code><nowiki>{{Version support box|version=a long, long time ago|support=dep|size=mini}}</nowiki></code> || {{Version support box|version=a long, long time ago|support=dep|size=mini}}
|}

Template:Version support box

2020-07-10T19:35:39Z

Taylorgasher: again

<onlyinclude>{| style="border: 4px solid {{#switch: {{{support|}}}
|sup|yes|supported=#00BB00;
|tp|tech preview=#EEEE00;
|uns|no|unsupported=#FF9933;
|dep|deprecated=#FF0000;
| #default=#FF00FF;
}} float: right; font-size: 80%; margin: 0 0 .5em .5em; line-height: 1.2; text-align: right; border-collapse: collapse;" 
|-
| {{#switch: {{{size|}}} |full=ADCIRC version: |mini= | #default=ADCIRC version: }}
| rowspan="2" | <abbr style="font-weight: bold; font-size: 180%; vertical-align:middle;"> {{#switch: {{{relation|}}} 
|eq|{{=}}={{=}}
|gt|>=>
|lt|<=<
|ge|+=≥
|le|-=≤
}} {{#ifeq: {{{version|}}} | {{{version}}} | {{{version}}} | ?????}} </abbr> 
|-
| style="font-weight: bold; text-decoration:underline; text-align:center;" | {{#switch: {{{size|}}} |full={{Support level text|level={{{support}}}}} |mini= | #default={{Support level text|level={{{support}}}}}
}} 
|}</onlyinclude>

This template will give a box with version number indicator and feature support info on the right-hand side of a page (or table or whatever) that it is added to, and is intended as a way to highlight what version(s) of ADCIRC something is in and how supported/finalized the feature is in the code. This is a variant of [[Template:ADC version]].

== Syntax ==
<code><nowiki>{{Version support box|version=</nowiki><nowiki>VERSION</nowiki><nowiki>|relation=</nowiki><nowiki>RELATION</nowiki><nowiki>|support=</nowiki><nowiki>SUPPORT</nowiki><nowiki>|size=</nowiki><nowiki>SIZE</nowiki><nowiki>}}</nowiki></code>

You specify the values for <code>VERSION</code>, <code>RELATION</code>, <code>SUPPORT</code>, and <code>SIZE</code>, examples of which are given below.

== Examples ==
{| class="wikitable"
!you type
!you get
|-
| <code><nowiki>{{Version support box}}</nowiki></code> || {{Version support box}}
|-
| <code><nowiki>{{Version support box|version=52}}</nowiki></code> || {{Version support box|version=52}}
|-
| <code><nowiki>{{Version support box|version=52|relation=>}}</nowiki></code> || {{Version support box|version=52|relation=>}}
|-
| <code><nowiki>{{Version support box|version=52|relation=gt|support=sup}}</nowiki></code> || {{Version support box|version=52|relation=gt|support=sup}}
|-
| <code><nowiki>{{Version support box|version=44-47|relation=ge|support=tech preview|size=mini}}</nowiki></code> || {{Version support box|version=44-47|relation=ge|support=tech preview|size=mini}}
|-
| <code><nowiki>{{Version support box|version=52.dev, 53|relation=le|support=tp}}</nowiki></code> || {{Version support box|version=52.dev, 53|relation=le|support=tp}}
|-
| <code><nowiki>{{Version support box|version=50|relation=-|support=uns}}</nowiki></code> || {{Version support box|version=50|relation=-|support=uns}}
|-
| <code><nowiki>{{Version support box|relation=+|support=unsupported}}</nowiki></code> || {{Version support box|relation=+|support=unsupported}}
|-
| <code><nowiki>{{Version support box|version=a long, long time ago|relation=+|support=dep|size=full}}</nowiki></code> || {{Version support box|version=a long, long time ago|relation=+|support=dep|size=full}}
|-
| <code><nowiki>{{Version support box|version=a long, long time ago|relation=+|support=dep|size=mini}}</nowiki></code> || {{Version support box|version=a long, long time ago|support=dep|size=mini}}
|}

Template:Version support box

2020-07-10T19:29:51Z

Taylorgasher: revised examples

<onlyinclude>{| style="border: 4px solid {{#switch: {{{support|}}}
|sup|yes|supported=#00BB00;
|tp|tech preview=#EEEE00;
|uns|no|unsupported=#FF9933;
|dep|deprecated=#FF0000;
| #default=#FF00FF;
}} float: right; font-size: 80%; margin: 0 0 .5em .5em; line-height: 1.2; text-align: right; border-collapse: collapse;" 
|-
| {{#switch: {{{size|}}} |full=ADCIRC version: |mini= | #default=ADCIRC version: }}
| rowspan="2" | <abbr style="font-weight: bold; font-size: 180%; vertical-align:middle;"> {{#switch: {{{relation|}}} 
|eq|{{=}}={{=}}
|gt|>=>
|lt|<=<
|ge|+=≥
|le|-=≤
}} {{#ifeq: {{{version|}}} | {{{version}}} | {{{version}}} | ?????}} </abbr> 
|-
| style="font-weight: bold; text-decoration:underline; text-align:center;" | {{#switch: {{{size|}}} |full={{Support level text|level={{{support}}}}} |mini= | #default={{Support level text|level={{{support}}}}}
}} 
|}</onlyinclude>

This template will give a box with version number indicator and feature support info on the right-hand side of a page (or table or whatever) that it is added to, and is intended as a way to highlight what version(s) of ADCIRC something is in and how supported/finalized the feature is in the code. This is a variant of [[Template:ADC version]].

== Syntax ==
<code><nowiki>{{Version support box|version=</nowiki><nowiki>VERSION</nowiki><nowiki>|relation=</nowiki><nowiki>RELATION</nowiki><nowiki>|support=</nowiki><nowiki>SUPPORT</nowiki><nowiki>|size=</nowiki><nowiki>SIZE</nowiki><nowiki>}}</nowiki></code>

You specify the values for <code>VERSION</code>, <code>RELATION</code>, <code>SUPPORT</code>, and <code>SIZE</code>, examples of which are given below.

== Examples ==
{| class="wikitable"
!you type
!you get
|-
| <code><nowiki>{{Version support box}}</nowiki></code> || {{Version support box}}
|-
| <code><nowiki>{{Version support box|version=52}}</nowiki></code> || {{Version support box|version=52}}
|-
| <code><nowiki>{{Version support box|version=44-47}}</nowiki></code> || {{Version support box|version=44-47}}
|-
| <code><nowiki>{{Version support box|version=52|relation=>}}</nowiki></code> || {{Version support box|version=52|relation=>}}
|-
| <code><nowiki>{{Version support box|version=52|relation=gt|support=sup}}</nowiki></code> || {{Version support box|version=52|relation=gt|support=sup}}
|-
| <code><nowiki>{{Version support box|version=52.dev, 53|relation=ge|support=tech preview|size=mini}}</nowiki></code> || {{Version support box|version=52.dev, 53|relation=ge|support=tech preview|size=mini}}
|-
| <code><nowiki>{{Version support box|version=53|relation=le|support=tp}}</nowiki></code> || {{Version support box|version=53|relation=le|support=tp}}
|-
| <code><nowiki>{{Version support box|version=50|relation=-|support=uns}}</nowiki></code> || {{Version support box|version=50|relation=-|support=uns}}
|-
| <code><nowiki>{{Version support box|relation=+|support=unsupported}}</nowiki></code> || {{Version support box|relation=+|support=unsupported}}
|-
| <code><nowiki>{{Version support box|version=a long, long time ago|relation=+|support=dep|size=full}}</nowiki></code> || {{Version support box|version=a long, long time ago|relation=+|support=dep|size=full}}
|-
| <code><nowiki>{{Version support box|version=a long, long time ago|relation=+|support=dep|size=mini}}</nowiki></code> || {{Version support box|version=a long, long time ago|relation=+|support=dep|size=mini}}
|}

Template:ADC version

2020-07-10T19:09:05Z

Taylorgasher: made color purple to distinguish from version support box colors

<onlyinclude>
{| style="border: 4px solid #AA00AA; float: right; font-size: 80%; margin: 0 0 .5em .5em; line-height: 1.2; text-align: right; border-collapse: collapse;" 
| ADCIRC version:
| <abbr style="font-weight: bold; font-size: 180%;"> {{#switch: {{{relation|}}} 
|eq|{{=}}={{=}}
|gt|>=>
|lt|<=<
|ge|+=≥
|le|-=≤
}} {{#ifeq: {{{version|}}} | {{{version}}} | {{{version}}} | ?????}} </abbr> 
|}
</onlyinclude>

This template will give a version number indicator on the right-hand side of a page (or table or whatever) it is added to, and is intended as a way to highlight what version(s) of ADCIRC something is relevant for. This was inspired by [https://www.mediawiki.org/wiki/Template:MW_version a much more advanced template on MediaWiki].

== Syntax ==
<code><nowiki>{{ADC version|version=</nowiki><nowiki>VERSION</nowiki><nowiki>|relation=</nowiki><nowiki>RELATION</nowiki><nowiki>}}</nowiki></code>

You specify the values for <code>VERSION</code> and <code>RELATION</code>, examples of which are given below.

== Examples ==
{| class="wikitable"
!you type
!you get
|-
| <code><nowiki>{{ADC version}}</nowiki></code> || {{ADC version}}
|-
| <code><nowiki>{{ADC version|version=52}}</nowiki></code> || {{ADC version|version=52}}
|-
| <code><nowiki>{{ADC version|version=44-47}}</nowiki></code> || {{ADC version|version=44-47}}
|-
| <code><nowiki>{{ADC version|version=52|relation=>}}</nowiki></code> || {{ADC version|version=52|relation=>}}
|-
| <code><nowiki>{{ADC version|version=52|relation=gt}}</nowiki></code> || {{ADC version|version=52|relation=gt}}
|-
| <code><nowiki>{{ADC version|version=53|relation=le}}</nowiki></code> || {{ADC version|version=53|relation=le}}
|-
| <code><nowiki>{{ADC version|version=50|relation=-}}</nowiki></code> || {{ADC version|version=50|relation=-}}
|-
| <code><nowiki>{{ADC version|version=a long, long time ago|relation=+}}</nowiki></code> || {{ADC version|version=a long, long time ago|relation=+}}
|}