ADCIRCWiki - User contributions [en]

Fort.22 file

2024-10-02T20:51:21Z

Wpringle: /* File Structure */

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 [plus optional HPa units] 
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 [optional: append HPa to PSFC (i.e., PSFCHPa) to indicate that units of pressure are in hPa/mbar, otherwise assumed to be in Pa] 
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]]. If pressure units are in hectopascals, add 'HPa' to the pressure variable line in the fort.22. For example, if the pressure variable is 'mslp', make it 'mslpHPa'.

==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]]

Fort.22 file

2024-10-02T20:50:53Z

Wpringle: /* Example (WRF output) */

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 [optional: append HPa to PSFC (i.e., PSFCHPa) to indicate that units of pressure are in hPa/mbar, otherwise assumed to be in Pa] 
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]]. If pressure units are in hectopascals, add 'HPa' to the pressure variable line in the fort.22. For example, if the pressure variable is 'mslp', make it 'mslpHPa'.

==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]]

Idealized Channel Problem

2021-04-08T03:01:02Z

Wpringle:

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2021. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. Environmental Modelling and Software, 105045. https://doi.org/10.1016/j.envsoft.2021.105045</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. https://doi.org/10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. https://doi.org/10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Note that the short 6 hour length of the test is chosen only to limit simulation time for the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite] where the test case been found. Users may extend the simulation length to simulate more of the inundating phase of the incoming wave.

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1000px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

[[File:Channel_Elev.gif|500px|thumb|Elevation time series for the idealized channel problem]] [[File:Channel_Vel.gif|500px|thumb|North-south velocity time series for the idealized channel problem]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files. [[Grid_Development_and_Editing#OceanMesh2D|OceanMesh2D]] functions can be used to automatically generate the sponge_generator_layer attribute ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Calc_Sponge.m Calc_Sponge]) and the input files ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Make_f5354.m Make_f5354]).
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

NWS

2020-11-17T19:50:47Z

Wpringle: /* Parameter Summary */

'''<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 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" />

IM

2020-08-21T19:30:43Z

Wpringle: /* Default IM Values */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| -
| Baroclinic 2DDI
|-
| 21
| -
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=+}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| -
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| -
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDigit-6 to 3. The default version (IMDigit-6=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

IM

2020-07-19T22:02:47Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111114
| Baroclinic 2DDI
|-
| 21
| 611114
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=+}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| -
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| -
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDigit-6 to 3. The default version (IMDigit-6=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

IM

2020-07-12T20:34:28Z

Wpringle: /* Default IM Values */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111114
| Baroclinic 2DDI
|-
| 21
| 611114
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=+}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55|relation=+}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDigit-6 to 3. The default version (IMDigit-6=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

IM

2020-07-11T01:13:59Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=+}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55|relation=+}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDigit-6 to 3. The default version (IMDigit-6=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

AliDispersionControl

2020-07-10T21:46:43Z

Wpringle: /* Version */

'''Ali's Dispersion Correction''' is a correction to the dispersive behavior of very long waves in a compressible ocean on an elastic Earth. It is intended to be used in lieu of the self-attraction and loading tide prescribed through the [[fort.24 file]]. It should be used with the sixth-digit of [[IM]] equal to 3 (fully implicit gravity wave term).

== Version ==
{{Version support box|version=55|relation=+|support=tp}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used (the following floats are the default values): 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

For the following equation:
<math>Correction = 1 - \frac{Ma^2}{4} - {A_d}H^{B_d}</math>

where Ma is the Mach number (<math>Ma = \frac{\sqrt{gH}}{Cs}</math>) and H is the total water depth.

IM

2020-07-10T21:43:58Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=+}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{Version support box|version=55|relation=+|support=tp}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDigit-6 to 3. The default version (IMDigit-6=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

AliDispersionControl

2020-07-10T15:26:45Z

Wpringle:

'''Ali's Dispersion Correction''' is a correction to the dispersive behavior of very long waves in a compressible ocean on an elastic Earth. It is intended to be used in lieu of the self-attraction and loading tide prescribed through the [[fort.24 file]]. It should be used with the sixth-digit of [[IM]] equal to 3 (fully implicit gravity wave term).

== Version ==
{{ADC version|version=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used (the following floats are the default values): 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

For the following equation:
<math>Correction = 1 - \frac{Ma^2}{4} - {A_d}H^{B_d}</math>

where Ma is the Mach number (<math>Ma = \frac{\sqrt{gH}}{Cs}</math>) and H is the total water depth.

AliDispersionControl

2020-07-10T15:24:45Z

Wpringle: /* Controlling Dispersive Behavior */

'''Ali's Dispersion Correction''' is a correction to the dispersive behavior of very long waves in a compressible ocean on an elastic Earth. It is intended to be used in lieu of the self-attraction and loading tide prescribed through the [[fort.24 file]].

== Version ==
{{ADC version|version=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used (the following floats are the default values): 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

For the following equation:
<math>Correction = 1 - \frac{Ma^2}{4} - {A_d}H^{B_d}</math>

where Ma is the Mach number (<math>Ma = \frac{\sqrt{gH}}{Cs}</math>) and H is the total water depth.

AliDispersionControl

2020-07-10T15:24:17Z

Wpringle: /* Controlling Dispersive Behavior */

'''Ali's Dispersion Correction''' is a correction to the dispersive behavior of very long waves in a compressible ocean on an elastic Earth. It is intended to be used in lieu of the self-attraction and loading tide prescribed through the [[fort.24 file]].

== Version ==
{{ADC version|version=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used (the following floats are the default values): 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

For the following equation:
<math>Correction = 1 - Ma^2/4 - {A_d}H^{B_d}</math>

where Ma is the Mach number (<math>Ma = \frac{\sqrt{gH}}{Cs}</math>) and H is the total water depth.

AliDispersionControl

2020-07-10T15:23:59Z

Wpringle: /* Controlling Dispersive Behavior */

'''Ali's Dispersion Correction''' is a correction to the dispersive behavior of very long waves in a compressible ocean on an elastic Earth. It is intended to be used in lieu of the self-attraction and loading tide prescribed through the [[fort.24 file]].

== Version ==
{{ADC version|version=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used (the following floats are the default values): 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

For the following equation:
<math>Correction = 1 - Ma^2/4 - {A_d}H^{B_d}</math>

where Ma is the Mach number (<math>Ma = \frac{\sqrt(gH)}{Cs}</math>) and H is the total water depth.

AliDispersionControl

2020-07-10T15:18:28Z

Wpringle:

'''Ali's Dispersion Correction''' is a correction to the dispersive behavior of very long waves in a compressible ocean on an elastic Earth. It is intended to be used in lieu of the self-attraction and loading tide prescribed through the [[fort.24 file]].

== Version ==
{{ADC version|version=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used (the following floats are the default values): 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

For the following equations
<math>Correction = A_d*h^{B_d}</math>

AliDispersionControl

2020-07-10T15:07:53Z

Wpringle: /* Controlling Dispersive Behavior */

'''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=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used (the following floats are the default values): 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

AliDispersionControl

2020-07-10T15:04:58Z

Wpringle: /* Controlling Dispersive Behavior */

'''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=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used: 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn the Mach number based correction off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

AliDispersionControl

2020-07-10T15:04:02Z

Wpringle: /* Controlling Dispersive Behavior */

'''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=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used: 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn this component off.
* <code>Ad</code> the power law constant.
* <code>Bd</code> the power law exponent.

AliDispersionControl

2020-07-10T15:02:04Z

Wpringle: Created page with "'''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 o..."

'''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=55: Technical Preview|relation=+}}
This is considered a technical preview in version 55. Theoretical work is still ongoing.

==Controlling Dispersive Behavior==
The feature is triggered by the presence of the &AliDispersionControl namelist at the bottom of the [[fort.15 file]]. Here is an example of how this line is used: 
<code>&AliDispersionControl CAliDisp=T, Cs=1500.0, Ad = 0.0050189, Bd = 0.23394/</code>

* <code>CAliDisp</code> logical flag to turn Ali's dispersion correction on (F=false by default).
* <code>Cs</code> is the speed of sound in water [m/s] for the Mach number based dispersive correction. Set Cs to a negative value to turn this component off.
* <code>Ad</code> coefficient.
* <code>Bd</code> coefficient.

Fort.15 file format

2020-07-10T14:32:49Z

Wpringle: /* Namelists */

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===


{| class="wikitable" border="1" style="text-align: center"
|-
! Parameter
! Type
! Required?
! Description
! Values
|-
| <code>RUNDES</code>
| <math>\leq</math>32 character string
| Always
| Run description
| Any alpha-numeric
|- style="background:#efefef;"
| <code>RUNID</code>
| <math>\leq</math>24 character string
| Always
| Run identification
| Any alpha-numeric
|- style="background:#efefef;"
| <code>[[NFOVER]]</code>
| integer
| Always
| Non-fatal error override option
| 0 or 1
|- style="background:#efefef;"
| <code>[[NABOUT]]</code>
| integer
| Always
| Logging level
| -1, 0, 1, 2, or 3
|- style="background:#efefef;"
| <code>[[NSCREEN]]</code>
| integer
| Always
| Logging output destination
| -1, 0, or 1
|}

===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 mode 
'''<code>[[NOLICA]]</code>''' - advection term mode 
'''<code>[[NOLICAT]]</code>''' - advection term mode 
'''<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 
'''<code>[[NTIP]]</code>''' - tidal potential forcing control 
'''<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]]

IM

2020-07-10T14:31:50Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=+}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55: Technical Preview|relation=+}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDigit-6 to 3. The default version (IMDigit-6=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

Fort.15 file format

2020-07-10T14:26:44Z

Wpringle: /* Namelists */

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===


{| class="wikitable" border="1" style="text-align: center"
|-
! Parameter
! Type
! Required?
! Description
! Values
|-
| <code>RUNDES</code>
| <math>\leq</math>32 character string
| Always
| Run description
| Any alpha-numeric
|- style="background:#efefef;"
| <code>RUNID</code>
| <math>\leq</math>24 character string
| Always
| Run identification
| Any alpha-numeric
|- style="background:#efefef;"
| <code>[[NFOVER]]</code>
| integer
| Always
| Non-fatal error override option
| 0 or 1
|- style="background:#efefef;"
| <code>[[NABOUT]]</code>
| integer
| Always
| Logging level
| -1, 0, 1, 2, or 3
|- style="background:#efefef;"
| <code>[[NSCREEN]]</code>
| integer
| Always
| Logging output destination
| -1, 0, or 1
|}

===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 mode 
'''<code>[[NOLICA]]</code>''' - advection term mode 
'''<code>[[NOLICAT]]</code>''' - advection term mode 
'''<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 
'''<code>[[NTIP]]</code>''' - tidal potential forcing control 
'''<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]]

IM

2020-07-10T14:24:20Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=eq}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55|relation=eq}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDigit-6 to 3. The default version (IMDigit-6=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

IM

2020-07-10T14:23:27Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=eq}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55|relation=eq}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDig6 to 3. The default version (IMDig=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

IM

2020-07-10T14:22:59Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=eq}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55|relation=eq}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

The most recent version (55+) also has an option that improves the (default) semi-implicit consistent GWCE mass matrix mode to include compute the complete (total depth) gravity wave term (free surface gradient) implicitly; toggled by setting IMDig6 to 3. The default version (IMDig=1), only computes the initial still water depth component of the free surface gradient implicitly, which might make it more susceptible to CFL violations in shallow depths and can encounter Matrix diagonality issues overland where the initial still water depth is negative.

== References ==
<references />

IM

2020-07-10T14:10:11Z

Wpringle:

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>; users should be aware that the <code>[[A00, B00, C00]]</code> coefficients must be specified differently in these two cases.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=eq}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55|relation=eq}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

== References ==
<references />

IM

2020-07-10T14:07:31Z

Wpringle: /* Six-digit IM Codes */

'''<code>IM</code>''' is an important parameter in the [[fort.15 file]] that defines numerical model formulation and dimension. Among other things, <code>IM</code> specifies whether ADCIRC is solved in two-dimensional depth-integrated (2DDI) or in three-dimensions (3D), solution of the governing equations is semi-implicit or explicit in time, and whether the model formulation is barotropic or baroclinic. Popular values for 2D barotropic ADCIRC include <code>IM=0</code> and <code>IM=111112</code>, though the latter also requires modifying <code>[[A00, B00, C00]]</code>.

== Default IM Values ==
Default simulation option combinations can be specified through single or double digit values, some of which are shortcuts to the six-digit codes described in the next heading.
The available <code>IM</code> values are specified in the table below and in the following section on 6-digit values:

{| class="wikitable" border="1"
|-
! IM Value
! Six-digit Equivalent
! Description
|-
| 0
| 111111
| Barotropic 2DDI
|-
| 1
| 611111
| Barotropic 3D velocity-based momentum
|-
| 2
| -
| Barotropic 3D stress-based momentum
|-
| 10
| -
| Barotropic 2DDI with passive scalar transport
|-
| 11
| -
| Barotropic 3D velocity-based momentum with passive scalar transport
|-
| 20
| 111113
| Baroclinic 2DDI
|-
| 21
| 611113
| Baroclinic 3D velocity-based momentum
|-
| 30
| -
| Baroclinic 2DDI with passive scalar transport
|-
| 31
| -
| Baroclinic 3D velocity-based momentum with passive scalar transport
|}

Note that all default <code>IM</code> values employ the semi-implicit consistent GWCE mass matrix solver. It has less numerical error and tends to be more stable than the explicit mass-lumping approach at the expense of computational time and memory.

== Six-digit IM Codes ==
For fine-grained control of various options six-digit codes for <code>IM</code> can be specified. Each digit represents a specific option regarding the dimension and the formulation of certain terms or integration methods in the GWCE or momentum equations.
The available options for each digit are specified below, with the first digit being the left-most. The internal flags that are set are listed to help users dig through the code.

{| class="wikitable" border="1"
|-
! Value
! Digit 1: 2DDI/3D, Lateral Stress in GWCE<ref name=Kendra1>K.M. Dresback, R.L. Kolar, R.A. Luettich, Jr. (2005). On the Form of the Momentum Equation and Lateral Stress Closure Law in Shallow Water Modeling, in: Estuar. Coast. Model., American Society of Civil Engineers, Reston, VA, 399–418. doi:10.1061/40876(209)23</ref>
! Digit 2: Advection in GWCE<ref name=Kendra2>K.M. Dresback, R.L. Kolar, J.C. Dietrich (2005). On the Form of the Momentum Equation for Shallow Water Models Based on the Generalized Wave Continuity Equation: Conservative vs. Non-Conservative. Advances in Water Resources, 28(4), 345-358. doi:10.1016/j.advwatres.2004.11.011</ref>
! Digit 3: Lateral Stress in Momentum<ref name=Kendra1></ref>
! Digit 4: Advection in Momentum<ref name=Kendra2></ref>
! Digit 5: Area Integration in Momentum
! Digit 6: GWCE Mass Matrix, Barotropic/Baroclinic
|-
| 1 (default)
| 2DDI, Kolar-Gray flux-based <code>CGWCE_LS_KGQ=.TRUE.</code>
| Non conservative <code>CGWCE_Advec_NC=.TRUE.</code>
| Integration by parts, velocity-based <code>CME_LS_IBPV=.TRUE.</code>
| Non conservative <code>CME_New_NC=.TRUE.</code>
| Corrected <code>CME_AreaInt_Corr=.TRUE.</code>
| Consistent (implicit for linear part of gravity wave term), barotropic <code>ILump=0</code>
|-
| 2
| 2DDI, 2-part flux-based <code>CGWCE_LS_2PartQ=.TRUE.</code>
| Conservative form 1 <code>CGWCE_Advec_C1=.TRUE.</code>
| Integration by parts, flux-based <code>CME_LS_IBPQ=.TRUE.</code>
| Conservative form 1 <code>CME_New_C1=.TRUE.</code>
| Original <code>CME_AreaInt_Orig=.TRUE.</code>
| Lumped (explicit), barotropic <code>CGWCE_Lump=.TRUE.</code>, <code>ILump=1</code>
|-
| 3
| 2DDI, 2-part velocity-based <code>CGWCE_LS_2PartV=.TRUE.</code>
| Conservative form 2 <code>CGWCE_Advec_C2=.TRUE.</code>
| Integration by parts, velocity-based symmetrical <code>CME_LS_IBPSV=.TRUE.</code>
| Conservative form 2 <code>CME_New_C2=.TRUE.</code>
| -
| Consistent (implicit for full gravity wave term), barotropic <code>CGWCE_HDP=.TRUE.</code>, <code>IFNL_HDP=1</code>, <code>ILump=0</code> {{ADC version|version=55|relation=eq}}
|-
| 4
| 2DDI, 2-part flux-based symmetrical <code>CGWCE_LS_2PartSQ=.TRUE.</code>
| -
| Integration by parts, flux-based symmetrical <code>CME_LS_IBPSQ=.TRUE.</code>
| -
| -
| A value of 4-6 does the same as 1-3 (same order) but in baroclinic mode <code>CBaroclinic=.TRUE.</code> {{ADC version|version=55|relation=eq}}
|-
| 5
| 2DDI, 2-part velocity-based symmetrical <code>CGWCE_LS_2PartSV=.TRUE.</code>
| -
| 2 Part, velocity-based (''not implemented'') <code>CME_LS_2PartV=.TRUE.</code>
| -
| -
| -
|-
| 6
| 3D, Kolar-Gray flux-based <code>C2DDI=.FALSE.</code>, <code>CGWCE_LS_KGQ=.TRUE.</code>, <code>C3D=.TRUE.</code>, <code>C3DVS=.TRUE.</code>, <code>ILump=0</code>
| -
| 2 Part, flux-based (''not implemented'') <code>CME_LS_2PartQ=.TRUE.</code>
| -
| -
| See above
|}

A common code combination is <code>IM=111112</code>, which is identical to the default <code>111111</code> (same as <code>IM=0</code>), but simulates in explicit mass-lumping mode. Note that <code>[[A00, B00, C00]]</code> must be set to <code>0.0 1.0 0.0</code> when in this mode. Lumped explicit mode is a useful alternative to the (default) semi-implicit consistent GWCE mass matrix mode, because the latter requires a matrix solve that increases computational time and memory. By comparison, the explicit mass-lumping mode is about twice as fast and scales to fewer grid nodes per computational core.<ref>S. Tanaka, S. Bunya, J.J. Westerink, C. Dawson, R.A. Luettich, Scalability of an Unstructured Grid Continuous Galerkin Based Hurricane Storm Surge Model, J. Sci. Comput. 46 (2011) 329–358. doi:10.1007/s10915-010-9402-1</ref> Moreover, for model setups that are sufficiently resolved in space and time, differences in the solution between approaches should be small. Though, many users have reported somewhat lower stability in lumped explicit mode.

== References ==
<references />

Global Astronomical M2 Tide

2020-07-06T21:37:34Z

Wpringle: /* Options/Features Tested */

This example tests ADCIRC version 55 (and beyond). It tests the simulation of the astronomical M2 tidal constituent on the spherical Earth under equilibrium tidal forcing with the inclusion of the self-attraction and loading tide. The results of interest are the M2 tidal constituent amplitudes and phases of elevations and velocities from the least-squares harmonic analysis. 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-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 forcing (read from a [[fort.24 file]]).
*<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>[[NHAGE]]</code> = 5: outputs the harmonic constituent elevations into a netCDF4 [[fort.53 file]].
*<code>[[NHAGV]]</code> = 5: outputs the harmonic constituent velocities into a netCDF4 [[fort.54 file]].
*[[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.

Fort.200 file format

2020-06-29T23:13:53Z

Wpringle: /* File Structure */

The basic file structure is shown below. 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 = 10 or 110 or 10010 =

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

: [[PG(k)]], [[UG(k)]], [[VG(k)]] , ''if NWS=10010:'' [[IG(k)]]

end k loop

'''Key:''' 
[[PG(k)]]: surface pressure (Pa) 
[[UG(k)]]: U10 wind speed (m/s) 
[[VG(k)]]: V10 wind speed (m/s) 
{{ADC version|version=55|relation=ge}} [[IG(k)]]: ice concentration (0-1 decimal fraction)

==Notes==
NWS = 10, US National Climatic Data Center (NCDC) Global Forecast System (GFS) model

Meteorological data is input to a T1534, Gaussian grid (NWLON*NWLAT is hardwired to 3072*1536 = 4,718,592) and interpolated in space onto the ADCIRC mesh. Data are ordered in these files the same way they are generated by the degribbing program.

The met data are contained in a sequence of files with names as follows: 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 (e.g., at 6 hr intervals this would be fort.200, fort.206, fort.212, etc.). N is determined as N = WTIMINC/3600 where WTIMINC is the meteorological data time interval (in seconds) and is specified in the Model Parameter and Periodic Boundary Condition File. WTIMINC must be evenly divisible by 3600.

If the model is cold started, it is assumed that the winds are at rest at the beginning of the model run and no data file (fort.200) is read corresponding to TIME=STATIM. Rather, the first required data file (fort.200+N) corresponds to TIME=STATIM+WTIMINC. If the model is hot started, an initial file (fort.200) is required corresponding to TIME=HOT START TIME. In either case, additional sets of meteorological data must be provided every WTIMINC, in appropriately named files. Meteorological 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. 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.

WIND_SPEED = magnitude of WIND_VEL

DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)

If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003

WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED

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

PRESSURE{m H2O}=PRESSURE{Pascal}/(GRAVITY*DENSITY of H2O)

=NWS = 11 or 111=

==File Structure==
for k=1, 8

: IYEAR, IMONTH, IDAY, IHOUR

: for j=1, [[LONB*LATB]]

:: [[UE(j)]], [[VE(j)]], [[PE(j)]]

: end j loop

end k loop

==Notes==
NWS = 11, 111 – National Weather Service Eta-29 file.

Meteorological data is input to the standard Eta-29 “E” grid, (non-cartesian grid, NWLON*NWLAT is hardwired to 181*271 = 49,051), and interpolated in space onto the ADCIRC grid. The ADCIRC grid must be in lon, lat coordinates.

The met data are contained in a sequence of files with names: fort.200, fort.201, fort.202, fort.203,…., Each file contains 8 data sets spaced 3 hrs apart in time (WTIMINC is the met. data time interval = 3600*3 = 10800 sec) for a total of 1 day of data per file. The first and last data sets in each file are assumed to correspond to 03:00 hrs and 24:00 hrs, respectively, on the day of the file. If the model is cold started, it is assumed that the winds are at rest at the beginning of the model run and no data file (fort.200) is read corresponding to TIME=STATIM. Rather, the initial data set in the first required data file (fort.201) corresponds to TIME=STATIM+WTIMINC. If the model is hot started, an initial file (fort.200) is required in which the last data set corresponds to TIME=HOT START TIME. In either case, 8 sets of met. data must be provided every
WTIMINC in each file and appropriately named files must be provided for each day of the model run. Met data is interpolated in time to the ADCIRC time step.

The file type is binary: ACCESS=’sequential’, FORM=’unformatted’

Wind velocity (@ 10 m above the water surface) must be input in units of m/s oriented along the E grid coordinate directions. Surface atmospheric pressure must be input in units of millibars.

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

WIND_SPEED = magnitude of WIND_VEL

DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)

If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003

WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED

The following relationship is used in ADCIRC to convert to pressure in meters of water from pressure in millibars.

PRESSURE{m H2O}=PRESSURE{millibars}/(100*GRAVITY*DENSITY of H2O)

The integer values IYEAR, IMONTH, IDAY, IHOUR are read in and ignored by ADCIRC.

=General Note=

Meteorological data must be provided for the entire model run, otherwise the run will crash.

Fort.200 file format

2020-06-29T23:12:57Z

Wpringle: /* NWS = 10 or 110 */

The basic file structure is shown below. 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 = 10 or 110 or 10010 =

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

: [[PG(k)]], [[UG(k)]], [[VG(k)]] , ''if NWS=10010:'' [[IG(k)]]

end k loop

Key: 
[[PG(k)]]: surface pressure (Pa) 
[[UG(k)]]: U10 wind speed (m/s) 
[[VG(k)]]: V10 wind speed (m/s) 
{{ADC version|version=55|relation=ge}} [[IG(k)]]: ice concentration (0-1 decimal fraction)

==Notes==
NWS = 10, US National Climatic Data Center (NCDC) Global Forecast System (GFS) model

Meteorological data is input to a T1534, Gaussian grid (NWLON*NWLAT is hardwired to 3072*1536 = 4,718,592) and interpolated in space onto the ADCIRC mesh. Data are ordered in these files the same way they are generated by the degribbing program.

The met data are contained in a sequence of files with names as follows: 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 (e.g., at 6 hr intervals this would be fort.200, fort.206, fort.212, etc.). N is determined as N = WTIMINC/3600 where WTIMINC is the meteorological data time interval (in seconds) and is specified in the Model Parameter and Periodic Boundary Condition File. WTIMINC must be evenly divisible by 3600.

If the model is cold started, it is assumed that the winds are at rest at the beginning of the model run and no data file (fort.200) is read corresponding to TIME=STATIM. Rather, the first required data file (fort.200+N) corresponds to TIME=STATIM+WTIMINC. If the model is hot started, an initial file (fort.200) is required corresponding to TIME=HOT START TIME. In either case, additional sets of meteorological data must be provided every WTIMINC, in appropriately named files. Meteorological 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. 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.

WIND_SPEED = magnitude of WIND_VEL

DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)

If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003

WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED

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

PRESSURE{m H2O}=PRESSURE{Pascal}/(GRAVITY*DENSITY of H2O)

=NWS = 11 or 111=

==File Structure==
for k=1, 8

: IYEAR, IMONTH, IDAY, IHOUR

: for j=1, [[LONB*LATB]]

:: [[UE(j)]], [[VE(j)]], [[PE(j)]]

: end j loop

end k loop

==Notes==
NWS = 11, 111 – National Weather Service Eta-29 file.

Meteorological data is input to the standard Eta-29 “E” grid, (non-cartesian grid, NWLON*NWLAT is hardwired to 181*271 = 49,051), and interpolated in space onto the ADCIRC grid. The ADCIRC grid must be in lon, lat coordinates.

The met data are contained in a sequence of files with names: fort.200, fort.201, fort.202, fort.203,…., Each file contains 8 data sets spaced 3 hrs apart in time (WTIMINC is the met. data time interval = 3600*3 = 10800 sec) for a total of 1 day of data per file. The first and last data sets in each file are assumed to correspond to 03:00 hrs and 24:00 hrs, respectively, on the day of the file. If the model is cold started, it is assumed that the winds are at rest at the beginning of the model run and no data file (fort.200) is read corresponding to TIME=STATIM. Rather, the initial data set in the first required data file (fort.201) corresponds to TIME=STATIM+WTIMINC. If the model is hot started, an initial file (fort.200) is required in which the last data set corresponds to TIME=HOT START TIME. In either case, 8 sets of met. data must be provided every
WTIMINC in each file and appropriately named files must be provided for each day of the model run. Met data is interpolated in time to the ADCIRC time step.

The file type is binary: ACCESS=’sequential’, FORM=’unformatted’

Wind velocity (@ 10 m above the water surface) must be input in units of m/s oriented along the E grid coordinate directions. Surface atmospheric pressure must be input in units of millibars.

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

WIND_SPEED = magnitude of WIND_VEL

DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)

If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003

WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED

The following relationship is used in ADCIRC to convert to pressure in meters of water from pressure in millibars.

PRESSURE{m H2O}=PRESSURE{millibars}/(100*GRAVITY*DENSITY of H2O)

The integer values IYEAR, IMONTH, IDAY, IHOUR are read in and ignored by ADCIRC.

=General Note=

Meteorological data must be provided for the entire model run, otherwise the run will crash.

Fort.200 file format

2020-06-29T23:07:10Z

Wpringle: /* File Structure */

The basic file structure is shown below. 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 = 10 or 110=

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

: [[PG(k)]], [[UG(k)]], [[VG(k)]] , ''optional:'' [[IG(k)]]

end k loop

==Notes==
NWS = 10, US National Climatic Data Center (NCDC) Global Forecast System (GFS) model

Meteorological data is input to a T1534, Gaussian grid (NWLON*NWLAT is hardwired to 3072*1536 = 4,718,592) and interpolated in space onto the ADCIRC mesh. Data are ordered in these files the same way they are generated by the degribbing program.

The met data are contained in a sequence of files with names as follows: 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 (e.g., at 6 hr intervals this would be fort.200, fort.206, fort.212, etc.). N is determined as N = WTIMINC/3600 where WTIMINC is the meteorological data time interval (in seconds) and is specified in the Model Parameter and Periodic Boundary Condition File. WTIMINC must be evenly divisible by 3600.

If the model is cold started, it is assumed that the winds are at rest at the beginning of the model run and no data file (fort.200) is read corresponding to TIME=STATIM. Rather, the first required data file (fort.200+N) corresponds to TIME=STATIM+WTIMINC. If the model is hot started, an initial file (fort.200) is required corresponding to TIME=HOT START TIME. In either case, additional sets of meteorological data must be provided every WTIMINC, in appropriately named files. Meteorological 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. 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.

WIND_SPEED = magnitude of WIND_VEL

DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)

If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003

WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED

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

PRESSURE{m H2O}=PRESSURE{Pascal}/(GRAVITY*DENSITY of H2O)

=NWS = 11 or 111=

==File Structure==
for k=1, 8

: IYEAR, IMONTH, IDAY, IHOUR

: for j=1, [[LONB*LATB]]

:: [[UE(j)]], [[VE(j)]], [[PE(j)]]

: end j loop

end k loop

==Notes==
NWS = 11, 111 – National Weather Service Eta-29 file.

Meteorological data is input to the standard Eta-29 “E” grid, (non-cartesian grid, NWLON*NWLAT is hardwired to 181*271 = 49,051), and interpolated in space onto the ADCIRC grid. The ADCIRC grid must be in lon, lat coordinates.

The met data are contained in a sequence of files with names: fort.200, fort.201, fort.202, fort.203,…., Each file contains 8 data sets spaced 3 hrs apart in time (WTIMINC is the met. data time interval = 3600*3 = 10800 sec) for a total of 1 day of data per file. The first and last data sets in each file are assumed to correspond to 03:00 hrs and 24:00 hrs, respectively, on the day of the file. If the model is cold started, it is assumed that the winds are at rest at the beginning of the model run and no data file (fort.200) is read corresponding to TIME=STATIM. Rather, the initial data set in the first required data file (fort.201) corresponds to TIME=STATIM+WTIMINC. If the model is hot started, an initial file (fort.200) is required in which the last data set corresponds to TIME=HOT START TIME. In either case, 8 sets of met. data must be provided every
WTIMINC in each file and appropriately named files must be provided for each day of the model run. Met data is interpolated in time to the ADCIRC time step.

The file type is binary: ACCESS=’sequential’, FORM=’unformatted’

Wind velocity (@ 10 m above the water surface) must be input in units of m/s oriented along the E grid coordinate directions. Surface atmospheric pressure must be input in units of millibars.

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

WIND_SPEED = magnitude of WIND_VEL

DRAG_COEFF = 0.001*(0.75+0.067*WIND_SPEED)

If (DRAG_COEFF.gt.0.003) DRAG_COEFF=0.003

WIND_STRESS = DRAG_COEFF*0.001293*WIND_VEL*WIND_SPEED

The following relationship is used in ADCIRC to convert to pressure in meters of water from pressure in millibars.

PRESSURE{m H2O}=PRESSURE{millibars}/(100*GRAVITY*DENSITY of H2O)

The integer values IYEAR, IMONTH, IDAY, IHOUR are read in and ignored by ADCIRC.

=General Note=

Meteorological data must be provided for the entire model run, otherwise the run will crash.

NWS

2020-06-29T23:04:35Z

Wpringle: /* Extended NWS with Ice + Waves */

'''<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_format#NWS_.3D_14|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 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" />

NWS

2020-06-26T21:46:47Z

Wpringle: /* Extended NWS with Ice + Waves */

'''<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_format#NWS_.3D_14|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 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
| 14010 (GRIB2/NetCDF format ice)
| 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" />

File:Channel Elev.gif

2020-06-09T02:10:50Z

Wpringle: Wpringle uploaded a new version of File:Channel Elev.gif

== Summary ==
Elevation time series for the idealized channel problem

Idealized Channel Problem

2020-06-09T02:08:50Z

Wpringle:

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Note that the short 6 hour length of the test is chosen only to limit simulation time for the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite] where the test case been found. Users may extend the simulation length to simulate more of the inundating phase of the incoming wave.

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1000px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

[[File:Channel_Elev.gif|500px|thumb|Elevation time series for the idealized channel problem]] [[File:Channel_Vel.gif|500px|thumb|North-south velocity time series for the idealized channel problem]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files. [[Grid_Development_and_Editing#OceanMesh2D|OceanMesh2D]] functions can be used to automatically generate the sponge_generator_layer attribute ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Calc_Sponge.m Calc_Sponge]) and the input files ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Make_f5354.m Make_f5354]).
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-09T02:07:51Z

Wpringle: /* Options/Features Tested */

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Note that the short 6 hour length of the test is chosen only to limit simulation time for the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite] where the test case been found. Users may extend the simulation length to simulate the inundating phase of the incoming wave.

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1000px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

[[File:Channel_Elev.gif|500px|thumb|Elevation time series for the idealized channel problem]] [[File:Channel_Vel.gif|500px|thumb|North-south velocity time series for the idealized channel problem]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files. [[Grid_Development_and_Editing#OceanMesh2D|OceanMesh2D]] functions can be used to automatically generate the sponge_generator_layer attribute ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Calc_Sponge.m Calc_Sponge]) and the input files ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Make_f5354.m Make_f5354]).
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-09T02:06:07Z

Wpringle: /* Options/Features Tested */

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Note that the short 6 hour length of the test is chosen only to limit simulation time for the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite] where the test case been found. Users may extend the simulation length to simulate the inundating phase of the incoming wave.

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1000px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

[[File:Channel_Elev.gif|500px|thumb|Elevation time series for the idealized channel problem]] [[File:Channel_Vel.gif|500px|thumb|North-south velocity time series for the idealized channel problem]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files. [[OceanMesh2D]] functions exist for generating the sponge_generator_layer attribute ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Calc_Sponge.m Calc_Sponge]), and the input files ([https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/utilities/Make_f5354.m Make_f5354]).
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-09T02:01:58Z

Wpringle:

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Note that the short 6 hour length of the test is chosen only to limit simulation time for the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite] where the test case been found. Users may extend the simulation length to simulate the inundating phase of the incoming wave.

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1000px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

[[File:Channel_Elev.gif|500px|thumb|Elevation time series for the idealized channel problem]] [[File:Channel_Vel.gif|500px|thumb|North-south velocity time series for the idealized channel problem]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-09T02:01:35Z

Wpringle:

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Note that the short 6 hour length of the test is chosen to only limit simulation time for the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite] where the test case been found. Users may extend the simulation length to simulate the inundating phase of the incoming wave.

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1000px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

[[File:Channel_Elev.gif|500px|thumb|Elevation time series for the idealized channel problem]] [[File:Channel_Vel.gif|500px|thumb|North-south velocity time series for the idealized channel problem]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-09T01:58:02Z

Wpringle:

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite].

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1000px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

[[File:Channel_Elev.gif|500px|thumb|Elevation time series for the idealized channel problem]] [[File:Channel_Vel.gif|500px|thumb|North-south velocity time series for the idealized channel problem]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

File:Channel Vel.gif

2020-06-09T01:51:54Z

Wpringle: North-south velocity time series for the idealized channel problem

== Summary ==
North-south velocity time series for the idealized channel problem

File:Channel Elev.gif

2020-06-09T01:46:40Z

Wpringle: Elevation time series for the idealized channel problem

== Summary ==
Elevation time series for the idealized channel problem

Alaskan Winter Storm with Ice

2020-06-08T23:43:52Z

Wpringle:

This example tests ADCIRC version 55 (and beyond). It tests the simulation of the storm tides in a regional Alaska domain under astronomical and atmospheric forcing in November 2011 during a strong winter storm in the presence of sea ice (affecting the surface wind drag)<ref name=Brian>Joyce, B.R., Pringle, W.J., Wirasaet, D., Westerink, J.J., Van der Westhuysen, A.J., Grumbine, R., Feyen, J., 2019. High resolution modeling of western Alaskan tides and storm surge under varying sea ice conditions. Ocean Model. 141, 101421. doi:10.1016/j.ocemod.2019.101421</ref>. The results of interest are the global elevations, velocities and meteorology. The test finishes in about 5 minutes in serial ADCIRC for two weeks of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_alaska_ice-2d GitHub test suite].

== Mesh ==
The mesh was generated using the OceanMesh2D Alaska [https://github.com/CHLNDDEV/OceanMesh2D/blob/Projection/Examples/Example_8_AK.m Example_8_AK.m]. The domain encompasses the Gulf of Alaska, Bering Sea, and Chukchi Sea with a minimum resolution of 5 km, comprised of 15,876 vertices and 27,757 triangular elements.

== Options/Features Tested ==
*<code>[[ICS]]</code> = 20: Equal-Area cylindrical projection.
*<code>[[IM]]</code> = 513111: Uses the implicit scheme for the linear component of the gravity wave term (computational time step is 4 minutes).
*<code>[[NTIP]]</code> = 2: Equilibrium tide + self-attraction and loading tide (read from a [[fort.24 file]]) forcing for 8 tidal constituents.
*<code>[[NWS]]</code> = 14014: Reads from GRIB2 files that specify the global atmospheric forcing and sea-ice concentration (6-hourly CFSv2 reanalysis data). Sea-ice concentration affects the wind drag coefficient<ref name=Brian></ref>.
*<code>[[WTIMINC]]</code> = 21600, 21600: First value gives the temporal interval of the GRIB2 met data (6 hours), second value gives the temporal interval of the GRIB2 ice data (6 hours) - these should always be the same.
*<code>[[A00, B00, C00]]</code> = 0.4, 0.4, 0.2: Ensures that the implicit scheme is stable with a fairly 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.15_file_format#Namelists|&WarnElevControl namelist]]: Set "WarnElev", the warning elevation level, to 30-m (elevations reach beyond 20-m [default] but remain below 30-m).
*[[Fort.15_file_format#Namelists|&metControl namelist]]: Set "rhoAir", to 1.29193 (density of air at 0 deg C for 1013 mbar); set "WindDragLimit" equal to 0.0025; set "invertedBarometerOnElevationBoundary" to true (in Alaska extremely large-scale low pressure systems persist and cross over the open boundaries, so it is important to have the inverted barometer condition along the elevation specified boundary); set "outputWindDrag" to true.

== References ==
<references />

Fort.14 file format

2020-06-08T23:38:55Z

Wpringle:

The basic file structure is shown below. 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.

[[AGRID]]

[[NE]], [[NP]]

for k=1 to [[NP]]
: [[JN]], [[X(JN)]], [[Y(JN)]], [[DP(JN)]]
end k loop

for k=1 to [[NE]]
: [[JE]], [[NHY]], [[NM(JE,1),NM(JE,2), NM(JE,3)]]
end k loop

[[NOPE]]

[[NETA]]

for k=1 to [[NOPE]]
: [[NVDLL(k)]], [[IBTYPEE(k)]]
: for j=1 to [[NVDLL(k)]]
:: [[NBDV(k,j)]]
:end j loop
end k loop

[[NBOU]]

[[NVEL]]

for k=1 to [[NBOU]]
: [[NVELL(k)]], IBTYPE(k)
: for j=1,NVELL(k)
:: [[NBVV(k,j)]] include this line only if [[IBTYPE(k)]] = 0, 1, 2, 10, 11, 12, 20, 21, 22, 30
:: [[NBVV(k,j)]], [[IBCONN(k,j)]] include this line only if [[IBTYPE(k)]] = 94
:: [[NBVV(k,j)]], [[BARLANHT(k,j)]], [[BARLANCFSP(k,j)]] include this line only if IBTYPE(k) = 3, 13, 23
:: [[NBVV(k,j)]], [[IBCONN(k,j)]], [[BARINHT(k,j)]], [[BARINCFSB(k,j)]], [[BARINCFSP(k,j)]] include this line only if IBTYPE(k) = 4, 24
:: [[NBVV(k,j)]], [[IBCONN(k,j)]], [[BARINHT(k,j)]], [[BARINCFSB(k,j)]], [[BARINCFSP(k,j)]], [[PIPEHT(k,j)]], [[PIPECOEF(k,j)]], [[PIPEDIAM(k,j)]], include this line only if IBTYPE(k) = 5, 25
:end j loop
end k loop

Idealized Channel Problem

2020-06-08T23:34:10Z

Wpringle: /* Options/Features Tested */

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite].

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1750px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.
*[[Fort.14_file_format|IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-08T23:33:45Z

Wpringle: /* Options/Features Tested */

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite].

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1750px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.
*[[Fort.14_file_format IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-08T23:32:14Z

Wpringle: /* Options/Features Tested */

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite].

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1750px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.
[[IBTYPE=94]]: Node pairs are matched along opposite lateral boundaries where a periodic (repeating) boundary condition is applied.

== References ==
<references />

Idealized Channel Problem

2020-06-08T23:28:12Z

Wpringle:

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite].

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1750px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.

== References ==
<references />

Idealized Channel Problem

2020-06-08T23:26:39Z

Wpringle: /* Mesh */

This example tests ADCIRC version 55 (and beyond). It tests the simulation of a diurnal tide on a sloping beach with a channel along its centerline (adapted from<ref name=Keith>Roberts, K.J., Dietrich, J.C., Wirasaet, D., Pringle, W.J., Westerink, J.J., 2020. Dynamic Load Balancing for Predictions of Storm Surge and Coastal Flooding. In Preparation, pp.37.</ref>). It tests lateral periodic boundary conditions and the absorption-generation sponge layer<ref name=Pringle>Pringle, W.J., Wirasaet, D., Suhardjo, A., Meixner, J., Westerink, J.J., Kennedy, A.B., Nong, S., 2018. Finite-Element Barotropic Model for the Indian and Western Pacific Oceans: Tidal Model-Data Comparisons and Sensitivities. Ocean Model. 129, 13–38. doi:10.1016/j.ocemod.2018.07.003</ref><ref name=Pringle2>Pringle, W.J., Gonzalez-lopez, J., Joyce, B., Westerink, J.J., van der Westhuysen, A.J., 2019. Baroclinic Coupling Improves Depth-Integrated Modeling of Coastal Sea Level Variations around Puerto Rico and the U.S. Virgin Islands. J. Geophys. Res. Ocean. 124, 2196–2217. doi:10.1029/2018JC014682</ref>. The test finishes in about 8 minutes in parallel ADCIRC (2 processors) for 6 hours of simulation. Find the test at the [https://github.com/adcirc/adcirc-cg-testsuite/tree/v55/adcirc/adcirc_ideal_channel-2d-parallel GitHub test suite].

== Mesh ==
The mesh is comprised of 64,415 vertices and 127,784 triangular elements, with resolution in the 10-60 m range. The mesh is symmetrical in the east-west direction so that the east and west lateral boundary vertices match for the application of the periodic lateral boundary conditions. An elevation specified boundary condition and absorption-generation sponge layer is prescribed at the southern end of the domain.

[[File:IdealChannel.png|1750px|thumb|Left: Mesh triangulation and resolution. Blue line shows the elevation specified boundary condition location, green and yellow lines on the sides show the periodic lateral boundary condition locations. Center: Mesh topo-bathy. Right: The sponge strength coefficients.]]

== Options/Features Tested ==
*<code>[[IM]]</code> = 111112: Uses the explicit scheme (computational time step is 2 seconds).
*<code>[[A00, B00, C00]]</code> = 0.0, 1.0, 0.0: Must be used with explicit scheme.
*<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#Absorption-generation_Sponge_Layer|sponge_generator_layer]]: Applies a sponge layer to absorb outgoing waves while generating incoming waves. In this case incoming diurnal tidal waves are generated using the [[fort.53001]] and [[fort.54001]] input files.

== References ==
<references />

Idealized Channel Problem

2020-06-08T23:23:40Z

Wpringle: /* Mesh */