https://www.xmswiki.com/api.php?action=feedcontributions&user=Rcorrigan&feedformat=atomXMS Wiki - User contributions [en]2024-03-29T08:53:49ZUser contributionsMediaWiki 1.39.0https://www.xmswiki.com/index.php?title=User:Rcorrigan/Edits_Riley_didn%27t_finish&diff=157070User:Rcorrigan/Edits Riley didn't finish2022-11-11T00:02:46Z<p>Rcorrigan: Created page with "3D INTERPOLATION OPTIONS The ''3D Interpolation Options'' dialog. 3D scatter point sets are used..."</p>
<hr />
<div>3D INTERPOLATION OPTIONS<br />
[[File:3DinterpolationOpts.jpg|thumb|500 px|The ''3D Interpolation Options'' dialog.]]<br />
<br />
[[GMS:3D Scatter Point Module|3D scatter point]] sets are used for [[GMS:Interpolation|interpolation]] to other data types such as grids and meshes. Interpolation is useful for such tasks as isosurface rendering or setting up input data for a model. Since no interpolation scheme is superior in all cases, several interpolation techniques are provided in GMS.<br />
<br />
The basic approach to performing an interpolation is to select an appropriate interpolation scheme and interpolation parameters, and then interpolate to the desired object using one of the interpolation commands (to [[GMS:3D Grid Module|3D grid]], to [[GMS:3D Mesh Module|3D mesh]], etc.) described below.<br />
<br />
The interpolation options are selected using the ''3D Interpolation Options'' dialog which is accessed through the '''Interpolation Options''' command in the ''Interpolation'' menu. The ''Interpolation'' menu appears when a scatter set item is active in the Project Explorer. Once a set of options is selected, those options are used for all subsequent interpolation commands. The options in the ''3D Interpolation Options'' dialog are as follows:<br />
<br />
==Active Dataset==<br />
Interpolation is always performed using the active [[GMS:Datasets|dataset]] of the active scatter point set. The active dataset is normally selected in the [[GMS:The GMS Window|Project Explorer]]. The name of the current active dataset is listed at the top of the ''3D Interpolation Options'' dialog in the ''Interpolating from'' section.<br />
<br />
''Object'' displays the name of the active 3D scatter item, and ''Dataset'' displays the name of the 3D scatter dataset. <br />
<br />
If the active dataset is transient then more interpolation options are available.<br />
<br />
{{Steady State vs. Transient Interpolation}}<br />
<br />
==Interpolation Methods==<br />
{{GMS 3D Interpolation Methods}}<br />
<br />
==Anisotropy==<br />
Sometimes the data associated with a scatter point set will have directional tendencies. The ''Azimuth'' and ''Horizontal Anisotropy'' allow taking into account these tendencies. <br />
<br />
===Vertical Anisotropy===<br />
In 3D, vertical anisotropy is also available. In previous versions of GMS it was possible to enter a Z scale. Vertical anisotropy is 1 over the Z scale. This notation was changed to be consistent with Kriging.<br />
<br />
Occasionally, scatter point sets are sampled along vertical traces. In such cases, the distances between scatter points along the vertical traces are an order of magnitude smaller than the distances between scatter points along the horizontal plane. For example, if the scatter point set was obtained from borehole data, the distance between scatter points may be a few centimeters, whereas the distance between boreholes may be several meters. This disparity in scaling causes clustering and can be a source of poor results in some interpolation methods.<br />
<br />
The effects of clustering along vertical traces can be minimized using the vertical anisotropy option in the ''3D Interpolation Options'' dialog. The Z coordinate of each of the scatter points is multiplied by 1 divided by the vertical anisotropy parameter prior to interpolation. Thus, if the vertical anisotropy parameter is less than 1.0, scatter points along the same vertical axis appear farther apart than they really are and scatter points in the same horizontal plane appear closer than they really are. As a result, points in the same horizontal plane are given a higher relative weight than points along the Z axis. This can result in improved accuracy, especially in cases where the horizontal correlation between scatter points is expected to be greater than the vertical correlation (which is typically the case in soils since soils are deposited in horizontal layers).<br />
<br />
== Extrapolation ==<br />
Although they are referred to as interpolation schemes, most of the schemes supported by GMS perform both interpolation and extrapolation. That is, they can estimate a value at points both inside and outside the scatter point set. Obviously, the interpolated values are more accurate than the extrapolated values. Nevertheless, it is often necessary to perform extrapolation. Some of the schemes, however, perform interpolation but cannot be used for extrapolation. Interpolation points outside the scatter set are assigned the ''Default extrapolation value''.<br />
<br />
===Assign default extrapolation value to hidden objects===<br />
This option will assign the default extrapolation value to all cells that are hidden using the '''Hide''' command in the ''Display'' | '''Visibility''' menu option (see [[GMS:Display Menu|Display Menu]]).<br />
<br />
<!--===Assign default extrapolation value to unloaded subdomains===--><br />
<br />
==Truncation==<br />
When interpolating a set of values, it is sometimes useful to limit the interpolated values to lie between a minimum and maximum value. For example, when interpolating contaminant concentrations, a negative value of concentration is meaningless. However, many interpolation schemes will produce negative values even if all of the scatter points have positive values. This occurs in areas where the trend in the data is toward a zero value. The interpolation may extend the trend beyond a zero value into the negative range. In such cases it is useful to limit the minimum interpolated value to zero. Interpolated values can be limited to a given range by selecting the ''Truncate values'' option in the ''3D Interpolation Options'' dialog. The minimum and maximum values can either set according to the minimum and maximum of the dataset or according to specified range.<br />
<br />
== Related Topics ==<br />
*[[GMS:2D Interpolation Options|2D Interpolation Options]]<br />
<br />
<br />
{{Navbox GMS}}<br />
<br />
[[Category:Interpolation]]<br />
[[Category:Interpolation Dialogs|3]]<br />
[[Category:3D Scatter Point]]<br />
<br />
<br />
UGRID INVERSE DISTANCE WEIGHTED INTERPOLATION<br />
[[File:Interpolate-IDW.png|thumb|300 px|The ''Interpolate &ndash; Inverse Distance Weighted'' dialog.]]<br />
One of the most commonly used techniques for interpolation of point data is inverse distance weighted (IDW) interpolation. Inverse distance weighted methods are based on the assumption that the interpolating surface should be influenced most by the nearby points and less by the more distant points. The interpolated surface is a weighted average of the point data; the weight assigned to each point diminishes as the distance to the interpolation location increases. Several options are available for inverse distance weighted interpolation. The options are selected using the ''IDW Interpolation Options'' dialog. This dialog is accessed through the '''Options''' button next to the ''Inverse distance weighted'' item in the ''Interpolate UGrid to UGrid'' dialog. <br />
<br />
The options in the dialog are as follows:<br />
*''Nodal function''<br />
**[[GMS:Shepard's Method|Constant (Shepard's Method)]] &ndash; The simplest form of inverse distance weighted interpolation. Includes the option to ''Use classic weight function'' to enter a ''Weighting exponent''.<br />
**[[GMS:Gradient Plane Nodal Functions|Gradient Plane Nodal Functions]] &ndash; Variation of Shepard's method with nodal functions or individual functions defined at each point<br />
**[[GMS:Quadratic Nodal Functions|Quadratic Nodal Functions]] &ndash; Makes use of quadratic polynomials to constrain nodal functions. <br />
*''Computation of nodal function coefficients'' &ndash; Uses a subset of the data points. Using a subset of the data points drops distant points from consideration since they are unlikely to have a large influence on the nodal function. In addition, using a subset can speed up the computations since less points are involved. Two options are available for defining which points are included in the subset. In the first approach, only the nearest ''N'' points are used. In the second approach, only the nearest ''N'' points in each quadrant are used as illustrated in the figure below. The second approach may give better results if the data points tend to be clustered.<br />
*''Computation of interpolation weights'' &ndash; Uses a subset of the data points as with the ''Computation of nodal function coefficients'' section.<br />
*''Truncate values'' &ndash; This section allows for limiting the interpolated values to lie between the minimum and maximum value.<br />
**''Truncate to min/max of dataset'' &ndash; Limits the interpolated values to the minimum and maximum values in the original dataset.<br />
**''Truncate to specified range'' &ndash; Allows setting a user specified minimum and maximum value range.<br />
**''Min'' &ndash; Manually sets a minimum value.<br />
**''Max'' &ndash; Manually sets a maximum value.<br />
*'''Advanced''' &ndash; This button will open the ''Interpolate &ndash; Advanced'' dialog where options for anisotropy and extrapolation can be adjusted.<br />
<br />
==Related Topics==<br />
* [[GMS:UGrid Interpolation|UGrid Interpolation]]<br />
<br />
<br />
{{Navbox GMS}}<br />
[[Category:UGrid|Inter]]<br />
[[Category:UGrid Dialogs|Inter]]<br />
[[Category:Interpolation|UGrid]]<br />
<br />
<br />
UGRID interpolation<br />
{{UGrid links}}<br />
__TOC__<br />
UGrid [[GMS:Datasets|datasets]] can be interpolated to other UGrids similar to how scatter point datasets can be interpolated to other objects. The '''Interpolate To''' command is found in the right-click menu of the UGrid dataset to be interpolated to another UGrid. This command opens the ''Interpolate UGrid to UGrid'' dialog:<br />
<br />
[[File:Interpolate to UGrid.png|thumb|500px|none|''Interpolate UGrid to UGrid'' dialog]]<br />
<br />
This dialog allows selecting the interpolation options to use, and the UGrid to interpolate to. See [[GMS:Interpolation|Interpolation]] for more information on interpolation. Options include:<br />
* ''Source UGrid'' &ndash; The drop-down menu here will display a list of all available UGrids. Select the UGrid containing the source dataset.<br />
* ''Source dataset'' &ndash; The drop-down menu will display a list of all available datasets under the source UGrid. Select the dataset to use for interpolation.<br />
* ''Times'' &ndash; If the source dataset is transient, time steps should be specified. Options include:<br />
** "Specified Time Step" &ndash; This option will use the select time step in the next field.<br />
** "All Times" &ndash; This option will use all time steps available in the source dataset.<br />
*''Interpolation method'' &ndash; This section specifies which [[GMS:Interpolation|interpolation process]] will be used.<br />
**[[GMS:Linear|''Linear'']] &ndash; Uses data points that are first triangulated to form a network of triangles. The '''Options''' button for this method will bring up the ''Interpolate &ndash; Linear'' dialog where the interpolation values can be truncated or the Clough-Tocher method can be applied.<br />
**[[GMS:Inverse Distance Weighted|''Inverse distance weighted'']] &ndash; Creates an interpolated surface that is a weighted average of the point data; the weight assigned to each point diminishes as the distance to the interpolation location increases. The '''Options''' button next to this option will bring up either the ''2D IDW Interpolation Options'' dialog or the ''3D IDW Interpolation Options'' dialog.<br />
**[[GMS:Natural Neighbor|''Natural neighbor'']] &ndash; Based on the Thiessen polygon network of the point data. The '''Options''' button next to this option will bring up the ''Natural Neighbor Options'' dialog.<br />
**[[GMS:Kriging|''Kriging'']] &ndash; Based on the assumption that the parameter being interpolated can be treated as a regionalized variable. The '''Options''' button next to this option will bring up the [[GMS:Kriging Options|''Kriging Options'']] dialog.<br />
**Dimension &ndash; Options in this drop-down determine whether the interpolation will be two-dimensional or three-dimensional.<br />
***''2D'' &ndash; Designates the interpolation as two-dimensional data. This is the default interpolation method.<br />
***''3D'' &ndash; Specified the interpolation as three-dimensional data. Only the inverse distance weighted and Kriging options are available with this method.<br />
* ''Target UGrid'' &ndash; The drop-down menu will contain a list of available UGrids where the source dataset can be interpolated.<br />
* ''Target dataset name'' &ndash; Enter a name for the new dataset that will appear under the target UGrid.<br />
* ''Target dataset location'' &ndash; Specifies where the new dataset will be located: at the points or at the cells.<br />
**''Points'' &ndash; Specifies the new dataset will be located at the points.<br />
**''Cells'' &ndash; Specifies the new dataset will be located at the cells.<br />
<br />
==UGrid Interpolation Options==<br />
Clicking the '''Options''' button will open a dialog specific to the interpolation method being used.<br />
===Linear===<br />
The Linear interpolation scheme uses data points that are first triangulated to form a network of triangles. See [[GMS:UGrid Linear Interpolation|UGrid Linear Interpolation]] for more details.<br />
<br />
===Inverse Distance Weighted===<br />
Inverse Distance Weighted (IDW) is one of the most commonly used techniques for interpolation of point data. Its methods are based on the assumption that the interpolating surface should be influenced most by the nearby points and less by the more distant points. See [[GMS:UGrid Inverse Distance Weighted Interpolation|UGrid Inverse Distance Weighted Interpolation]] for more details.<br />
<br />
===Natural Neighbor===<br />
Natural neighbor interpolation is based on the Thiessen polygon network of the point data. The Thiessen polygon network can be constructed from the Delaunay triangulation of a set of points. A Delaunay triangulation is a network of triangles that has been constructed so that the Delaunay criterion has been satisfied. As with IDW interpolation, the nodal functions can be either constants, gradient planes, or quadratics. See [[GMS:UGrid Natural Neighbor Interpolation|UGrid Natural Neighbor Interpolation]] for more details.<br />
<br />
===Kriging===<br />
Kriging is based on the assumption that the parameter being interpolated can be treated as a regionalized variable. A regionalized variable is intermediate between a truly random variable and a completely deterministic variable because it varies in a continuous manner from one location to the next. Therefore points that are near each other have a certain degree of spatial correlation, but points that are widely separated are statistically independent. Kriging is a set of linear regression routines which minimize estimation variance from a predefined covariance model.<br />
<br />
See [[GMS:UGrid Kriging Interpolation|UGrid Kriging Interpolation]] for more details.<br />
<br />
===Advanced===<br />
[[File:Interplate-Advanced.png|thumb|350 px|The ''Interpolate &ndash; Advanced'' dialog]]<br />
The ''Interpolate &ndash; Advanced'' dialog is accessed through the '''Advanced''' on the interpolation method dialogs. Options in this dialog include:<br />
*''Anisotropy'' &ndash; Options in this section allow taking into account for directional tendencies in the original dataset.<br />
**''Horizontal anisotropy''<br />
**''Azimuth'' &ndash; Sets angle of degrees between the projected vector and a reference vector on the reference plane.<br />
**''Vertical Anisotropy (1/z mag)'' &ndash; Available with the 3D option. Vertical anisotropy is 1 over the Z scale.<br />
*''Extrapolation''<br />
**''Value''<br />
**''Assign extrapolation value to hidden objects'' &mdash; Assigns the default extrapolation value to all cells that are hidden using the '''Hide''' command in the ''Display | Visibility'' menu.<br />
<!--10.3 and older<br />
UGrid [[GMS:Datasets|datasets]] can be interpolated to other UGrids similar to how scatter point datasets can be interpolated to other objects. The '''Interpolate To''' command is found in the right-click menu of the UGrid dataset to be interpolated to another UGrid. This command opens the ''Interpolation Options'' dialog:<br />
<br />
[[File:UGridInterpolation.png|thumb|600px|none]]<br />
<br />
This dialog allows selecting the interpolation options to use, and the UGrid to interpolate to. See [[GMS:Interpolation|Interpolation]] for more information on interpolation. Options include:<br />
*''Interpolating from'' &ndash; This section gives information on the dataset being interpolated to the new dataset.<br />
**''Object'' &ndash; Shows the dataset being used for the interpolation.<br />
**''Dataset'' &ndash; Shows the type of dataset being used for the interpolation.<br />
**''Time step'' &ndash; If the dataset being used has time steps, shows which time step is being used.<br />
**''Use all time steps'' &ndash; If there are time steps, this option will interpolate all time steps in the source dataset.<br />
*''Interpolating to'' &ndash; This data tree shows all objects that can receive the interpolated data. Select the object that will receive the new interpolated dataset.<br />
*''Dimension'' &ndash; Options in this section determine whether the interpolation will be two-dimensional or three-dimensional.<br />
**''2D'' &ndash; Designates the interpolation as two-dimensional data. All interpolation methods are available with this option.<br />
**''3D'' &ndash; Specified the interpolation as three-dimensional data. Only the inverse distance weighted and Kriging options are available with this method.<br />
*''Anisotropy'' &ndash; Options in this section allow taking into account for directional tendencies in the original dataset.<br />
**''Horizontal anisotropy''<br />
**''Azimuth'' &ndash; Sets angle of degrees between the projected vector and a reference vector on the reference plane.<br />
**''Vertical Anisotropy (1/z mag)'' &ndash; Available with the 3D option. Vertical anisotropy is 1 over the Z scale. <br />
*''Interpolation method'' &ndash; This section specifies which [[GMS:Interpolation|interpolation process]] will be used.<br />
**[[GMS:Linear|''Linear'']] &ndash; Uses data points that are first triangulated to form a network of triangles. <br />
**[[GMS:Inverse Distance Weighted|''Inverse distance weighted'']] &ndash; Creates an interpolated surface that is a weighted average of the point data; the weight assigned to each point diminishes as the distance to the interpolation location increases. The '''Options''' button next to this option will bring up either the ''2D IDW Interpolation Options'' dialog or the ''3D IDW Interpolation Options'' dialog.<br />
**[[GMS:Clough-Tocher|''Clough-Tocher'']] &ndash; A finite element method that has origins in the finite element method of numerical analysis.<br />
**[[GMS:Natural Neighbor|''Natural neighbor'']] &ndash; Based on the Thiessen polygon network of the point data. The '''Options''' button next to this option will bring up the ''Natural Neighbor Options'' dialog.<br />
**[[GMS:Kriging|''Kriging'']] &ndash; Based on the assumption that the parameter being interpolated can be treated as a regionalized variable. The '''Options''' button next to this option will bring up the [[GMS:Kriging Options|''Kriging Options'']] dialog.<br />
**''Log interpolation'' &ndash; Takes the log of each data value in the active dataset prior to performing interpolation.<br />
**''Set data value <=0 to'' &ndash; Assigns a value to points where the current data value is less than or equal to zero. Typically, a small positive number should be used.<br />
*''Default extrapolation value''<br />
*''Assign default extrapolation value to hidden objects'' &mdash; Assigns the default extrapolation value to all cells that are hidden using the '''Hide''' command in the ''Display | Visibility'' menu.<br />
*''Truncate values'' &ndash; This section allows for limiting the interpolated values to lie between the minimum and maximum value.<br />
**''Truncate to min/max of dataset'' &ndash; Limits the interpolated values to the minimum and maximum values in the original dataset.<br />
**''Truncate to specified range'' &ndash; Allows setting a user specified minimum and maximum value range.<br />
**''Min'' &ndash; Manually sets a minimum value.<br />
**''Max'' &ndash; Manually sets a maximum value.<br />
*''Create dataset at'' &ndash; Specifies where the new dataset will be located: at the points or at the cells.<br />
**''Points'' &ndash; Specifies the new dataset will be located at the points.<br />
**''Cells'' &ndash; Specifies the new dataset will be located at the cells.<br />
*''New dataset name'' &ndash; Assigns a name to the new dataset created from the interpolation process.<br />
<br />
It is also possible to drag a UGrid dataset and drop it on to another UGrid to open this dialog and to indicate what the interpolation target should be.--><br />
<br />
==Points vs. Cells==<br />
<br />
UGrids can have datasets associated with both cells and points. Thus there is an option to specify where the new dataset will be located: at the points or at the cells.<br />
<br />
<br />
{{Navbox GMS}}<br />
[[Category:UGrid|Inter]]<br />
[[Category:UGrid Dialogs|Inter]]<br />
[[Category:Interpolation|UGrid]]<br />
<br />
UGRID LINEAR INTERPOLATION<br />
[[File:Interpolate-Linear.png|thumb|350 px|The ''Interpolate &ndash; Linear'' dialog]]<br />
The Linear interpolation scheme uses data points that are first triangulated to form a network of triangles. The network of triangles only covers the convex hull of the point data, making extrapolation beyond the convex hull not possible.<br />
<br />
If the linear interpolation scheme is selected, the data points are first triangulated to form a network of triangles. The equation of the plane defined by the three vertices of a triangle is as follows:<br />
<br />
<!--<math>\ Ax+By+Cz+D = 0</math>--><br />
:[[Image:linear_eq1.jpg]]<br />
<br />
:where ''A'', ''B'', ''C'', and ''D'' are computed from the coordinates of the three vertices ''(x1,y1,z1)'', ''(x2,y2,z2)'', and ''(x3,y3,z3)'':<br />
<br />
:<math>\ A = y_1(z_2-z_3) + y_2(z_3-z_1) + y_3(z_1-z_2)</math><br />
<br />
:<math>\ B = z_1(x_2-x_3) + z_2(x_3-x_1) + z_3(x_1-x_2)</math><br />
<br />
:<math>\ C = x_1(y_2-y_3) + x_2(y_3-y_1) + x_3(y_1-y_2)</math><br />
<br />
:<math>\ D = -Ax_1 - By_1 - Dz_1</math><br />
<br />
The plane equation can also be written as:<br />
<br />
:<math>z = f(x,y) = -\frac{A}{C}x-\frac{B}{C}y-\frac{D}{C}</math><br />
<br />
:which is the form of the plane equation used to compute the elevation at any point on the triangle.<br />
<br />
Since the network of triangles only covers the convex hull of the point data, extrapolation beyond the convex hull is not possible with the linear interpolation scheme. Any points outside the convex hull of the point data are assigned the default extrapolation value entered in the ''Interpolation Options'' dialog. The figure below shows a network of triangles created from point data.<br />
<br />
:{{hide in print|[[File:convex_hull.jpg|thumb|none|left|300 px|Network of triangles]]}}<br />
:{{only in print|[[File:convex_hull.jpg|275px|frame|center|Network of triangles]]}}<br />
<br />
If the Linear interpolation method is selected in the ''Interpolate UGrid to UGrid'' dialog, options can be set in the ''Interpolate &ndash; Linear'' dialog. This dialog has the following options:<br />
*''Truncate values'' &ndash; This section allows for limiting the interpolated values to lie between the minimum and maximum value.<br />
**''Truncate to min/max of dataset'' &ndash; Limits the interpolated values to the minimum and maximum values in the original dataset.<br />
**''Truncate to specified range'' &ndash; Allows setting a user-specified minimum and maximum value range.<br />
**''Min'' &ndash; Manually sets a minimum value.<br />
**''Max'' &ndash; Manually sets a maximum value.<br />
*''Clough-Tocher'' &ndash; When on, the [[GMS:Clough-Tocher|Clough-Tocher]] interpolation technique will be used.<br />
*'''Advanced''' &ndash; This button will open the ''Interpolate &ndash; Advanced'' dialog where options for anisotropy and extrapolation can be adjusted.<br />
<br />
==Related Topics==<br />
* [[GMS:UGrid Interpolation|UGrid Interpolation]]<br />
* [[GMS:Clough-Tocher|Clough-Tocher]]<br />
<br />
{{Navbox GMS}}<br />
[[Category:UGrid|Inter]]<br />
[[Category:UGrid Dialogs|Inter]]<br />
[[Category:Interpolation|UGrid]]<br />
<br />
GMS: SHEPARD'S METHOD<br />
The simplest form of inverse distance weighted interpolation is the constant nodal function sometimes called the "Shepard's method" (Shepard 1968). The equation used is as follows:<br />
<br />
<!--<math>F(x,y) = \sum_{i=1}^n w_if_i</math>--><br />
:[[Image:shep_eq1.jpg]]<br />
<br />
where ''n'' is the number of points used to interpolate, ''f<sub>i</sub>'' are the prescribed function values at the points (e.g., the dataset values), and ''w<sub>i</sub>'' are the weight functions assigned to each point. The classical form of the weight function is:<br />
<br />
<!--<math>w_i = \frac{h_i^{-p}}{\displaystyle \sum_{j=1}^n h_j^{-p}}</math>--><br />
:[[Image:shep_eq2.jpg]]<br />
<br />
where ''p'' is an arbitrary positive real number called the weighting exponent and is defaulted to 2. The ''Use classic weight function'' can be turned on, and the weighting exponent modified, by turning on the ''Use classic weight function'' option in the ''IDW Interpolation Options'' dialog. ''h<sub>i</sub>'' is the distance from the point to the interpolation location or<br />
<br />
<!--<math>h_i = \sqrt{(x-x_i)^2+(y-y_i)^2}</math>--><br />
:[[Image:shep_eq3.jpg]]<br />
<br />
where ''(x,y)'' are the coordinates of the interpolation location and ''(x<sub>i</sub>,y<sub>i</sub>)'' are the coordinates of each point. The weight function varies from a value of unity at the point to a value approaching zero as the distance from the point increases. The weight functions are normalized so that the weights sum to unity.<br />
<br />
Although the weight function shown above is the classical form of the weight function in inverse distance weighted interpolation, the following equation is used in GMS:<br />
<br />
<!--<math>w_i = \frac{ \left [ \frac{R-h_i}{Rh_i} \right ] ^2}{\displaystyle \sum_{j=1}^n \left [ \frac{R-h_i}{Rh_i} \right ] ^2}</math>--><br />
:[[Image:shep_eq4.jpg]]<br />
<br />
where ''h<sub>i</sub>'' is the distance from the interpolation location to the point ''i'', ''R'' is the distance from the interpolation location to the most distant point, and n is the total number of points. This equation has been found to give superior results to the classical equation (Franke & Nielson, 1980).<br />
<br />
The weight function is a function of Euclidean distance and is radially symmetric about each point. As a result, the interpolating surface is somewhat symmetric about each point and tends toward the mean value of the point data between the points. Shepard's method has been used extensively because of its simplicity.<br />
<br />
== 3D Interpolation ==<br />
<br />
The 3D equations for Shepard's method are identical to the 2D equations except that the distances are computed using:<br />
<br />
<!--<math>h_i = \sqrt{(x-x_i)^2+(y-y_i)^2+(z-z_i)^2}</math>--><br />
:[[Image:shep_eq5.jpg]]<br />
<br />
where ''(x,y,z)'' are the coordinates of the interpolation location and ''(x<sub>i</sub>,y<sub>i</sub>,z<sub>i</sub>)'' are the coordinates of each point.<br />
<br />
==Related Topics==<br />
* [[GMS:Inverse Distance Weighted|Inverse Distance Weighted]]<br />
<br />
<br />
{{Navbox GMS}}<br />
[[Category:Interpolation]]<br />
[[Category:Equations|Shepards]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan&diff=157069User:Rcorrigan2022-11-11T00:01:26Z<p>Rcorrigan: </p>
<hr />
<div>*[[User:Rcorrigan/Workflow Tests|Workflow Tests]]<br />
<br />
*[[User:Rcorrigan/Functional Surface Options|Functional Surface Options]]<br />
*[[User:Rcorrigan/Display Themes|Display Themes Edit]]<br />
*[[User:Rcorrigan/Sandboxing GMS Menus|GMS Sandbox]]<br />
*[[User:Rcorrigan/SMS:Simulations]]<br />
*[[User:Rcorrigan/AHGW for ArcGIS Pro]]<br />
*[[User:Rcorrigan/Archived Projects]]<br />
*[[User:Rcorrigan/SMS Tutorial Table|Tutorial Tables]]<br />
*[[User:Rcorrigan/Edits Riley didn't finish]]<br />
[[Category:User:Rcorrigan/Templates]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan&diff=157068User:Rcorrigan2022-11-10T23:55:25Z<p>Rcorrigan: </p>
<hr />
<div>*[[User:Rcorrigan/Workflow Tests|Workflow Tests]]<br />
<br />
*[[User:Rcorrigan/Functional Surface Options|Functional Surface Options]]<br />
*[[User:Rcorrigan/Display Themes|Display Themes Edit]]<br />
*[[User:Rcorrigan/Sandboxing GMS Menus|GMS Sandbox]]<br />
*[[User:Rcorrigan/SMS:Simulations]]<br />
*[[User:Rcorrigan/AHGW for ArcGIS Pro]]<br />
*[[User:Rcorrigan/Archived Projects]]<br />
*[[User:Rcorrigan/SMS Tutorial Table|Tutorial Tables]]<br />
[[Category:User:Rcorrigan/Templates]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan&diff=157067User:Rcorrigan2022-11-10T23:54:52Z<p>Rcorrigan: </p>
<hr />
<div>*[[User:Rcorrigan/Workflow Tests|Workflow Tests]]<br />
<br />
*[[User:Rcorrigan/Functional Surface Options|Functional Surface Options]]<br />
*[[User:Rcorrigan/Display Themes|Display Themes Edit]]<br />
*[[User:Rcorrigan/Sandboxing GMS Menus|GMS Sandbox]]<br />
*[[User:Rcorrigan/SMS:Simulations]]<br />
*[[User:Rcorrigan/AHGW for ArcGIS Pro]]<br />
*[[User:Rcorrigan/Archived Projects]]<br />
*[[User:Rcorrigan/SMS Tutorial Table]]<br />
[[Category:User:Rcorrigan/Templates]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan&diff=157063User:Rcorrigan2022-11-08T23:36:20Z<p>Rcorrigan: </p>
<hr />
<div><!--*[[User:Rcorrigan/Workflow Tests|Workflow Tests]]--><br />
<br />
<!--*[[User:Rcorrigan/Functional Surface Options|Functional Surface Options]]<br />
*[[User:Rcorrigan/Display Themes|Display Themes Edit]]<br />
*[[User:Rcorrigan/Sandboxing GMS Menus|GMS Sandbox]]--><br />
*[[User:Rcorrigan/SMS:Simulations]]<br />
*[[User:Rcorrigan/AHGW for ArcGIS Pro]]<br />
*[[User:Rcorrigan/Archived Projects]]<br />
*[[User:Rcorrigan/SMS Tutorial Table]]<br />
[[Category:User:Rcorrigan/Templates]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan&diff=157062User:Rcorrigan2022-11-08T23:35:51Z<p>Rcorrigan: </p>
<hr />
<div><!--*[[User:Rcorrigan/Workflow Tests|Workflow Tests]]--><br />
<br />
<!--*[[User:Rcorrigan/Functional Surface Options|Functional Surface Options]]--><br />
*[[User:Rcorrigan/Display Themes|Display Themes Edit]]<br />
*[[User:Rcorrigan/Sandboxing GMS Menus|GMS Sandbox]]<br />
*[[User:Rcorrigan/SMS:Simulations]]<br />
*[[User:Rcorrigan/AHGW for ArcGIS Pro]]<br />
*[[User:Rcorrigan/Archived Projects]]<br />
*[[User:Rcorrigan/SMS Tutorial Table]]<br />
[[Category:User:Rcorrigan/Templates]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan&diff=157061User:Rcorrigan2022-11-08T23:35:43Z<p>Rcorrigan: </p>
<hr />
<div><!--*[[User:Rcorrigan/Workflow Tests|Workflow Tests]]--><br />
*[[User:Rcorrigan/Update Pages|Update Pages]]<br />
<!--*[[User:Rcorrigan/Functional Surface Options|Functional Surface Options]]--><br />
*[[User:Rcorrigan/Display Themes|Display Themes Edit]]<br />
*[[User:Rcorrigan/Sandboxing GMS Menus|GMS Sandbox]]<br />
*[[User:Rcorrigan/SMS:Simulations]]<br />
*[[User:Rcorrigan/AHGW for ArcGIS Pro]]<br />
*[[User:Rcorrigan/Archived Projects]]<br />
*[[User:Rcorrigan/SMS Tutorial Table]]<br />
[[Category:User:Rcorrigan/Templates]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan&diff=157060User:Rcorrigan2022-11-08T23:34:43Z<p>Rcorrigan: </p>
<hr />
<div>*[[User:Rcorrigan/Workflow Tests|Workflow Tests]]<br />
*[[User:Rcorrigan/Functional Surface Options|Functional Surface Options]]<br />
*[[User:Rcorrigan/Display Themes|Display Themes Edit]]<br />
*[[User:Rcorrigan/Sandboxing GMS Menus|GMS Sandbox]]<br />
*[[User:Rcorrigan/SMS:Simulations]]<br />
*[[User:Rcorrigan/AHGW for ArcGIS Pro]]<br />
*[[User:Rcorrigan/Archived Projects]]<br />
*[[User:Rcorrigan/SMS Tutorial Table]]<br />
[[Category:User:Rcorrigan/Templates]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:UGrid_Display_Options&diff=157059SMS:UGrid Display Options2022-11-08T23:20:07Z<p>Rcorrigan: /* Functional Surfaces */</p>
<hr />
<div>The display options of UGrid data that SMS displays on the screen can be controlled through the ''UGrid Data'' tab of the [[SMS:Display Options|''Display Options'']] dialog. This dialog is opened by right-clicking on the [[File:UGrid 2D Folder.svg|16 px]] "UGrid Data" item in the [[SMS:Project Explorer|Project Explorer]] and selecting the '''Display Options''' command. It can also be accessed from the from the ''Display'' menu or the '''Display Options''' [[File:Display Options Macro.svg|16 px]] macro. The following table describes the display options available for the UGrid module.<br />
<br />
When multiple UGrids exist in a project, each UGrid will be shown in the ''Display Options'' dialog. The display options for each UGrid in the project can be set separately.<br />
<br />
{| class="wikitable"<br />
! width="125" | Display Option !! Description<br />
|-<br />
| Cell edges || The Cell edges item is used to display the edges of cells. The cells are drawn using the specified color.<br />
|-<br />
| Cell faces || This option fills the cells with the material color.<br />
|-<br />
| Cell centers || This option displays a point at the center of every cell.<br />
|-<br />
| Points || Points are the corners of cells, or simply 3D points not attached to cells. A symbol can be displayed at these locations. If Point contours are on, the color of the symbol will be determined by the data and the contour options.<br />
|-<br />
| Inactive points || Show points that correspond with an inactive dataset value.<br />
|-<br />
| UGrid Boundary || Used to display an edge for each of the edges on the exterior of the set of all cells (visible or invisible) which corresponds to a discontinuity in the UGrid exterior. This display option provides a helpful spatial context when displaying isosurfaces or cross sections.<br />
|-<br />
| Feature angle || The UGrid boundary feature angle is used only when the ''UGrid Boundary'' option is selected. This angle represents a threshold angle at which an edge of the shell will be displayed. If for example, an angle of 45 degrees is defined, any edge of the UGrid which divides two cell faces that are at an angle greater than 45 degrees to each other will not be displayed.<br />
|-<br />
| Point numbers || The Point numbers item is used to display the ID associated with each point next to the point.<br />
|- <br />
| Cell numbers || The cell numbers item is used to display the ID associated with each cell at the centroid of the cell.<br />
|-<br />
| Scalar values || The Scalar Values item is used to display the scalar values of the active dataset for each node next to the node.<br />
|-<br />
| Face contours || Most of the objects supported by SMS can be contoured by turning on the [[SMS:Contour Options|''Contour Options'']] in the ''Display Options'' dialog. When an object is contoured, the values associated with the active dataset for the object are used to generate the contours.<br />
|-<br />
| Point contours || The same [[SMS:Contour Options|Contour Options]] but applied to points.<br />
|-<br />
| Vectors || Vector arrows are displayed using the active vector dataset. <br />
|-<br />
| Isosurfaces || Isosurfaces are the 3D equivalent of a contour line. An isosurface is a surface of constant value extracted from a 3D dataset.<br />
|-<br />
| Clip || Creates a clipping widget that can be used to hide part of the UGrid. Clicking the '''Options''' button will bring up the ''UGrid Clip Settings'' dialog. The options include setting the widget to be a plane, which can be manipulated with the mouse in the Graphics Window, or to be a scalar or scalar range, which work like isosurfaces. Whole cells or partial cells can be clipped.<br />
|-<br />
| Copy Display Options to UGrid(s) || The current UGrid ''Display Options'' can be copied to other UGrids. This button brings up a dialog to select the UGrids that the ''Display Options'' will be copied to.<br />
|}<br />
<br />
[[File:Sms-ugrid-display.png|thumb|none|left|550 px|The ''Display Options'' dialog showing the ''3D UGrid'' tab.]]<br />
<!--<br />
==UGrid Clip Settings==<br />
[[File:Sms-ugrid-clip-settings.png|thumb|375 px|The ''UGrid Clip Settings'' dialog]]<br />
The ''Ugrid Clip Settings'' dialog allows setting parameters for clipping the UGrid display. The dialog has the following options:<br />
*''Clip Type'' &ndash; Can be set to "Plane", "Scalar", or "Scalar Range".<br />
**"Plane" &ndash; Defines a clipping plane that cuts through the Ugrid. Allows the '''Edit Clip Plane''' tool to be used. <br />
**"Scalar" &ndash; Defines the clipping area based on a single value.<br />
**"Scalar Range" &ndash; Defines the clipping area based on a minimum and maximum value.<br />
*''Clip To'' &ndash; Set the clipping to use "Whole Cells" or "Partial Cells". <br />
**"Whole Cells" will display the entire cell when the majority of the cell is inside the clipping plane. <br />
**"Partial Cells" will create a smoother display as portions of cells inside the clipping plane will be displayed. <br />
*''Scalar Value'' &ndash; Creates a clipping region based on the set scalar value.<br />
*''Minimum Scalar Value'' &ndash; The lowers scalar value for the clipping range.<br />
*''Maximum Scalar Value'' &ndash; The highest scalar value for the clipping range.<br />
*''Plane Point X'' &ndash; Defines the location on the X axis of the the central clipping point. <br />
*''Plane Point Y'' &ndash; Defines the location on the Y axis of the the central clipping point. <br />
*''Plane Point Z'' &ndash; Defines the location on the Z axis of the the central clipping point. <br />
*''Plane Normal X'' &ndash; Determines the X value used in the plane calculation.<br />
*''Plane Normal Y'' &ndash; Determines the Y value used in the plane calculation.<br />
*''Plane Normal X'' &ndash; Determines the Z value used in the plane calculation.<br />
*''Inverted'' &ndash; The clipping area will be inverted when this option is set to "On".--><br />
==Functional Surfaces==<br />
A functional surface is exactly that. It is a surface representing one of the functional datasets associated with an unstructured grid. The most intuitive example of a functional surface is the display of the water surface over a model's bathymetry. In this case, the surface represents an actual physical surface, but the functional surface could just as easily represent the velocity magnitude, or concentration, or any other scalar quantity.<br />
<br />
[[File:UGrid Functional Surface.png|thumb|500 px|''Functional Surfaces Options'' dialog for UGrids]]<br />
To create/display functional surfaces, right-click on the UGrid in the Project Explorer and select '''New Functional Surface'''. Then specify the surface attributes which include:<br />
<br />
* ''Elevation Dataset'' &ndash; Selects which dataset is to be used to form the functional surface.<br />
:* ''Use active dataset'' &ndash; The currently selected dataset will be used for the functional surface.<br />
:* ''User defined dataset'' &ndash; Allows selecting a specific dataset in the project to use for the functional surface. The '''Select''' button for this option will bring a ''Select Dataset'' dialog.<br />
* ''Elevation Z Offset'' &ndash; SMS displays functional surfaces at a simulated z-value. This may be the actual surface value (such as is the case with water surfaces elevations), but more often the value will not have a physical meaning, and may intersect the bathymetry or not even be in the same area. For this reason, SMS offers options for placing the functional surface at one of the following locations:<br />
** "Display surface at location" &ndash; The functional surface will be displayed at the location of the dataset on the geometry.<br />
**"Display surface above geometry" &ndash; The functional surface will be displayed slightly above the geometry based on the z-magnification.<br />
**"Display surface with user defined offset" &dnash; The functional surface will be display based on a value entered by the user.<br />
***''Offset value'' &ndash; Enter an offset Z value for the user defined offset.<br />
* ''Elevation Z Magnification'' &ndash; Functional data may not vary significantly when compared to the horizontal extents of the model. For this reason, the interface allows magnification (scaling) of the functional surface. By default, the surface is scaled based on the global z-magnification specified in the general display options. This may be overridden.<br />
:* ''Override global value'' &ndash; Turn on to override the global Z magnification value. <br />
:** ''Magnification value'' &ndash; Enter a z magnification value to override the global value.<br />
* ''Display Options'' &ndash; Controls the color of the functional surface. It may be a constant color or colored based on the contour colors specified. The colors may be associated with the value of the functional surface, or another dataset. The surface may also be partially transparent.<br />
:* ''Use solid color'' &ndash; Will change the functional surface to be a single color.<br />
:**''Color'' &ndash; Select a color to use as the solid color for the functional surface. <br />
:* ''Transparency'' &ndash; Set a transparency level for the functional surface. The transparency by entering a value or using the slider.<br />
:* ''Contour surface'' &ndash; Sets specific contour options for the functional surface.<br />
:** '''Options''' &ndash; Will open the ''Dataset Contour Options'' dialog.<br />
:** ''Specify separate dataset for contours'' &ndash; Allows a different dataset to be used for the contour options.<br />
:*** '''Select''' &ndash; Brings up a ''Select Dataset'' dialog.<br />
:*'''Other Display Options''' &ndash; Brings up the ''Functional Surface Other Options'' dialog.<br />
===Functional Surface Other Options===<br />
[[File:UGrid Functional Surface Other.png|thumb|300 px|''Functional Surfaces Other Options'' dialog for UGrids]]<br />
Additional display options can be set for functional surfaces with UGrids. These options are reached through the ''Functional Surface Options'' dialog. The ''Functional Surface Other Options'' dialog includes the following:<br />
*''Cell edges'' &ndash; Turn on to display cell edge lines on the functional surface. Clicking the button next to this option will open the ''Line Properties'' dialog. <br />
*''Cell faces'' &ndash; Turn on to display cell faces on the functional surface.<br />
*''Points'' &ndash; Turn on to display points along the functional surface. Clicking the button next to this option will open the ''Symbol Attributes'' dialog.<br />
*''Inactive points'' &ndash; Turn on to display inactive points along the functional surface. Clicking the button next to this option will open the ''Symbol Attributes'' dialog.<br />
*''UGrid boundary'' &ndash; Turn on to display grid boundary line on the functional surface. Clicking the button next to this option will open the ''Line Properties'' dialog.<br />
**''Feature angle'' &ndash; Enter the feature angle value for the functional surface.<br />
*''Face contours'' &ndash; Turn on to see contours on the faces of the functional surface. Clicking the button next to this option will open the ''Contour Options'' dialog.<br />
*''Point contours'' &ndash; Turn on to see contours on the points of the functional surface. Clicking the button next to this option will open the ''Contour Options'' dialog.<br />
<br />
==Related Topics==<br />
* [[SMS:UGrid Module|UGrid Module]]<br />
<br />
{{Navbox SMS}}<br />
[[Category:UGrid|Dis]]<br />
[[Category:UGrid Dialogs|Dis]]<br />
[[Category:SMS Display Options]]<br />
[[Category:SMS Display Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:UGrid_Display_Options&diff=157058SMS:UGrid Display Options2022-11-08T23:19:06Z<p>Rcorrigan: /* Functional Surfaces */</p>
<hr />
<div>The display options of UGrid data that SMS displays on the screen can be controlled through the ''UGrid Data'' tab of the [[SMS:Display Options|''Display Options'']] dialog. This dialog is opened by right-clicking on the [[File:UGrid 2D Folder.svg|16 px]] "UGrid Data" item in the [[SMS:Project Explorer|Project Explorer]] and selecting the '''Display Options''' command. It can also be accessed from the from the ''Display'' menu or the '''Display Options''' [[File:Display Options Macro.svg|16 px]] macro. The following table describes the display options available for the UGrid module.<br />
<br />
When multiple UGrids exist in a project, each UGrid will be shown in the ''Display Options'' dialog. The display options for each UGrid in the project can be set separately.<br />
<br />
{| class="wikitable"<br />
! width="125" | Display Option !! Description<br />
|-<br />
| Cell edges || The Cell edges item is used to display the edges of cells. The cells are drawn using the specified color.<br />
|-<br />
| Cell faces || This option fills the cells with the material color.<br />
|-<br />
| Cell centers || This option displays a point at the center of every cell.<br />
|-<br />
| Points || Points are the corners of cells, or simply 3D points not attached to cells. A symbol can be displayed at these locations. If Point contours are on, the color of the symbol will be determined by the data and the contour options.<br />
|-<br />
| Inactive points || Show points that correspond with an inactive dataset value.<br />
|-<br />
| UGrid Boundary || Used to display an edge for each of the edges on the exterior of the set of all cells (visible or invisible) which corresponds to a discontinuity in the UGrid exterior. This display option provides a helpful spatial context when displaying isosurfaces or cross sections.<br />
|-<br />
| Feature angle || The UGrid boundary feature angle is used only when the ''UGrid Boundary'' option is selected. This angle represents a threshold angle at which an edge of the shell will be displayed. If for example, an angle of 45 degrees is defined, any edge of the UGrid which divides two cell faces that are at an angle greater than 45 degrees to each other will not be displayed.<br />
|-<br />
| Point numbers || The Point numbers item is used to display the ID associated with each point next to the point.<br />
|- <br />
| Cell numbers || The cell numbers item is used to display the ID associated with each cell at the centroid of the cell.<br />
|-<br />
| Scalar values || The Scalar Values item is used to display the scalar values of the active dataset for each node next to the node.<br />
|-<br />
| Face contours || Most of the objects supported by SMS can be contoured by turning on the [[SMS:Contour Options|''Contour Options'']] in the ''Display Options'' dialog. When an object is contoured, the values associated with the active dataset for the object are used to generate the contours.<br />
|-<br />
| Point contours || The same [[SMS:Contour Options|Contour Options]] but applied to points.<br />
|-<br />
| Vectors || Vector arrows are displayed using the active vector dataset. <br />
|-<br />
| Isosurfaces || Isosurfaces are the 3D equivalent of a contour line. An isosurface is a surface of constant value extracted from a 3D dataset.<br />
|-<br />
| Clip || Creates a clipping widget that can be used to hide part of the UGrid. Clicking the '''Options''' button will bring up the ''UGrid Clip Settings'' dialog. The options include setting the widget to be a plane, which can be manipulated with the mouse in the Graphics Window, or to be a scalar or scalar range, which work like isosurfaces. Whole cells or partial cells can be clipped.<br />
|-<br />
| Copy Display Options to UGrid(s) || The current UGrid ''Display Options'' can be copied to other UGrids. This button brings up a dialog to select the UGrids that the ''Display Options'' will be copied to.<br />
|}<br />
<br />
[[File:Sms-ugrid-display.png|thumb|none|left|550 px|The ''Display Options'' dialog showing the ''3D UGrid'' tab.]]<br />
<!--<br />
==UGrid Clip Settings==<br />
[[File:Sms-ugrid-clip-settings.png|thumb|375 px|The ''UGrid Clip Settings'' dialog]]<br />
The ''Ugrid Clip Settings'' dialog allows setting parameters for clipping the UGrid display. The dialog has the following options:<br />
*''Clip Type'' &ndash; Can be set to "Plane", "Scalar", or "Scalar Range".<br />
**"Plane" &ndash; Defines a clipping plane that cuts through the Ugrid. Allows the '''Edit Clip Plane''' tool to be used. <br />
**"Scalar" &ndash; Defines the clipping area based on a single value.<br />
**"Scalar Range" &ndash; Defines the clipping area based on a minimum and maximum value.<br />
*''Clip To'' &ndash; Set the clipping to use "Whole Cells" or "Partial Cells". <br />
**"Whole Cells" will display the entire cell when the majority of the cell is inside the clipping plane. <br />
**"Partial Cells" will create a smoother display as portions of cells inside the clipping plane will be displayed. <br />
*''Scalar Value'' &ndash; Creates a clipping region based on the set scalar value.<br />
*''Minimum Scalar Value'' &ndash; The lowers scalar value for the clipping range.<br />
*''Maximum Scalar Value'' &ndash; The highest scalar value for the clipping range.<br />
*''Plane Point X'' &ndash; Defines the location on the X axis of the the central clipping point. <br />
*''Plane Point Y'' &ndash; Defines the location on the Y axis of the the central clipping point. <br />
*''Plane Point Z'' &ndash; Defines the location on the Z axis of the the central clipping point. <br />
*''Plane Normal X'' &ndash; Determines the X value used in the plane calculation.<br />
*''Plane Normal Y'' &ndash; Determines the Y value used in the plane calculation.<br />
*''Plane Normal X'' &ndash; Determines the Z value used in the plane calculation.<br />
*''Inverted'' &ndash; The clipping area will be inverted when this option is set to "On".--><br />
==Functional Surfaces==<br />
A functional surface is exactly that. It is a surface representing one of the functional datasets associated with an unstructured grid. The most intuitive example of a functional surface is the display of the water surface over a model's bathymetry. In this case, the surface represents an actual physical surface, but the functional surface could just as easily represent the velocity magnitude, or concentration, or any other scalar quantity.<br />
<br />
[[File:UGrid Functional Surface.png|thumb|500 px|''Functional Surfaces Options'' dialog for UGrids]]<br />
To create/display functional surfaces, right-click on the UGrid in the Project Explorer and select '''New Functional Surface'''. Then specify the surface attributes which include:<br />
<br />
* ''Elevation Dataset'' &ndash; Selects which dataset is to be used to from the functional surface.<br />
:* ''Use active dataset'' &ndash; The currently selected dataset will be used for the functional surface.<br />
:* ''User defined dataset'' &ndash; Allows selecting a specific dataset in the project to use for the functional surface. The '''Select''' button for this option will bring a ''Select Dataset'' dialog.<br />
* ''Elevation Z Offset'' &ndash; SMS displays functional surfaces at a simulated z-value. This may be the actual surface value (such as is the case with water surfaces elevations), but more often the value will not have a physical meaning, and may intersect the bathymetry or not even be in the same area. For this reason, SMS offers options for placing the functional surface at one of the following locations:<br />
** "Display surface at location" &ndash; The functional surface will be displayed at the location of the dataset on the geometry.<br />
**"Display surface above geometry" &ndash; The functional surface will be displayed slightly above the geometry based on the z-magnification.<br />
**"Display surface with user defined offset" &dnash; The functional surface will be display based on a value entered by the user.<br />
***''Offset value'' &ndash; Enter an offset Z value for the user defined offset.<br />
* ''Elevation Z Magnification'' &ndash; Functional data may not vary significantly when compared to the horizontal extents of the model. For this reason, the interface allows magnification (scaling) of the functional surface. By default, the surface is scaled based on the global z-magnification specified in the general display options. This may be overridden.<br />
:* ''Override global value'' &ndash; Turn on to override the global Z magnification value. <br />
:** ''Magnification value'' &ndash; Enter a z magnification value to override the global value.<br />
* ''Display Options'' &ndash; Controls the color of the functional surface. It may be a constant color or colored based on the contour colors specified. The colors may be associated with the value of the functional surface, or another dataset. The surface may also be partially transparent.<br />
:* ''Use solid color'' &ndash; Will change the functional surface to be a single color.<br />
:**''Color'' &ndash; Select a color to use as the solid color for the functional surface. <br />
:* ''Transparency'' &ndash; Set a transparency level for the functional surface. The transparency by entering a value or using the slider.<br />
:* ''Contour surface'' &ndash; Sets specific contour options for the functional surface.<br />
:** '''Options''' &ndash; Will open the ''Dataset Contour Options'' dialog.<br />
:** ''Specify separate dataset for contours'' &ndash; Allows a different dataset to be used for the contour options.<br />
:*** '''Select''' &ndash; Brings up a ''Select Dataset'' dialog.<br />
:*'''Other Display Options''' &ndash; Brings up the ''Functional Surface Other Options'' dialog.<br />
===Functional Surface Other Options===<br />
[[File:UGrid Functional Surface Other.png|thumb|300 px|''Functional Surfaces Other Options'' dialog for UGrids]]<br />
Additional display options can be set for functional surfaces with UGrids. These options are reached through the ''Functional Surface Options'' dialog. The ''Functional Surface Other Options'' dialog includes the following:<br />
*''Cell edges'' &ndash; Turn on to display cell edge lines on the functional surface. Clicking the button next to this option will open the ''Line Properties'' dialog. <br />
*''Cell faces'' &ndash; Turn on to display cell faces on the functional surface.<br />
*''Points'' &ndash; Turn on to display points along the functional surface. Clicking the button next to this option will open the ''Symbol Attributes'' dialog.<br />
*''Inactive points'' &ndash; Turn on to display inactive points along the functional surface. Clicking the button next to this option will open the ''Symbol Attributes'' dialog.<br />
*''UGrid boundary'' &ndash; Turn on to display grid boundary line on the functional surface. Clicking the button next to this option will open the ''Line Properties'' dialog.<br />
**''Feature angle'' &ndash; Enter the feature angle value for the functional surface.<br />
*''Face contours'' &ndash; Turn on to see contours on the faces of the functional surface. Clicking the button next to this option will open the ''Contour Options'' dialog.<br />
*''Point contours'' &ndash; Turn on to see contours on the points of the functional surface. Clicking the button next to this option will open the ''Contour Options'' dialog.<br />
<br />
==Related Topics==<br />
* [[SMS:UGrid Module|UGrid Module]]<br />
<br />
{{Navbox SMS}}<br />
[[Category:UGrid|Dis]]<br />
[[Category:UGrid Dialogs|Dis]]<br />
[[Category:SMS Display Options]]<br />
[[Category:SMS Display Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=User:Rcorrigan/Functional_Surface_Options&diff=157057User:Rcorrigan/Functional Surface Options2022-11-08T23:15:26Z<p>Rcorrigan: </p>
<hr />
<div>__NOINDEX__<br />
Quadtree UGrid Functional Surface Options.<br />
<br />
<br />
[[File:SMS Functional Surface Opt updt.png|thumb|450 px|''Functional Surfaces Options'' dialog]]<br />
To create/display functional surfaces, enable them in the display options of the appropriate module, and specify their attributes which include:<br />
<br />
* ''Dataset'' &ndash; Selects which dataset is to be used to form the functional surface.<br />
:* Use active dataset<br />
:* User defined dataset <br />
* ''Z Offset'' &ndash; SMS displays functional surfaces at a simulated z-value. This may be the actual surface value (such as is the case with water surfaces elevations), but more often the value will not have a physical meaning, and may intersect the bathymetry or not even be in the same area. For this reason, SMS offers options for placing the functional surface at one of the following locations:<br />
** "Display surface at location"<br />
**"Display surface above geometry"<br />
**"Display surface with user defined offset"<br />
* ''Z Magnification'' &ndash; Functional data may not vary significantly when compared to the horizontal extents of the model. For this reason, the interface allows magnification (scaling) of the functional surface. By default, the surface is scaled based on the global z-magnification specified in the general display options. This may be overridden.<br />
:* Override global value<br />
:* Magnification value <br />
* ''Display Attributes'' &ndash; Controls the color of the functional surface. It may be a constant color or colored based on the contour colors specified. The colors may be associated with the value of the functional surface, or another dataset. The surface may also be partially transparent.<br />
:* ''Use solid color'' &ndash; This color can be turned on and off. It will get hidden if face contour options are engaged in the ''Functional Surface Other Options'' dialog.<br />
:* ''Transparency'' &ndash; Adjusts the transparency of the functional surface.<br />
:* ''Use active dataset for contours'' &ndash; Uses the active dataset to define the contours that get displayed.<br />
:* ''Specify Separate dataset for contours'' &ndash; Option to specify dataset other than the active dataset as the dataset for the contours.<br />
:** '''Select...''' &ndash; Opens a ''Select Scalar Dataset'' dialog for selecting the dataset for the contours.<br />
:* '''Other Display Options...''' &ndash; This opens the ''Functional Surface Other Options'' dialog. [[File:Functional Surface Other Opt.png|thumb|290px|''Functional Surface Other Options'' dialog.]]<br />
:** "Cell edges" &ndash; Controls whether the cells of the UGrid will be displayed on the functional surface. Selecting the line icon next to it opens the ''Line Properties'' dialog which allows for defining the style, width, and color of the cell edge lines.<br />
:** "Cell faces"<br />
:** "Points" &ndash; Controls whether the points of intersection of the UGrid lines will be displayed. Selecting the symbol icon next to it opens the ''Symbol Attributes'' dialog which allows for adjusting the size and color of the points represented on this surface.<br />
:** "Inactive points" &ndash; Controls whether point with an inactive dataset value are displayed. Selecting the symbol icon next to it opens the ''Symbol Attributes'' dialog which allows for adjusting the size and color of the inactive points represented on this surface.<br />
:** "UGrid boundary" &ndash; Controls whether the UGrid boundary will be displayed. Selecting the line icon next to it opens the ''Line Properties dialog'' dialog which allows for defining the style, width, and color of the cell edge lines.<br />
:** "Feature angle" &ndash; The UGrid boundary feature angle is used only when the UGrid Boundary option is selected.<br />
:** "Face contours" &ndash; Controls the display of cell face contours. When an object is contoured, the values associated with the active dataset for the object are used to generate the contours. Selecting '''Contours...''' will bring up a [[SMS:Contour Options|''Contour Options'']] dialog for adjusting face contour display.<br />
:** "Point contours" &ndash; Controls the display of points and their corresponding contour data. Instead of displaying a continuous contoured graphic, it will represent the data with contoured colors at the the points of the grid line intersections. These points will be displayed over the points being displayed by the "Points" option from earlier. However, if a larger point size is desired, those options can be adjusted by selecting the point icon next to the "Points" option. Selecting '''Contours...''' will bring up a ''Contour Options'' dialog for adjusting point contour display.</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:Functional_Surfaces&diff=157056SMS:Functional Surfaces2022-11-08T23:12:02Z<p>Rcorrigan: </p>
<hr />
<div>{{SMS_at_a_glance_functional_surfaces|Heading===At a glance==}}<br />
<br />
A functional surface is exactly that. It is a surface representing one of the functional datasets associated with a mesh, grid or TIN. The most intuitive example of a functional surface is the display of the water surface over a model's bathymetry. In this case, the surface represents an actual physical surface, but the functional surface could just as easily represent the velocity magnitude, or concentration, or any other scalar quantity.<br />
<br />
[[Image:SMS Functional Surface Opt.png|thumb|400 px|''Functional Surfaces Options'' dialog]]<br />
To create/display functional surfaces, enable them in the display options of the appropriate module, and specify their attributes which include:<br />
<br />
* ''Dataset'' &ndash; Selects which dataset is to be used to form the functional surface.<br />
:* ''Use active dataset'' &ndash; The currently selected dataset will be used for the functional surface.<br />
:* ''User defined dataset'' &ndash; Allows selecting a specific dataset in the project to use for the functional surface. The '''Select''' button for this option will bring a ''Select Dataset'' dialog.<br />
* ''Z Offset'' &ndash; SMS displays functional surfaces at a simulated z-value. This may be the actual surface value (such as is the case with water surfaces elevations), but more often the value will not have a physical meaning, and may intersect the bathymetry or not even be in the same area. For this reason, SMS offers options for placing the functional surface at one of the following locations:<br />
** "Display surface at location" &ndash; The functional surface will be displayed at the location of the dataset on the geometry.<br />
**"Display surface above geometry" &ndash; The functional surface will be displayed slightly above the geometry based on the z-magnification.<br />
**"Display surface with user defined offset" &ndash; The functional surface will be display based on a value entered by the user.<br />
***''Offset value'' &ndash; Enter an offset Z value for the user defined offset.<br />
* ''Z Magnification'' &ndash; Functional data may not vary significantly when compared to the horizontal extents of the model. For this reason, the interface allows magnification (scaling) of the functional surface. By default, the surface is scaled based on the global z-magnification specified in the general display options. This may be overridden.<br />
:* ''Override global value'' &ndash; Turn on to override the global Z magnification value. <br />
:** ''Magnification value'' &ndash; Enter a z magnification value to override the global value.<br />
* ''Display Attributes'' &ndash; Controls the color of the functional surface. It may be a constant color or colored based on the contour colors specified. The colors may be associated with the value of the functional surface, or another dataset. The surface may also be partially transparent.<br />
:* ''Use solid color'' &ndash; Will change the functional surface to be a single color.<br />
:**''Color'' &ndash; Select a color to use as the solid color for the functional surface. <br />
:* ''Transparency'' &ndash; Set a transparency level for the functional surface. The transparency by entering a value or using the slider.<br />
:* ''Contour surface'' &ndash; Sets specific contour options for the functional surface.<br />
:** '''Options''' &ndash; Will open the ''Dataset Contour Options'' dialog.<br />
:** ''Specify separate dataset for contours'' &ndash; Allows a different dataset to be used for the contour options.<br />
:*** '''Select''' &ndash; Brings up a ''Select Dataset'' dialog.<br />
<br />
<br />
==Related Topics==<br />
* [[SMS:Cartesian Grid Module Display Options|Cartesian Grid Display Options]]<br />
* [[SMS:Mesh Module Display Options|Mesh Display Options]]<br />
<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
[[Category:SMS Display Dialogs]]<br />
[[Category:SMS General Information|Functional]]<br />
[[Category:SMS Display Options]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:Dialog_GSSHA_Precipitation_-_Nexrad_radar.png&diff=157037File:Dialog GSSHA Precipitation - Nexrad radar.png2022-11-08T19:16:23Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:Dialog GSSHA Precipitation - Nexrad radar.png</p>
<hr />
<div>''GSSHA Precipitation'' dialog showing "Nexrad Radar" options in WMS.<br />
<br />
[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:Dialog_GSSHA_Precipitation_-_hyetograph.png&diff=157036File:Dialog GSSHA Precipitation - hyetograph.png2022-11-08T19:15:26Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:Dialog GSSHA Precipitation - hyetograph.png</p>
<hr />
<div>''GSSHA Precipitation'' dialog showing "Hyetograph" options in WMS.<br />
<br />
[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:Dialog_GSSHA_Precipitation_-_gage.png&diff=157035File:Dialog GSSHA Precipitation - gage.png2022-11-08T19:14:39Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:Dialog GSSHA Precipitation - gage.png</p>
<hr />
<div>''GSSHA Precipitation'' dialog showing "Gage" options in WMS.<br />
<br />
[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:Dialog_GSSHA_Precipitation.png&diff=157034File:Dialog GSSHA Precipitation.png2022-11-08T19:11:38Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:Dialog GSSHA Precipitation.png</p>
<hr />
<div>''GSSHA Precipitation'' dialog showing "Uniform" options in WMS.<br />
<br />
[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:TUFLOW_FV&diff=157027SMS:TUFLOW FV2022-11-07T20:17:51Z<p>Rcorrigan: /* Advanced */</p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= TUFLOW FV<br />
|model_type= Two-dimensional (2D) flexible mesh finite volume flood, tide and water quality simulation software. <br />
|developer= <br />
WBM [http://www.wbmpl.com.au/ BMT WBM (Australia)]<br />
|web_site= [http://www.tuflow.com/Tuflow%20FV.aspx www.tuflow.com]<br />
|tutorials= [http://www.aquaveo.com/software/sms-learning-tutorials SMS Learning Center]<br />
<br />
}}<br />
TUFLOW FV (which stands for Two-dimensional Unsteady FLOW Finite Volume) is a flexible mesh finite volume numerical model that simulates hydrodynamic, sediment transport and water quality processes in oceans, coastal waters, estuaries and rivers. The model may be used for coastal and nearshore environments including beaches and coastlines as well as offshore environments such as estuaries, river entrances and deltas, and floodplains. Uses include modeling river flood flow, [http://www.tuflow.com/Download/Publications/2013IAHR_A11315.pdf tsunami] inundation (the finite-volume scheme is well suited for a tsunami's mixed sub/super-critical flow regimes), beach erosion, ocean pollution, and estuary flow.<br />
<br />
Unlike the fixed square grids of TUFLOW Classic, the flexible triangular or quadrilateral mesh of TUFLOW FV allows users to modify mesh resolution spatially, seamlessly increasing the model resolution in areas of interest. This modelling approach reduces the number of computation cells needed in a model reducing run times. Additionally, TUFLOW FV can be run in parallel on multiple processors, threads, or computers.<br />
<br />
The TUFLOW FV model can be added to a [http://www.aquaveo.com/software/sms-pricing paid edition] of SMS.<br />
[[Category:Link to Store]]<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the dynamic model interface. It makes use of the SMS [[SMS:Simulations|simulation]] workflow.<br />
<br />
===TUFLOW FV Coverages===<br />
TUFLOW FV simulations require a boundary condition coverage and a materials coverage.<br />
<br />
====Boundary Conditions Coverage====<br />
[[File:TUFLOWFV AssignBC.png|thumb|300 px|The TUFLOW FV Assign Boundary Condition dialog]]<br />
The TUFLOW FV boundary conditions coverage allows assigning boundary condition attributes to arcs drawn in the coverage. These attributes will then be assigned, or snapped, to the 2D mesh during the simulation run.<br />
<br />
Attributes are assigned to arcs by right-clicking a selected arc and selecting the Assign BC command. This will open the ''Assign Boundary Condition'' dialog for TUFLOW FV.<br />
<br />
The TUFLOW FV ''Assign Boundary Condition'' dialog has the following options:<br />
<br />
''BC Options'' &ndash; The ''BC Options'' tab has options for assigning attributes to the arc.<br />
*''Type'' &ndash; The option here determines what type of boundary condition will be assigned to the arc. The following types are available:<br />
**"Monitor" &ndash; Sets the arc to be a monitoring line.<br />
**"HQ (Head Discharge)" &ndash; <br />
**"Q (Nodestring Flow)"<br />
**"QN (Head Discharge)"<br />
**"WL (Water Level)"<br />
**"WLS (Sloping Water Level"<br />
**"WL_CURT (Water Level Curtain"<br />
**"ZG (Zero Gradient)"<br />
*''Subtype''<br />
*''Define Curve''<br />
*''Friction slope''<br />
*''Dataset file''<br />
*''Define Varaibles''<br />
*''View Curve''<br />
*''Define default''<br />
**'Q default''<br />
*''Define offset''<br />
**''Q offset''<br />
*''Define scale''<br />
**''Q scale''<br />
*''Define update increment''<br />
**''Time''<br />
*''Include mean sea level pressure''<br />
<br />
====Materials====<br />
The TUFLOW FV materials coverage allows creating the polygons to hold the material attributes for the simulation run. The assigned material attributes will be mapped to the mesh/grid during the simulation run.<br />
<br />
===TUFLOW FV Simulation Menu===<br />
The TUFLOW FV simulation item in the Project Explorer contains a right-click menu with commands for accessing TUFLOW FV simulation options. The menu has the following commands:<br />
* '''Simulation Run Queue''' &ndash; Opens the ''Simulation Run Queue'' dialog.<br />
* '''Model Control''' &ndash; Opens the ''TUFLOWFV Model Control'' dialog.<br />
*'''Save Simulation''' &ndash; Saves the simulations and exports the simulations files needed for the simulation run.<br />
*'''Run Simulation''' &ndash; Runs the simulation using the exported simulation files. will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Save Project, Simulation and Run''' &ndash; Exports the simulation files, saves the project and project files, and runs the simulation. Will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Read Solution''' &ndash; Opens a browser to import the solution files.<br />
*'''Simulation Properties''' &ndash; Opens the ''Simulation Propertes'' dialog where basic information about the simulation can be viewed.<br />
The specific menu commands may be different depending on the selected option in the ''Preferences'' dialog.<br />
<br />
===TUFLOW FV Model Control===<br />
The ''TUFLOW FV Model Control'' dialog contains options for setting the parameters that will be used during the simulation run. The dialog is accessed by right-clicking on the simulation in the Project Explorer and selecting the '''Model Control''' command. The dialog contains multiple options organized on multiple tables. The options are as follows:<br />
====General====<br />
[[File:TUFLOWFV MC General.png|thumb|300 px|The ''General'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''General'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define spatial order'' &ndash; Option to define horizontal spatial scheme.<br />
**''Horizontal'' &ndash; Select "1st" order scheme or "2nd" order scheme.<br />
***"1st" &ndash; Sets the simulation to use a 1<sup>st</sup> order scheme. This can be used when there is not a significant difference between the results for 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's also generally used for the beginning stages of most model development.<br />
***"2nd" &ndash; Sets the simulation to use a 2<sup>nd</sup> order scheme. This is used when a significant difference is noticed between 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's usually tested in more advanced stages of model development. Fast-changing flow conditions or high gradients in conserved variables might warrant or necessitate use of this spatial scheme.<br />
*''Define display interval'' &ndash; Option to set the interval in seconds at which time step information will be displayed to the log and terminal window.<br />
**''Display interval'' &ndash; Sets the interval in seconds for the display of time step information.<br />
*''Define hardware solver'' &ndash; Option to enable computing through the CPU or the GPU. Can produce slight differences in results.<br />
**"CPU" &ndash; Calculations will use the "Central Processing Unit".<br />
**"GPU" &ndash; Calculations will use the "Graphical Processing Unit". Using GPU with TUFLOW<br />
***''Device ID'' &ndash; Option to select which GPU device is used for computers or GPUs with multiple CUDA enabled GPU cards. <br />
*''Warn on projection mismatch of GIS inputs'' &ndash; Sets the program to warn if GIS inputs are not all in the same projection.<br />
*''Tutorial model'' <!--&ndash; (Allows simulation of the TUFLOW Tutorial Models without the need for a TUFLOW license.??)--><br />
{{-}}<br />
<br />
====Time====<br />
[[File:TUFLOWFV MC Time.png|thumb|300 px|The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Simulation time''<br />
**''Use ISODate'' &ndash; Option to use ISODate format which requires data be input in the form dd/mm/yyyy HH:MM:SS. If left off, default time format is hours.<br />
**''Reference time'' &ndash; Will set simulation reference time. Times set for starting and ending have reference to this time. This can affect output times when processing and visualizing results from certain programs.<br />
**''Starting time'' &ndash; Will set simulation start time.<br />
**''Ending time'' &ndash; Will set simulation end time.<br />
*''Time step limits''<br />
**''CFL'' &ndash; Sets the Courant-Friedrichs-Lewy condition. Can be no larger than one since this is the theoretical stability limit. Often, inputting a value lower than one ensures greater model stability.<br />
**''Min time step(s)'' &ndash; Specifies minimum variable time step allowed according to CFL stability criterion.<br />
**''Max time step(s)'' &ndash; Specifies maximum variable time step allowed according to CFL stability criterion.<br />
{{-}}<br />
<br />
====Global parameters====<br />
[[File:TUFLOWFV MC Global.png|thumb|300 px|The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define bottom drag model'' &ndash; Option to specify bottom drag model for the simulation. The bottom drag model will be used to describe bed boundary resistance in the simulation. The same bottom drag model will be used for every calculation that uses it.<br />
**''Method'' &ndash; Option to set bottom drag model to use "Manning" or "KS".<br />
***"Manning" &ndash; Uses the Manning model and requires a Manning's ''n'' coefficient<br />
****''Manning's n coefficient'' &ndash; Sets the Manning's ''n'' coefficient.<br />
***"KS" &ndash; Uses a model that assumes a log-law velocity profile and requires specification of a surface roughness length-scale.<br />
****''Nikuradse roughness'' &ndash; Sets the Nikuradse roughness for the bottom drag model.<br />
*''Horizontal mixing model'' &ndash; Defines horizontal mixing eddy viscosity calculation according to options in drop-down menu. <!--((In TUFLOW FV documentation it's called momentum mixing model??))--><br />
**"None" &ndash; Will not represent horizontal momentum mixing. <br />
**"Constant" &ndash; Option to globally define a specific constant eddy viscosity.<br />
***''Global horizontal eddy viscosity'' &ndash; Specifies the constant eddy viscosity for the entire simulation.<br />
**"Smagorinsky" &ndash; The horizontal eddy viscosity will be calculated according to the Smagorinsky model which sets the diffusivity proportional to the local strain rate. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity coefficient'' &ndash; Sets the Smagorinsky coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets for the entire simulation the limits for the horizontal eddy viscosity values. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
**"Wu" &ndash; The horizontal eddy viscosity will be calculated according to the Wu model. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity'' &ndash; Sets the Wu coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets the limits for the horizontal eddy viscosity values for the entire simulation. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
*''Define stability limits'' &ndash; Option to define the maximum acceptable values relevant for the model. If water level or velocity exceed the given values, the model will stop computations and give an error. This feature helps to identify a model with instabilities by recognizing unrealistic values that the model produces. Small anomalies and acceptable spikes in data values will not stop computations.<br />
**''Maximum water level'' &ndash; Sets maximum acceptable water level for the model.<br />
**''Maximum velocity'' &ndash; Sets maximum acceptable velocity for the model.<br />
{{-}}<br />
<br />
====Wind stress====<br />
[[File:TUFLOWFV MC Wind.png|thumb|300 px|The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define wind model'' &ndash; Option to define the model used in calculating wind stress for any wind inputs in the simulation.<br />
**''Model'' &ndash; Drop-down menu with options for models that can be used to calculate wind stress.<br />
***"Wu" &ndash; Sets the wind stress model to the Wu model. Scales wind stress parameterisation based on wind speed.<br />
***"Constant" &ndash; Applies wind stress parameterisation using Bulk momentum transfer coefficient as in pre-2019 builds of TUFLOW.<br />
***"Kondo" &ndash; Applies a scaling factor <!--((for the wind stress parameters??))--> using a single term.<br />
*''Define wind parameters'' &ndash; <!--((Sets the wind drag coefficients that the selected model will use to scale the wind stress parameterisation??))--> Varies according to the wind model selected.<br />
**''Wa'' &ndash; <!--((??Wind speed in meters per second))--><br />
**''Ca'' &ndash; <br />
**''Wb'' &ndash;<br />
**''Cb'' &ndash;<br />
**''Bulk momentum transfer coefficient'' &ndash; Sets the coefficient for the Constant wind stress model.<br />
**''Scale factor'' &ndash; Sets the scaling factor for the Kondo wind stress model.<br />
{{-}}<br />
<br />
====Geometry====<br />
[[File:TUFLOWFV MC Geometry.png|thumb|300 px|The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define global bed elevation limits'' &ndash; Option to apply bed elevation limits to the entire model. Bed elevations in the model that are outside the set limits will be set to the minimum or the maximum. <br />
**''Bed elevation minimum'' &ndash; Defines minimum bed elevation. Bed Elevations in the model below this value will be set to this value.<br />
**''Bed elevation maximum'' &ndash; Defines maximum bed elevations. Bed Elevations in the model above this value will be set to this value.<br />
*''Define cell wet/dry depths'' &ndash; Sets the depth limits that define certain attributes of cells in the model.<br />
**''Dry depth'' &ndash; Sets a minimum depth value below which the simulation drops a cell from calculations.<br />
**''Wet depth'' &ndash; Sets a minimum depth value below which the simulation sets a cell's momentum to zero.<br />
*''Z modifications'' &ndash; Options for adjusting and applying elevation data<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a row of elevation data to the ''Z modifications'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of elevation data from the ''Z modifications'' table.<br />
**[[File:Row-up.svg|pi|16 px]]'''Move up''' &ndash; Moves the selected row of elevation data to be above the row immediately above it.<br />
**[[File:Row-down.svg|pi|16 px]] '''Move down''' &ndash; Moves the selected row of elevation data to be below the row immediately below it.<br />
**''Type'' &ndash; Option to select which type of elevation input is desired on this row of data. The other columns in the table become active or inactive based on the type selected here.<br />
**''Set Zpts'' &ndash; Sets elevation values for the center of all cells in the model domain to the given value.<br />
**''GRID Zpts'' &ndash; Interpolates a grid file to set elevations for the mesh cell center. Select '''(none selected)''' to open a dialog box and select the desired grid file. Either .asc or .flt. can be used for this feature.<br />
**''CSV File'' &ndash; Option to update cell elevations using a .csv file. The .csv file can identify cells using x,y coordinates or cell IDs.<br />
**''CSV Type'' &ndash; Select which type of data the .csv file will contain.<br />
***"Cell ID" &ndash; Sets the program to read the .csv file data for cell IDs matched with elevation data. <br />
***"Coordinate" &ndash; Sets the program to read the .csv file data for x,y coordinates matched with elevation data.<br />
**''ZLine Shapes'' &ndash; Sets breakline features and polygon features according to an already imported .shp or .mif/.mid file. Select '''(none selected)''' to open a dialog and select the desired file.<br />
**''ZPoint Shapes'' &ndash; Sets elevation points according to an already imported .shp or .mif/.mid file. Using this feature, multiple layers of elevation information can be used. This allows for dividing the layers for better data management. Select '''(none selected)''' to open the ''Select Z Point Layers'' dialog.<br />
=====Select Z Point Layers=====<br />
[[File:TUFLOWFV MC Geometry Select Zpt Layers.png|thumb|200 px|The ''Select Z Point Layers'' dialog which opens when '''Select Z Point Layers...''' is clicked in the ''Geometry'' tab.]]<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Opens a dialog for selecting a file to define the Z point layer. Adds that layer to a new table row.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of data.<br />
{{-}}<br />
<br />
====Initial conditions====<br />
[[File:TUFLOWFV MC Initial.png|thumb|300 px|The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define initial water level'' &ndash; Option set water level to a constant value for the entire simulation. It's best for the water level boundary conditions for the initial time steps to be as close as possible to this setting.<br />
*''Use restart file'' &ndash; Option to use a restart file to define the initial conditions for the current run. The restart file must come from a model that uses the same mesh, bathymetry, vertical layering, and number of conserved variables as the model for the current simulation.<br />
**'''Select...''' &ndash; Opens dialog box for selecting restart file to be used.<br />
**''Use restart file time'' &ndash; Option to use the time stamp on the restart file as the starting time of the current run. On by default.<br />
{{-}}<br />
<br />
====Output====<br />
[[File:TUFLOWFV MC Output.png|thumb|300px|The ''Output'' tab of the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Output'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Output blocks'' &ndash; Output blocks set output file types as well as certain output file properties. They also allow for selecting desired datasets to be included in the output file and the time steps at which to output the information.<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a output block to the ''Output blocks'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the selected output block from the ''Output blocks'' table.<br />
**"DATV" &ndash; SMS will give mapped output in DATV format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"XMDF" &ndash; SMS will give mapped output in XMDF format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"NetCDF" &ndash; SMS will give mapped output in NetCDF (network Common Data Form) format with user specified datasets and parameters. Includes mapped output information at the desired time intervals as well as information about model geometry.<br />
**"Flux" &ndash; Outputs a CSV file that will give the values of fluid flow and, if applicable, the movement of other quantities that cross model boundaries or other specified nodestrings.<br />
**"Mass" &ndash; Outputs a CSV file that can be used to check certain simulated quantities, mainly the volume of fluid within the model domain. <br />
**"Points" &ndash; Outputs a CSV file containing model parameter time-series. This includes coordinates and associated data for the points of interest. <!--((as defined in a coverage dedicated to this task.??))--><br />
**"Transport" &ndash; Outputs a NetCDF file that can be used to improve the runtime of subsequent advection-diffusion, sediment, or particle tracking simulations. It stores conserved variables on the TUFLOW FV mesh for use in future simulations.<br />
<br />
*''Output block options - Row (value of active row)'' &ndash; Gives options to define attributes and datasets for a selected output block. Many options are only available when certain output blocks are selected. (See table below)<br />
**''Output points feature coverage'' &ndash; Only available when a "Points" output block is active. Click '''Select...''' to set the coverage that will define the coordinates of the desired output points<br />
**''Define Interval'' &ndash; Option to set the interval for the specified output in seconds. If not specified, the program will produce the specified output at every time step, sometimes resulting in output files that are too large.<br />
**''Define start time'' &ndash; Sets output request start time. When not specified, the output start time will be the simulation start time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define final time'' &ndash; Sets output request final time. When not specified, the output final time will be the simulation end time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define compression'' &ndash; Option to compress output file.<br />
***''Compression on'' &ndash; If turned on, output file will be compressed. On by default.<br />
**''Define Statistics'' &ndash; Option to track minimum and/or maximum values of selected datasets.<br />
***''Type'' &ndash; Select the values to track from the drop-down menu.<br />
****"Both" &ndash; Both maximum and minimum values for selected datasets will be tracked.<br />
****"Minimums" &ndash; Only minimum values for selected datasets will be tracked. <br />
****"Maximums" &ndash; Only maximum values for selected datasets will be tracked.<br />
***''Define statistics dt'' &ndash; Option to define independent output interval for tracking of minimum and maximum values. If not defined, defaults to 0 and uses the model interval.<br />
**''Filename suffix'' &ndash; Option to specify a desired suffix for output file.<br />
**''Datasets'' &ndash; Specify datasets for inclusion in output file. This will only appear when a DATV, XMDF, NetCDF, or points output block is active. For more information, see the table below.<br />
*''Directories'' <br />
**''Log directory'' &ndash; Option to specify directory for simulation log file (.log) output. When not specified, log file will be written to same location as simulation control file.<br />
**''Output directory'' &ndash; Option to specify location in which simulation output files will be written. When not specified, output files will be written to same location as simulation control file.<br />
**''Write restart file'' &ndash; TUFLOW FV writes the values of the selected datasets in each cell at desired regular time steps. Specify these time steps in ''Write restart dt''.<br />
***''Write restart dt'' &ndash; Specify the desired interval of time steps at which TUFLOW FV will write the restart file.<br />
***''Enable restart overwrite'' &ndash; Option to overwrite the restart file being used at the time interval specified in ''Write restart dt''. On by default.<br />
**''Write check files'' &ndash; Option to create a number of check files that can be used to verify model inputs.<br />
***''Check files directory'' &ndash;<br />
**''Write empty GIS files'' &ndash; Option to automatically create GIS template files in .mid/.mif or .shp format with recommended GIS naming conventions that "contain the correct GIS attributes".<br />
***''Template files directory'' &ndash; Sets the location in which the empty GIS files will be written.<br />
<br />
<br />
<br />
{| class="wikitable"<br />
!Category<br />
! scope="col" style="width: 250px;" | Output Block Options<br />
!Output blocks that use this option<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="8"|General<br />
|-<br />
|''Output points feature coverage''<br />
|Points<br />
|-<br />
|''Define interval''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport <br />
|-<br />
|''Define start time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define final time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define compression''<br />
|XMDF, NetCDF<br />
|-<br />
|''Define statistics''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Filename suffix''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="20"|Datasets<br />
|''Water depth''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Water surface elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Surface shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity vector and magnitude''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity magnitude only''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Turbulent viscosity''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Evaporation rate''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category based on the Australian NSW Flood plain management Manual (NSWG, 2005)''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category as outlined by Australian Emergency Management Institute in 2014'' <br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Hazard categories for the Queensland Reconstruction Authority''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Mean sea level pressure''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Downward short-wave radiation flux''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Temperatre''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''10 m wind speed vector''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave height'' &ndash; typically significant wave height<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave period'' &ndash; typically peak wave period<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave direction''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave stress vector''<br />
|DATV, XMDF, NetCDF, Points<br />
<br />
|}<br />
<br />
<br />
====Materials====<br />
[[File:TUFLOWFV MC Material.png|thumb|300 px|The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define default material (set mat)'' &ndash; Sets the material settings for every cell in the model domain. This material and its attributes will be the assumed material for each cell <!--((unless a material block defines them otherwise??))--><br />
**''Override Bottom Roughness'' &ndash; Select to allow for editing bottom roughness of this material.<br />
**''Bottom Roughness'' &ndash; Sets the default bottom roughness for the entire model. Will be factored in according to the bottom drag model selected on the ''Global parameters'' tab. <br />
**''Advanced Options'' &ndash; Select '''Advanced...''' to open the ''Materials (advanced) - Default material (set mat)'' dialog.<br />
=====Materials (advanced) - Default material (set mat)=====<br />
*''Define horizontal eddy viscosity'' &ndash; Option to adjust the horizontal eddy viscosity settings for this material. The input asked for here varies depending on the horizontal mixing model selected on the ''Global Parameters'' tab.<br />
**''Horizontal eddy viscosity'' &ndash; Sets the horizontal eddy viscosity for this material. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to "None" or "Constant".<br />
**''Horizontal eddy viscosity coefficient'' &ndash; Sets the coefficient for either the "Wu" or "Smagorinsky" mixing models, depending on the model selected on the ''Global Parameters'' tab. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to ''Smagorinsky'' or ''Wu''.<br />
*''Define bed elevations limits'' &ndash; Option to set limits for the bed elevation of cells defined by this material.<br />
**''Minimum bed elevation'' &ndash; Sets minimum bed elevation.<br />
**''Maximum bed elevation'' &ndash; Sets maximum bed elevation.<br />
*''Spatial reconstruction'' &ndash; Option to limit spatial reconstruction <!--(??for cells that are defined by the default material)-->. This reverts the calculations for this area to first-order calculations in a model that is second-order. This has no effect if the model is already first order as defined in the ''General'' tab under ''Define spatial order''.<br />
[[File:TUFLOWFV MC Materials Advanced DM Set Mat.png|left|380px|The ''Materials (advanced) - Default material (set mat)'' dialog which opens when '''Advanced...''' is selected on the ''Materials'' tab.]]<br />
{{-}}<br />
<br />
====Boundary Conditions====<br />
[[File:TUFLOWFV MC Boundary Conditions.png|thumb|450px|The ''Boundary Conditions'' tab on the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Boundary conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define BC default update dt'' &ndash; Option to set the time step for all boundary conditions to update. If unspecified, TUFLOW FV will interpolate values to each time step. If specified, TUFLOW FV will keep all values after one update but before the next update at a constant value.<br />
**''BC default update dt'' &ndash; <!--((sets the time value of the time steps that TUFLOW FV will interpolate to??))--><br />
*''Run in transport mode'' &ndash; Option to run a simulation that includes a transport boundary condition. This option can be useful for later models that use many of the same conditions but require different inputs.<br />
**''Transport BC file'' &ndash; Click '''Select...''' to set which transport file will be used in this simulation.<br />
*''Global boundaries'' &ndash; Boundary condition blocks that can be used to apply conditions to every cell in the model domain. For example, it can be used to account for inflow from rain or evaporation.<br />
**[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a boundary condition block that specifies conditions over the entire model domain.<br />
**[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the active global boundary condition block.<br />
**''Type'' &ndash; Shows the type of boundary condition assigned to this boundary condition block.<br />
**''Attributes''<br />
***'''Assign BC''' &ndash; Opens the ''Assign Global Boundary Condition'' dialog.<br />
*''Gridded boundaries'' &ndash; <br />
** [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a Gridded BC row to the ''Gridded boundaries'' table. Opens the ''Define BC Grid'' dialog.<br />
** [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes a Gridded BC row from the ''Gridded boundaries'' table.<br />
**''Grid Definition''<br />
***'''Define Grid...''' &ndash; Opens ''Define BC Grid'' dialog for selecting the grid and associated settings for selected grid definition block.<br />
**''Boundaries''<br />
***'''Define BCs...''' &ndash; Opens ''Add Gridded BCs'' dialog.<br />
*''Global wave options'' &ndash: Options for use if a linked Boundary Conditions coverage with a wave boundary type and/or a gridded wave boundary defined.<br />
**''Include wave stress'' &ndash;<br />
**''Include Stokes drift'' &ndash; Option to include Stokes drift in calculations. <!--((Interpolates mass transport for cells between the deepwater and surfzone depth??))--><br />
<br />
======Assign Global Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Global BC.png|thumb|450px|The ''Assign Global Boundary Condition'' dialog which opens when '''Assign BC''' is selected on the ''Boundary conditions'' tab.]]<br />
*''Options'' &ndash; <br />
**''Type'' &ndash; Sets which type of boundary condition to set globally for the model. The one option is "QG (Global Cell Inflow)".<br />
***"QG (Global Cell Inflow)" &ndash; Sets boundary condition as flow into every cell in model domain. Useful to account for effects of rain or evaporation.<br />
**''Subtype'' &ndash; Option to adjust how a boundary type functions numerically in the model.<br />
***"Sub-type 1" &ndash; The interior model concentration will be used to determine the scalar flux.<br />
***"Sub-type 2" &ndash; The value specified in the BC file will determine the scalar flux.<br />
**'''Define Curve...''' &ndash; Opens "BC Curve Editor" dialog.<br />
<br />
**''Define default'' &ndash; Defines default value for a given variable when TUFLOW FV gets a null-value from a boundary condition input.<br />
***''Q/A default'' &ndash;<br />
**''Define offset'' &ndash; Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale<br />
***''Q/A offset'' &ndash;<br />
**''Define scale'' &ndash; Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
***''Q/A scale'' &ndash;<br />
**''Define update increment'' &ndash; Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
***''Time'' &ndash; The value of the update intervals of time steps.<br />
**''Includes mean sea level pressure'' &ndash; Option to specify if an inverse barometer offset is already included in a water level boundary condition. By default, it is on to indicate there is an inverse barometer offset included. If turned off, the difference between the local MSLP and the reference MSLP will be applied at the boundary.<br />
<br />
======BC Curve Editor======<br />
<!--This is the only dialog that RC didn't upload an image for--><br />
*''Define reference time'' &ndash; <br />
**''Use ISODate'' &ndash;<br />
**''Reference time'' &ndash;<br />
*''Number of rows''<br />
*''Time Units''<br />
*'''Import...'''<br />
*''Time''<br />
*''Q/A''<br />
*[[File:Pan Tool.svg|16px]]'''Pan''' &ndash;<br />
<br />
=====Define BC Grid=====<br />
[[File:TUFLOWFV MC BC Define BC Grid.png|thumb|350px|The ''Define BC Grid'' dialog, which opens when '''Define Grid''' is selected in ''Boundary conditions'' tab.]]<br />
*''Grid Definition'' &ndash; Space for defining the location, filename, and settings for a NetCDF file that will be used to map input files to the model mesh.<br />
**''File'' &ndash; Click '''Select...''' to set the NetCDF file that contains the coordinates that define a grid. The gridded boundary conditions will be applied to this grid.<br />
**''Name'' &ndash; Name applied to the grid. Name might be used later to refer to this grid by other boundary conditions in this model.<br />
**''NetCDF variables'' &ndash; Sets the variables from the NetCDF file that the program should use to create the grid map.<br />
***''X-Variable'' &ndash; <br />
***''Y-Variable'' &ndash;<br />
***''Z-Variable'' &ndash;<br />
**''Define vertical coordinate type'' &ndash; Option to specify the vertical coordinate convention. The different convention names correspond to distinct kinds of depth averaging. <br />
***"Elevation" &ndash; [https://fvwiki.tuflow.com/index.php?title=Depth_Averaging_Results]. Here is the information. Not sure how to interpret it yet.<br />
***"Depth" &ndash;<br />
***"Sigma" &ndash;<br />
***"Height" &ndash;<br />
**''Cell gridmap'' When turned off, TUFLOW FV does not calculate the interpolation weightings of model cells for this gridded boundary condition.<br />
**''Boundary gridmap'' &ndash; Turn on to calculate interpolation weightings from the grid onto the boundary nodestrings. <br />
**''Suppress coverage warnings'' &ndash; Will suppress warnings that indicate the grid does not cover the entire domain.<br />
<br />
=====Add Gridded BCs=====<br />
[[File:TUFLOWFV MC BC Add Gridded BC.png|thumb|300px|The ''Add Gridded BCs'' dialog which opens when '''Define BCs...''' is selected on the ''Boundary Conditions'' tab.]]<br />
This dialog allows for assigning multiple boundary conditions to the one grid in the selected row.<br />
* [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a gridded boundary condition block to the grid associated with the active grid block.<br />
* [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the selected gridded boundary condition block.<br />
*''Type'' &ndash; Shows the type of boundary condition grid assigned to this boundary condition block.<br />
*''Attributes'' &ndash; <br />
**'''Assign BC...''' &ndash; Opens ''Assign Gridded Boundary Condition'' dialog.<br />
<br />
<br />
======Assign Gridded Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Gridded BC.png|thumb|300px|''Assign Gridded Boundary Condition'' dialog which opens when '''Assign BC...''' is selected in the ''Add Gridded BCs'' dialog.]]<br />
*''Options'' &ndash; TUFLOW Manual 15.4.4 BC Scale and BC Offset<br />
**''Type'' &ndash; Sets type of boundary condition to be used.<br />
***"MSLP_Grid" &ndash; Sets boundary condition type to mean sea level pressure field.<br />
***"W10_Grid" &ndash; Sets boundary condition type to wind velocity at 10m.<br />
***"Wave" &ndash; <br />
**''Dataset file'' &ndash; Opens dialog to select NetCDF file to define the data for the boundary condition.<br />
**'''Define Variables''' &ndash; Opens ''Select NetCDF Gridded BC Variable Names'' dialog.<br />
**For ''Define default'', ''Define offset'', ''Define scale'', ''Define reference time'', ''Define time units'', and ''Define update increment'', see table below.<br />
<br />
{| class="wikitable"<br />
!Grid Type<br />
!Option or Variable<br />
! scope="col" style="width: 550px;" | Definition<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="6" | All Grids<br />
|''Define default''<br />
|Defines default value for a given variable when a boundary condition input gives TUFLOW FV a null-value. <br />
|-<br />
|''Define offset''<br />
|Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale.<br />
|-<br />
|''Define scale''<br />
|Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
|-<br />
|''Define reference time''<br />
|Sets reference time for the boundary condition. When not set, the reference time will be the same as the simulation time. Option set reference time in hours, which is the default. Turn on ''Use ISODate'' to use that format if desired.<br />
|-<br />
|''Define time units''<br />
|Sets time units to be used for the boundary condition. The options are: <br />
*"Days"<br />
*"Hours"<br />
*"Minutes"<br />
*"Seconds"<br />
*"Isotime"<br />
|-<br />
|''Define update increment''<br />
|Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
|-<br />
!rowspan="1" | MSLP_Grid<br />
|''MSLP''<br />
|Mean sea level pressure<br />
|-<br />
!rowspan="2" | W10_Grid<br />
|''W10_X''<br />
|"10 m wind speed vector"<br />
|-<br />
|''W10_Y''<br />
|"10 m wind speed vector"<br />
|-<br />
!rowspan="8" | Wave<br />
|''HSIGN''<br />
|Significant wave height <!--(??In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''TPS''<br />
|Smoothed peak wave period<br />
|-<br />
|''DIR''<br />
|Mean wave direction. This is direction to which waves are heading when the <br />
|-<br />
|''UBOT''<br />
|The rms-value <!--(root mean square value?)--> of the maxima of the orbital velocity near the bottom. If it is left undefined, TUFLOW FV will calculate it using linear wave theory.<br />
|-<br />
|''TMBOT''<br />
|The bottom wave period<br />
|-<br />
|''FORCE_X''<br />
|X wave induced force vector component (In TUFLOW FV documentation, it's usually called WFORCE_X except for in Table 15-3).<br />
|-<br />
|''FORCE_Y''<br />
|Y wave induced force vector component <!--(In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''DEPTH''<br />
|Wave model water depth<br />
|}<br />
<br />
======Select NetCDF Gridded BC Variable Names======<br />
[[File:TUFLOWFV MC BC Select NetCDF Gridded Variable Names.png|thumb|200px|The ''Select NetCDF Gridded BC Variable Names'' dialog which opens when '''Define Variables...''' is selected under the ''Assign Gridded Boundary Condition'' dialog. This dialog is for a "Waves" boundary condition type as selected on the ''Assign Gridded Boundary Condition'' dialog.]]<br />
*''Variable names'' &ndash; The variables that appear (other than TIME, which appears no matter which grid type is selected) will be exactly the same as the variables that appear in the ''Assign Gridded Boundary Condition'' dialog under ''Define default'', ''Define offset'', and ''Define scale''. It varies depending on the grid type selected.<br />
**''TIME variable name'' &ndash; <!--(??Advanced option to select a ??header in the selected file for the TIME variable. Does this vary depending on what file you have selected? Jeff, there's not much information, but it's on page 335 in Appendix F of TUFLOW FV manual--><br />
**Grid Specific variables<br />
***MSLP_GRID variables:<br />
****''MSLP variable name'' &ndash; Advanced option to select a header in the selected file for the MSLP variable.<br />
***W10_GRID variables:<br />
****''W10_X variable name'' &ndash; Advanced option to select a header in the selected file for the W10_X variable.<br />
****''W10_Y variable name'' &ndash; Advanced option to select a header in the selected file for the W10_Y variable.<br />
***Wave variables:<br />
****''HSIGN variable name'' &ndash; Advanced option to select a header in the selected file for the HSIGN variable.<br />
****''TPS variable name'' &ndash; Advanced option to select a header in the selected file for the TPS variable.<br />
****''DIR variable name'' &ndash; Advanced option to select a header in the selected file for the DIR variable.<br />
****''UBOT variable name'' &ndash; Advanced option to select a header in the selected file for the UBOT variable.<br />
****''TMBOT variable name'' &ndash; Advanced option to select a header in the selected file for the TMBOT variable.<br />
****''FORCE_X variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_X variable.<br />
****''FORCE_Y variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_Y variable.<br />
****''DEPTH variable name'' &ndash; Advanced option to select a header in the selected file for the DEPTH variable.<br />
<br />
====Simulation links====<br />
[[File:TUFLOWFV MC Simulationlinks.png|thumb|300 px|The ''Simulation Links'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Simulation links'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Brings up the ''Select Child TUFLOW FV Simulation'' dialog. In this dialog another TUFLOW FV simulation can be select to link as a child simulation to the current simulation.<br />
*[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Unlinks the selected simulation.<br />
{{-}}<br />
<br />
====Advanced====<br />
The ''Advanced'' tab of the ''TUFLOW FV Model Control'' dialog contains the option to include advanced options These options can be added in the text editor located in this tab. The text will be appended to the FVC file when the simulation is exported.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
<!--Obsolete<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the [[SMS:Generic Model Graphical Interface|generic model interface]].<br />
<br />
===TUFLOW FV Menu===<br />
If the TUFLOW FV model paremeters have been correctly loaded into SMS, the ''TUFLOW FV'' menu is available when the Mesh module is active. The menu has the following commands:<br />
*'''Check Mesh''' &ndash; Performs a general model check and will bring up the [[SMS:Model Checker|''Model Checker'']] dialog if errors are found.<br />
*'''Define Model''' &ndash; Opens the model definitions. This is only accessible to the TUFLOW FV model developers.<br />
*'''Global Parameters''' &ndash; Brings up the ''TUFLOW FV Global Parameters'' dialog where parameters for the model run are specified.<br />
*'''Assign BC''' &ndash; Brings up the ''TUFLOW FV Nodestring Boundary Conditions'' dialog. Available when a boundary nodestring is selected.<br />
*'''Material Properties''' &ndash; Brings up the ''TUFLOW FV Material Properties'' dialog.<br />
*'''Run TUFLOW FV''' &ndash; Launches the TUFLOW FV model run.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
--><br />
==External Links==<br />
*[http://www.tuflow.com/Download/TUFLOW_FV/Manual/FV-UserManual-2014.01.pdf TUFLOW FV Manual]<br />
*[http://fvwiki.tuflow.com/index.php?title=Main_Page TUFLOW FV Wiki]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|TUFLOW]]<br />
[[Category:TUFLOW|FV]]<br />
[[Category:Generic Interface]]<br />
[[Category:External Links]]<br />
[[Category:Needs Update]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:TUFLOW_FV&diff=157026SMS:TUFLOW FV2022-11-07T20:17:03Z<p>Rcorrigan: </p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= TUFLOW FV<br />
|model_type= Two-dimensional (2D) flexible mesh finite volume flood, tide and water quality simulation software. <br />
|developer= <br />
WBM [http://www.wbmpl.com.au/ BMT WBM (Australia)]<br />
|web_site= [http://www.tuflow.com/Tuflow%20FV.aspx www.tuflow.com]<br />
|tutorials= [http://www.aquaveo.com/software/sms-learning-tutorials SMS Learning Center]<br />
<br />
}}<br />
TUFLOW FV (which stands for Two-dimensional Unsteady FLOW Finite Volume) is a flexible mesh finite volume numerical model that simulates hydrodynamic, sediment transport and water quality processes in oceans, coastal waters, estuaries and rivers. The model may be used for coastal and nearshore environments including beaches and coastlines as well as offshore environments such as estuaries, river entrances and deltas, and floodplains. Uses include modeling river flood flow, [http://www.tuflow.com/Download/Publications/2013IAHR_A11315.pdf tsunami] inundation (the finite-volume scheme is well suited for a tsunami's mixed sub/super-critical flow regimes), beach erosion, ocean pollution, and estuary flow.<br />
<br />
Unlike the fixed square grids of TUFLOW Classic, the flexible triangular or quadrilateral mesh of TUFLOW FV allows users to modify mesh resolution spatially, seamlessly increasing the model resolution in areas of interest. This modelling approach reduces the number of computation cells needed in a model reducing run times. Additionally, TUFLOW FV can be run in parallel on multiple processors, threads, or computers.<br />
<br />
The TUFLOW FV model can be added to a [http://www.aquaveo.com/software/sms-pricing paid edition] of SMS.<br />
[[Category:Link to Store]]<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the dynamic model interface. It makes use of the SMS [[SMS:Simulations|simulation]] workflow.<br />
<br />
===TUFLOW FV Coverages===<br />
TUFLOW FV simulations require a boundary condition coverage and a materials coverage.<br />
<br />
====Boundary Conditions Coverage====<br />
[[File:TUFLOWFV AssignBC.png|thumb|300 px|The TUFLOW FV Assign Boundary Condition dialog]]<br />
The TUFLOW FV boundary conditions coverage allows assigning boundary condition attributes to arcs drawn in the coverage. These attributes will then be assigned, or snapped, to the 2D mesh during the simulation run.<br />
<br />
Attributes are assigned to arcs by right-clicking a selected arc and selecting the Assign BC command. This will open the ''Assign Boundary Condition'' dialog for TUFLOW FV.<br />
<br />
The TUFLOW FV ''Assign Boundary Condition'' dialog has the following options:<br />
<br />
''BC Options'' &ndash; The ''BC Options'' tab has options for assigning attributes to the arc.<br />
*''Type'' &ndash; The option here determines what type of boundary condition will be assigned to the arc. The following types are available:<br />
**"Monitor" &ndash; Sets the arc to be a monitoring line.<br />
**"HQ (Head Discharge)" &ndash; <br />
**"Q (Nodestring Flow)"<br />
**"QN (Head Discharge)"<br />
**"WL (Water Level)"<br />
**"WLS (Sloping Water Level"<br />
**"WL_CURT (Water Level Curtain"<br />
**"ZG (Zero Gradient)"<br />
*''Subtype''<br />
*''Define Curve''<br />
*''Friction slope''<br />
*''Dataset file''<br />
*''Define Varaibles''<br />
*''View Curve''<br />
*''Define default''<br />
**'Q default''<br />
*''Define offset''<br />
**''Q offset''<br />
*''Define scale''<br />
**''Q scale''<br />
*''Define update increment''<br />
**''Time''<br />
*''Include mean sea level pressure''<br />
<br />
====Materials====<br />
The TUFLOW FV materials coverage allows creating the polygons to hold the material attributes for the simulation run. The assigned material attributes will be mapped to the mesh/grid during the simulation run.<br />
<br />
===TUFLOW FV Simulation Menu===<br />
The TUFLOW FV simulation item in the Project Explorer contains a right-click menu with commands for accessing TUFLOW FV simulation options. The menu has the following commands:<br />
* '''Simulation Run Queue''' &ndash; Opens the ''Simulation Run Queue'' dialog.<br />
* '''Model Control''' &ndash; Opens the ''TUFLOWFV Model Control'' dialog.<br />
*'''Save Simulation''' &ndash; Saves the simulations and exports the simulations files needed for the simulation run.<br />
*'''Run Simulation''' &ndash; Runs the simulation using the exported simulation files. will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Save Project, Simulation and Run''' &ndash; Exports the simulation files, saves the project and project files, and runs the simulation. Will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Read Solution''' &ndash; Opens a browser to import the solution files.<br />
*'''Simulation Properties''' &ndash; Opens the ''Simulation Propertes'' dialog where basic information about the simulation can be viewed.<br />
The specific menu commands may be different depending on the selected option in the ''Preferences'' dialog.<br />
<br />
===TUFLOW FV Model Control===<br />
The ''TUFLOW FV Model Control'' dialog contains options for setting the parameters that will be used during the simulation run. The dialog is accessed by right-clicking on the simulation in the Project Explorer and selecting the '''Model Control''' command. The dialog contains multiple options organized on multiple tables. The options are as follows:<br />
====General====<br />
[[File:TUFLOWFV MC General.png|thumb|300 px|The ''General'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''General'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define spatial order'' &ndash; Option to define horizontal spatial scheme.<br />
**''Horizontal'' &ndash; Select "1st" order scheme or "2nd" order scheme.<br />
***"1st" &ndash; Sets the simulation to use a 1<sup>st</sup> order scheme. This can be used when there is not a significant difference between the results for 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's also generally used for the beginning stages of most model development.<br />
***"2nd" &ndash; Sets the simulation to use a 2<sup>nd</sup> order scheme. This is used when a significant difference is noticed between 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's usually tested in more advanced stages of model development. Fast-changing flow conditions or high gradients in conserved variables might warrant or necessitate use of this spatial scheme.<br />
*''Define display interval'' &ndash; Option to set the interval in seconds at which time step information will be displayed to the log and terminal window.<br />
**''Display interval'' &ndash; Sets the interval in seconds for the display of time step information.<br />
*''Define hardware solver'' &ndash; Option to enable computing through the CPU or the GPU. Can produce slight differences in results.<br />
**"CPU" &ndash; Calculations will use the "Central Processing Unit".<br />
**"GPU" &ndash; Calculations will use the "Graphical Processing Unit". Using GPU with TUFLOW<br />
***''Device ID'' &ndash; Option to select which GPU device is used for computers or GPUs with multiple CUDA enabled GPU cards. <br />
*''Warn on projection mismatch of GIS inputs'' &ndash; Sets the program to warn if GIS inputs are not all in the same projection.<br />
*''Tutorial model'' <!--&ndash; (Allows simulation of the TUFLOW Tutorial Models without the need for a TUFLOW license.??)--><br />
{{-}}<br />
<br />
====Time====<br />
[[File:TUFLOWFV MC Time.png|thumb|300 px|The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Simulation time''<br />
**''Use ISODate'' &ndash; Option to use ISODate format which requires data be input in the form dd/mm/yyyy HH:MM:SS. If left off, default time format is hours.<br />
**''Reference time'' &ndash; Will set simulation reference time. Times set for starting and ending have reference to this time. This can affect output times when processing and visualizing results from certain programs.<br />
**''Starting time'' &ndash; Will set simulation start time.<br />
**''Ending time'' &ndash; Will set simulation end time.<br />
*''Time step limits''<br />
**''CFL'' &ndash; Sets the Courant-Friedrichs-Lewy condition. Can be no larger than one since this is the theoretical stability limit. Often, inputting a value lower than one ensures greater model stability.<br />
**''Min time step(s)'' &ndash; Specifies minimum variable time step allowed according to CFL stability criterion.<br />
**''Max time step(s)'' &ndash; Specifies maximum variable time step allowed according to CFL stability criterion.<br />
{{-}}<br />
<br />
====Global parameters====<br />
[[File:TUFLOWFV MC Global.png|thumb|300 px|The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define bottom drag model'' &ndash; Option to specify bottom drag model for the simulation. The bottom drag model will be used to describe bed boundary resistance in the simulation. The same bottom drag model will be used for every calculation that uses it.<br />
**''Method'' &ndash; Option to set bottom drag model to use "Manning" or "KS".<br />
***"Manning" &ndash; Uses the Manning model and requires a Manning's ''n'' coefficient<br />
****''Manning's n coefficient'' &ndash; Sets the Manning's ''n'' coefficient.<br />
***"KS" &ndash; Uses a model that assumes a log-law velocity profile and requires specification of a surface roughness length-scale.<br />
****''Nikuradse roughness'' &ndash; Sets the Nikuradse roughness for the bottom drag model.<br />
*''Horizontal mixing model'' &ndash; Defines horizontal mixing eddy viscosity calculation according to options in drop-down menu. <!--((In TUFLOW FV documentation it's called momentum mixing model??))--><br />
**"None" &ndash; Will not represent horizontal momentum mixing. <br />
**"Constant" &ndash; Option to globally define a specific constant eddy viscosity.<br />
***''Global horizontal eddy viscosity'' &ndash; Specifies the constant eddy viscosity for the entire simulation.<br />
**"Smagorinsky" &ndash; The horizontal eddy viscosity will be calculated according to the Smagorinsky model which sets the diffusivity proportional to the local strain rate. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity coefficient'' &ndash; Sets the Smagorinsky coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets for the entire simulation the limits for the horizontal eddy viscosity values. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
**"Wu" &ndash; The horizontal eddy viscosity will be calculated according to the Wu model. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity'' &ndash; Sets the Wu coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets the limits for the horizontal eddy viscosity values for the entire simulation. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
*''Define stability limits'' &ndash; Option to define the maximum acceptable values relevant for the model. If water level or velocity exceed the given values, the model will stop computations and give an error. This feature helps to identify a model with instabilities by recognizing unrealistic values that the model produces. Small anomalies and acceptable spikes in data values will not stop computations.<br />
**''Maximum water level'' &ndash; Sets maximum acceptable water level for the model.<br />
**''Maximum velocity'' &ndash; Sets maximum acceptable velocity for the model.<br />
{{-}}<br />
<br />
====Wind stress====<br />
[[File:TUFLOWFV MC Wind.png|thumb|300 px|The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define wind model'' &ndash; Option to define the model used in calculating wind stress for any wind inputs in the simulation.<br />
**''Model'' &ndash; Drop-down menu with options for models that can be used to calculate wind stress.<br />
***"Wu" &ndash; Sets the wind stress model to the Wu model. Scales wind stress parameterisation based on wind speed.<br />
***"Constant" &ndash; Applies wind stress parameterisation using Bulk momentum transfer coefficient as in pre-2019 builds of TUFLOW.<br />
***"Kondo" &ndash; Applies a scaling factor <!--((for the wind stress parameters??))--> using a single term.<br />
*''Define wind parameters'' &ndash; <!--((Sets the wind drag coefficients that the selected model will use to scale the wind stress parameterisation??))--> Varies according to the wind model selected.<br />
**''Wa'' &ndash; <!--((??Wind speed in meters per second))--><br />
**''Ca'' &ndash; <br />
**''Wb'' &ndash;<br />
**''Cb'' &ndash;<br />
**''Bulk momentum transfer coefficient'' &ndash; Sets the coefficient for the Constant wind stress model.<br />
**''Scale factor'' &ndash; Sets the scaling factor for the Kondo wind stress model.<br />
{{-}}<br />
<br />
====Geometry====<br />
[[File:TUFLOWFV MC Geometry.png|thumb|300 px|The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define global bed elevation limits'' &ndash; Option to apply bed elevation limits to the entire model. Bed elevations in the model that are outside the set limits will be set to the minimum or the maximum. <br />
**''Bed elevation minimum'' &ndash; Defines minimum bed elevation. Bed Elevations in the model below this value will be set to this value.<br />
**''Bed elevation maximum'' &ndash; Defines maximum bed elevations. Bed Elevations in the model above this value will be set to this value.<br />
*''Define cell wet/dry depths'' &ndash; Sets the depth limits that define certain attributes of cells in the model.<br />
**''Dry depth'' &ndash; Sets a minimum depth value below which the simulation drops a cell from calculations.<br />
**''Wet depth'' &ndash; Sets a minimum depth value below which the simulation sets a cell's momentum to zero.<br />
*''Z modifications'' &ndash; Options for adjusting and applying elevation data<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a row of elevation data to the ''Z modifications'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of elevation data from the ''Z modifications'' table.<br />
**[[File:Row-up.svg|pi|16 px]]'''Move up''' &ndash; Moves the selected row of elevation data to be above the row immediately above it.<br />
**[[File:Row-down.svg|pi|16 px]] '''Move down''' &ndash; Moves the selected row of elevation data to be below the row immediately below it.<br />
**''Type'' &ndash; Option to select which type of elevation input is desired on this row of data. The other columns in the table become active or inactive based on the type selected here.<br />
**''Set Zpts'' &ndash; Sets elevation values for the center of all cells in the model domain to the given value.<br />
**''GRID Zpts'' &ndash; Interpolates a grid file to set elevations for the mesh cell center. Select '''(none selected)''' to open a dialog box and select the desired grid file. Either .asc or .flt. can be used for this feature.<br />
**''CSV File'' &ndash; Option to update cell elevations using a .csv file. The .csv file can identify cells using x,y coordinates or cell IDs.<br />
**''CSV Type'' &ndash; Select which type of data the .csv file will contain.<br />
***"Cell ID" &ndash; Sets the program to read the .csv file data for cell IDs matched with elevation data. <br />
***"Coordinate" &ndash; Sets the program to read the .csv file data for x,y coordinates matched with elevation data.<br />
**''ZLine Shapes'' &ndash; Sets breakline features and polygon features according to an already imported .shp or .mif/.mid file. Select '''(none selected)''' to open a dialog and select the desired file.<br />
**''ZPoint Shapes'' &ndash; Sets elevation points according to an already imported .shp or .mif/.mid file. Using this feature, multiple layers of elevation information can be used. This allows for dividing the layers for better data management. Select '''(none selected)''' to open the ''Select Z Point Layers'' dialog.<br />
=====Select Z Point Layers=====<br />
[[File:TUFLOWFV MC Geometry Select Zpt Layers.png|thumb|200 px|The ''Select Z Point Layers'' dialog which opens when '''Select Z Point Layers...''' is clicked in the ''Geometry'' tab.]]<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Opens a dialog for selecting a file to define the Z point layer. Adds that layer to a new table row.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of data.<br />
{{-}}<br />
<br />
====Initial conditions====<br />
[[File:TUFLOWFV MC Initial.png|thumb|300 px|The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define initial water level'' &ndash; Option set water level to a constant value for the entire simulation. It's best for the water level boundary conditions for the initial time steps to be as close as possible to this setting.<br />
*''Use restart file'' &ndash; Option to use a restart file to define the initial conditions for the current run. The restart file must come from a model that uses the same mesh, bathymetry, vertical layering, and number of conserved variables as the model for the current simulation.<br />
**'''Select...''' &ndash; Opens dialog box for selecting restart file to be used.<br />
**''Use restart file time'' &ndash; Option to use the time stamp on the restart file as the starting time of the current run. On by default.<br />
{{-}}<br />
<br />
====Output====<br />
[[File:TUFLOWFV MC Output.png|thumb|300px|The ''Output'' tab of the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Output'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Output blocks'' &ndash; Output blocks set output file types as well as certain output file properties. They also allow for selecting desired datasets to be included in the output file and the time steps at which to output the information.<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a output block to the ''Output blocks'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the selected output block from the ''Output blocks'' table.<br />
**"DATV" &ndash; SMS will give mapped output in DATV format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"XMDF" &ndash; SMS will give mapped output in XMDF format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"NetCDF" &ndash; SMS will give mapped output in NetCDF (network Common Data Form) format with user specified datasets and parameters. Includes mapped output information at the desired time intervals as well as information about model geometry.<br />
**"Flux" &ndash; Outputs a CSV file that will give the values of fluid flow and, if applicable, the movement of other quantities that cross model boundaries or other specified nodestrings.<br />
**"Mass" &ndash; Outputs a CSV file that can be used to check certain simulated quantities, mainly the volume of fluid within the model domain. <br />
**"Points" &ndash; Outputs a CSV file containing model parameter time-series. This includes coordinates and associated data for the points of interest. <!--((as defined in a coverage dedicated to this task.??))--><br />
**"Transport" &ndash; Outputs a NetCDF file that can be used to improve the runtime of subsequent advection-diffusion, sediment, or particle tracking simulations. It stores conserved variables on the TUFLOW FV mesh for use in future simulations.<br />
<br />
*''Output block options - Row (value of active row)'' &ndash; Gives options to define attributes and datasets for a selected output block. Many options are only available when certain output blocks are selected. (See table below)<br />
**''Output points feature coverage'' &ndash; Only available when a "Points" output block is active. Click '''Select...''' to set the coverage that will define the coordinates of the desired output points<br />
**''Define Interval'' &ndash; Option to set the interval for the specified output in seconds. If not specified, the program will produce the specified output at every time step, sometimes resulting in output files that are too large.<br />
**''Define start time'' &ndash; Sets output request start time. When not specified, the output start time will be the simulation start time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define final time'' &ndash; Sets output request final time. When not specified, the output final time will be the simulation end time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define compression'' &ndash; Option to compress output file.<br />
***''Compression on'' &ndash; If turned on, output file will be compressed. On by default.<br />
**''Define Statistics'' &ndash; Option to track minimum and/or maximum values of selected datasets.<br />
***''Type'' &ndash; Select the values to track from the drop-down menu.<br />
****"Both" &ndash; Both maximum and minimum values for selected datasets will be tracked.<br />
****"Minimums" &ndash; Only minimum values for selected datasets will be tracked. <br />
****"Maximums" &ndash; Only maximum values for selected datasets will be tracked.<br />
***''Define statistics dt'' &ndash; Option to define independent output interval for tracking of minimum and maximum values. If not defined, defaults to 0 and uses the model interval.<br />
**''Filename suffix'' &ndash; Option to specify a desired suffix for output file.<br />
**''Datasets'' &ndash; Specify datasets for inclusion in output file. This will only appear when a DATV, XMDF, NetCDF, or points output block is active. For more information, see the table below.<br />
*''Directories'' <br />
**''Log directory'' &ndash; Option to specify directory for simulation log file (.log) output. When not specified, log file will be written to same location as simulation control file.<br />
**''Output directory'' &ndash; Option to specify location in which simulation output files will be written. When not specified, output files will be written to same location as simulation control file.<br />
**''Write restart file'' &ndash; TUFLOW FV writes the values of the selected datasets in each cell at desired regular time steps. Specify these time steps in ''Write restart dt''.<br />
***''Write restart dt'' &ndash; Specify the desired interval of time steps at which TUFLOW FV will write the restart file.<br />
***''Enable restart overwrite'' &ndash; Option to overwrite the restart file being used at the time interval specified in ''Write restart dt''. On by default.<br />
**''Write check files'' &ndash; Option to create a number of check files that can be used to verify model inputs.<br />
***''Check files directory'' &ndash;<br />
**''Write empty GIS files'' &ndash; Option to automatically create GIS template files in .mid/.mif or .shp format with recommended GIS naming conventions that "contain the correct GIS attributes".<br />
***''Template files directory'' &ndash; Sets the location in which the empty GIS files will be written.<br />
<br />
<br />
<br />
{| class="wikitable"<br />
!Category<br />
! scope="col" style="width: 250px;" | Output Block Options<br />
!Output blocks that use this option<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="8"|General<br />
|-<br />
|''Output points feature coverage''<br />
|Points<br />
|-<br />
|''Define interval''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport <br />
|-<br />
|''Define start time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define final time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define compression''<br />
|XMDF, NetCDF<br />
|-<br />
|''Define statistics''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Filename suffix''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="20"|Datasets<br />
|''Water depth''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Water surface elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Surface shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity vector and magnitude''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity magnitude only''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Turbulent viscosity''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Evaporation rate''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category based on the Australian NSW Flood plain management Manual (NSWG, 2005)''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category as outlined by Australian Emergency Management Institute in 2014'' <br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Hazard categories for the Queensland Reconstruction Authority''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Mean sea level pressure''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Downward short-wave radiation flux''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Temperatre''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''10 m wind speed vector''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave height'' &ndash; typically significant wave height<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave period'' &ndash; typically peak wave period<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave direction''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave stress vector''<br />
|DATV, XMDF, NetCDF, Points<br />
<br />
|}<br />
<br />
<br />
====Materials====<br />
[[File:TUFLOWFV MC Material.png|thumb|300 px|The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define default material (set mat)'' &ndash; Sets the material settings for every cell in the model domain. This material and its attributes will be the assumed material for each cell <!--((unless a material block defines them otherwise??))--><br />
**''Override Bottom Roughness'' &ndash; Select to allow for editing bottom roughness of this material.<br />
**''Bottom Roughness'' &ndash; Sets the default bottom roughness for the entire model. Will be factored in according to the bottom drag model selected on the ''Global parameters'' tab. <br />
**''Advanced Options'' &ndash; Select '''Advanced...''' to open the ''Materials (advanced) - Default material (set mat)'' dialog.<br />
=====Materials (advanced) - Default material (set mat)=====<br />
*''Define horizontal eddy viscosity'' &ndash; Option to adjust the horizontal eddy viscosity settings for this material. The input asked for here varies depending on the horizontal mixing model selected on the ''Global Parameters'' tab.<br />
**''Horizontal eddy viscosity'' &ndash; Sets the horizontal eddy viscosity for this material. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to "None" or "Constant".<br />
**''Horizontal eddy viscosity coefficient'' &ndash; Sets the coefficient for either the "Wu" or "Smagorinsky" mixing models, depending on the model selected on the ''Global Parameters'' tab. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to ''Smagorinsky'' or ''Wu''.<br />
*''Define bed elevations limits'' &ndash; Option to set limits for the bed elevation of cells defined by this material.<br />
**''Minimum bed elevation'' &ndash; Sets minimum bed elevation.<br />
**''Maximum bed elevation'' &ndash; Sets maximum bed elevation.<br />
*''Spatial reconstruction'' &ndash; Option to limit spatial reconstruction <!--(??for cells that are defined by the default material)-->. This reverts the calculations for this area to first-order calculations in a model that is second-order. This has no effect if the model is already first order as defined in the ''General'' tab under ''Define spatial order''.<br />
[[File:TUFLOWFV MC Materials Advanced DM Set Mat.png|left|380px|The ''Materials (advanced) - Default material (set mat)'' dialog which opens when '''Advanced...''' is selected on the ''Materials'' tab.]]<br />
{{-}}<br />
<br />
====Boundary Conditions====<br />
[[File:TUFLOWFV MC Boundary Conditions.png|thumb|450px|The ''Boundary Conditions'' tab on the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Boundary conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define BC default update dt'' &ndash; Option to set the time step for all boundary conditions to update. If unspecified, TUFLOW FV will interpolate values to each time step. If specified, TUFLOW FV will keep all values after one update but before the next update at a constant value.<br />
**''BC default update dt'' &ndash; <!--((sets the time value of the time steps that TUFLOW FV will interpolate to??))--><br />
*''Run in transport mode'' &ndash; Option to run a simulation that includes a transport boundary condition. This option can be useful for later models that use many of the same conditions but require different inputs.<br />
**''Transport BC file'' &ndash; Click '''Select...''' to set which transport file will be used in this simulation.<br />
*''Global boundaries'' &ndash; Boundary condition blocks that can be used to apply conditions to every cell in the model domain. For example, it can be used to account for inflow from rain or evaporation.<br />
**[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a boundary condition block that specifies conditions over the entire model domain.<br />
**[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the active global boundary condition block.<br />
**''Type'' &ndash; Shows the type of boundary condition assigned to this boundary condition block.<br />
**''Attributes''<br />
***'''Assign BC''' &ndash; Opens the ''Assign Global Boundary Condition'' dialog.<br />
*''Gridded boundaries'' &ndash; <br />
** [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a Gridded BC row to the ''Gridded boundaries'' table. Opens the ''Define BC Grid'' dialog.<br />
** [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes a Gridded BC row from the ''Gridded boundaries'' table.<br />
**''Grid Definition''<br />
***'''Define Grid...''' &ndash; Opens ''Define BC Grid'' dialog for selecting the grid and associated settings for selected grid definition block.<br />
**''Boundaries''<br />
***'''Define BCs...''' &ndash; Opens ''Add Gridded BCs'' dialog.<br />
*''Global wave options'' &ndash: Options for use if a linked Boundary Conditions coverage with a wave boundary type and/or a gridded wave boundary defined.<br />
**''Include wave stress'' &ndash;<br />
**''Include Stokes drift'' &ndash; Option to include Stokes drift in calculations. <!--((Interpolates mass transport for cells between the deepwater and surfzone depth??))--><br />
<br />
======Assign Global Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Global BC.png|thumb|450px|The ''Assign Global Boundary Condition'' dialog which opens when '''Assign BC''' is selected on the ''Boundary conditions'' tab.]]<br />
*''Options'' &ndash; <br />
**''Type'' &ndash; Sets which type of boundary condition to set globally for the model. The one option is "QG (Global Cell Inflow)".<br />
***"QG (Global Cell Inflow)" &ndash; Sets boundary condition as flow into every cell in model domain. Useful to account for effects of rain or evaporation.<br />
**''Subtype'' &ndash; Option to adjust how a boundary type functions numerically in the model.<br />
***"Sub-type 1" &ndash; The interior model concentration will be used to determine the scalar flux.<br />
***"Sub-type 2" &ndash; The value specified in the BC file will determine the scalar flux.<br />
**'''Define Curve...''' &ndash; Opens "BC Curve Editor" dialog.<br />
<br />
**''Define default'' &ndash; Defines default value for a given variable when TUFLOW FV gets a null-value from a boundary condition input.<br />
***''Q/A default'' &ndash;<br />
**''Define offset'' &ndash; Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale<br />
***''Q/A offset'' &ndash;<br />
**''Define scale'' &ndash; Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
***''Q/A scale'' &ndash;<br />
**''Define update increment'' &ndash; Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
***''Time'' &ndash; The value of the update intervals of time steps.<br />
**''Includes mean sea level pressure'' &ndash; Option to specify if an inverse barometer offset is already included in a water level boundary condition. By default, it is on to indicate there is an inverse barometer offset included. If turned off, the difference between the local MSLP and the reference MSLP will be applied at the boundary.<br />
<br />
======BC Curve Editor======<br />
<!--This is the only dialog that RC didn't upload an image for--><br />
*''Define reference time'' &ndash; <br />
**''Use ISODate'' &ndash;<br />
**''Reference time'' &ndash;<br />
*''Number of rows''<br />
*''Time Units''<br />
*'''Import...'''<br />
*''Time''<br />
*''Q/A''<br />
*[[File:Pan Tool.svg|16px]]'''Pan''' &ndash;<br />
<br />
=====Define BC Grid=====<br />
[[File:TUFLOWFV MC BC Define BC Grid.png|thumb|350px|The ''Define BC Grid'' dialog, which opens when '''Define Grid''' is selected in ''Boundary conditions'' tab.]]<br />
*''Grid Definition'' &ndash; Space for defining the location, filename, and settings for a NetCDF file that will be used to map input files to the model mesh.<br />
**''File'' &ndash; Click '''Select...''' to set the NetCDF file that contains the coordinates that define a grid. The gridded boundary conditions will be applied to this grid.<br />
**''Name'' &ndash; Name applied to the grid. Name might be used later to refer to this grid by other boundary conditions in this model.<br />
**''NetCDF variables'' &ndash; Sets the variables from the NetCDF file that the program should use to create the grid map.<br />
***''X-Variable'' &ndash; <br />
***''Y-Variable'' &ndash;<br />
***''Z-Variable'' &ndash;<br />
**''Define vertical coordinate type'' &ndash; Option to specify the vertical coordinate convention. The different convention names correspond to distinct kinds of depth averaging. <br />
***"Elevation" &ndash; [https://fvwiki.tuflow.com/index.php?title=Depth_Averaging_Results]. Here is the information. Not sure how to interpret it yet.<br />
***"Depth" &ndash;<br />
***"Sigma" &ndash;<br />
***"Height" &ndash;<br />
**''Cell gridmap'' When turned off, TUFLOW FV does not calculate the interpolation weightings of model cells for this gridded boundary condition.<br />
**''Boundary gridmap'' &ndash; Turn on to calculate interpolation weightings from the grid onto the boundary nodestrings. <br />
**''Suppress coverage warnings'' &ndash; Will suppress warnings that indicate the grid does not cover the entire domain.<br />
<br />
=====Add Gridded BCs=====<br />
[[File:TUFLOWFV MC BC Add Gridded BC.png|thumb|300px|The ''Add Gridded BCs'' dialog which opens when '''Define BCs...''' is selected on the ''Boundary Conditions'' tab.]]<br />
This dialog allows for assigning multiple boundary conditions to the one grid in the selected row.<br />
* [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a gridded boundary condition block to the grid associated with the active grid block.<br />
* [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the selected gridded boundary condition block.<br />
*''Type'' &ndash; Shows the type of boundary condition grid assigned to this boundary condition block.<br />
*''Attributes'' &ndash; <br />
**'''Assign BC...''' &ndash; Opens ''Assign Gridded Boundary Condition'' dialog.<br />
<br />
<br />
======Assign Gridded Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Gridded BC.png|thumb|300px|''Assign Gridded Boundary Condition'' dialog which opens when '''Assign BC...''' is selected in the ''Add Gridded BCs'' dialog.]]<br />
*''Options'' &ndash; TUFLOW Manual 15.4.4 BC Scale and BC Offset<br />
**''Type'' &ndash; Sets type of boundary condition to be used.<br />
***"MSLP_Grid" &ndash; Sets boundary condition type to mean sea level pressure field.<br />
***"W10_Grid" &ndash; Sets boundary condition type to wind velocity at 10m.<br />
***"Wave" &ndash; <br />
**''Dataset file'' &ndash; Opens dialog to select NetCDF file to define the data for the boundary condition.<br />
**'''Define Variables''' &ndash; Opens ''Select NetCDF Gridded BC Variable Names'' dialog.<br />
**For ''Define default'', ''Define offset'', ''Define scale'', ''Define reference time'', ''Define time units'', and ''Define update increment'', see table below.<br />
<br />
{| class="wikitable"<br />
!Grid Type<br />
!Option or Variable<br />
! scope="col" style="width: 550px;" | Definition<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="6" | All Grids<br />
|''Define default''<br />
|Defines default value for a given variable when a boundary condition input gives TUFLOW FV a null-value. <br />
|-<br />
|''Define offset''<br />
|Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale.<br />
|-<br />
|''Define scale''<br />
|Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
|-<br />
|''Define reference time''<br />
|Sets reference time for the boundary condition. When not set, the reference time will be the same as the simulation time. Option set reference time in hours, which is the default. Turn on ''Use ISODate'' to use that format if desired.<br />
|-<br />
|''Define time units''<br />
|Sets time units to be used for the boundary condition. The options are: <br />
*"Days"<br />
*"Hours"<br />
*"Minutes"<br />
*"Seconds"<br />
*"Isotime"<br />
|-<br />
|''Define update increment''<br />
|Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
|-<br />
!rowspan="1" | MSLP_Grid<br />
|''MSLP''<br />
|Mean sea level pressure<br />
|-<br />
!rowspan="2" | W10_Grid<br />
|''W10_X''<br />
|"10 m wind speed vector"<br />
|-<br />
|''W10_Y''<br />
|"10 m wind speed vector"<br />
|-<br />
!rowspan="8" | Wave<br />
|''HSIGN''<br />
|Significant wave height <!--(??In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''TPS''<br />
|Smoothed peak wave period<br />
|-<br />
|''DIR''<br />
|Mean wave direction. This is direction to which waves are heading when the <br />
|-<br />
|''UBOT''<br />
|The rms-value <!--(root mean square value?)--> of the maxima of the orbital velocity near the bottom. If it is left undefined, TUFLOW FV will calculate it using linear wave theory.<br />
|-<br />
|''TMBOT''<br />
|The bottom wave period<br />
|-<br />
|''FORCE_X''<br />
|X wave induced force vector component (In TUFLOW FV documentation, it's usually called WFORCE_X except for in Table 15-3).<br />
|-<br />
|''FORCE_Y''<br />
|Y wave induced force vector component <!--(In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''DEPTH''<br />
|Wave model water depth<br />
|}<br />
<br />
======Select NetCDF Gridded BC Variable Names======<br />
[[File:TUFLOWFV MC BC Select NetCDF Gridded Variable Names.png|thumb|200px|The ''Select NetCDF Gridded BC Variable Names'' dialog which opens when '''Define Variables...''' is selected under the ''Assign Gridded Boundary Condition'' dialog. This dialog is for a "Waves" boundary condition type as selected on the ''Assign Gridded Boundary Condition'' dialog.]]<br />
*''Variable names'' &ndash; The variables that appear (other than TIME, which appears no matter which grid type is selected) will be exactly the same as the variables that appear in the ''Assign Gridded Boundary Condition'' dialog under ''Define default'', ''Define offset'', and ''Define scale''. It varies depending on the grid type selected.<br />
**''TIME variable name'' &ndash; <!--(??Advanced option to select a ??header in the selected file for the TIME variable. Does this vary depending on what file you have selected? Jeff, there's not much information, but it's on page 335 in Appendix F of TUFLOW FV manual--><br />
**Grid Specific variables<br />
***MSLP_GRID variables:<br />
****''MSLP variable name'' &ndash; Advanced option to select a header in the selected file for the MSLP variable.<br />
***W10_GRID variables:<br />
****''W10_X variable name'' &ndash; Advanced option to select a header in the selected file for the W10_X variable.<br />
****''W10_Y variable name'' &ndash; Advanced option to select a header in the selected file for the W10_Y variable.<br />
***Wave variables:<br />
****''HSIGN variable name'' &ndash; Advanced option to select a header in the selected file for the HSIGN variable.<br />
****''TPS variable name'' &ndash; Advanced option to select a header in the selected file for the TPS variable.<br />
****''DIR variable name'' &ndash; Advanced option to select a header in the selected file for the DIR variable.<br />
****''UBOT variable name'' &ndash; Advanced option to select a header in the selected file for the UBOT variable.<br />
****''TMBOT variable name'' &ndash; Advanced option to select a header in the selected file for the TMBOT variable.<br />
****''FORCE_X variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_X variable.<br />
****''FORCE_Y variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_Y variable.<br />
****''DEPTH variable name'' &ndash; Advanced option to select a header in the selected file for the DEPTH variable.<br />
<br />
====Simulation links====<br />
[[File:TUFLOWFV MC Simulationlinks.png|thumb|300 px|The ''Simulation Links'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Simulation links'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Brings up the ''Select Child TUFLOW FV Simulation'' dialog. In this dialog another TUFLOW FV simulation can be select to link as a child simulation to the current simulation.<br />
*[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Unlinks the selected simulation.<br />
{{-}}<br />
<br />
====Advanced====<br />
The ''Advanced'' tab of the ''TUFLOW FV Model Control'' dialog contains the option to include advanced options These options can be added in the text editor located in this tab. The text will be appended to the FVC file with the simulation is exported.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
<!--Obsolete<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the [[SMS:Generic Model Graphical Interface|generic model interface]].<br />
<br />
===TUFLOW FV Menu===<br />
If the TUFLOW FV model paremeters have been correctly loaded into SMS, the ''TUFLOW FV'' menu is available when the Mesh module is active. The menu has the following commands:<br />
*'''Check Mesh''' &ndash; Performs a general model check and will bring up the [[SMS:Model Checker|''Model Checker'']] dialog if errors are found.<br />
*'''Define Model''' &ndash; Opens the model definitions. This is only accessible to the TUFLOW FV model developers.<br />
*'''Global Parameters''' &ndash; Brings up the ''TUFLOW FV Global Parameters'' dialog where parameters for the model run are specified.<br />
*'''Assign BC''' &ndash; Brings up the ''TUFLOW FV Nodestring Boundary Conditions'' dialog. Available when a boundary nodestring is selected.<br />
*'''Material Properties''' &ndash; Brings up the ''TUFLOW FV Material Properties'' dialog.<br />
*'''Run TUFLOW FV''' &ndash; Launches the TUFLOW FV model run.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
--><br />
==External Links==<br />
*[http://www.tuflow.com/Download/TUFLOW_FV/Manual/FV-UserManual-2014.01.pdf TUFLOW FV Manual]<br />
*[http://fvwiki.tuflow.com/index.php?title=Main_Page TUFLOW FV Wiki]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|TUFLOW]]<br />
[[Category:TUFLOW|FV]]<br />
[[Category:Generic Interface]]<br />
[[Category:External Links]]<br />
[[Category:Needs Update]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:TUFLOW_FV&diff=157025SMS:TUFLOW FV2022-11-07T20:02:12Z<p>Rcorrigan: </p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= TUFLOW FV<br />
|model_type= Two-dimensional (2D) flexible mesh finite volume flood, tide and water quality simulation software. <br />
|developer= <br />
WBM [http://www.wbmpl.com.au/ BMT WBM (Australia)]<br />
|web_site= [http://www.tuflow.com/Tuflow%20FV.aspx www.tuflow.com]<br />
|tutorials= [http://www.aquaveo.com/software/sms-learning-tutorials SMS Learning Center]<br />
<br />
}}<br />
TUFLOW FV (which stands for Two-dimensional Unsteady FLOW Finite Volume) is a flexible mesh finite volume numerical model that simulates hydrodynamic, sediment transport and water quality processes in oceans, coastal waters, estuaries and rivers. The model may be used for coastal and nearshore environments including beaches and coastlines as well as offshore environments such as estuaries, river entrances and deltas, and floodplains. Uses include modeling river flood flow, [http://www.tuflow.com/Download/Publications/2013IAHR_A11315.pdf tsunami] inundation (the finite-volume scheme is well suited for a tsunami's mixed sub/super-critical flow regimes), beach erosion, ocean pollution, and estuary flow.<br />
<br />
Unlike the fixed square grids of TUFLOW Classic, the flexible triangular or quadrilateral mesh of TUFLOW FV allows users to modify mesh resolution spatially, seamlessly increasing the model resolution in areas of interest. This modelling approach reduces the number of computation cells needed in a model reducing run times. Additionally, TUFLOW FV can be run in parallel on multiple processors, threads, or computers.<br />
<br />
The TUFLOW FV model can be added to a [http://www.aquaveo.com/software/sms-pricing paid edition] of SMS.<br />
[[Category:Link to Store]]<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the dynamic model interface. It makes use of the SMS [[SMS:Simulations|simulation]] workflow.<br />
<br />
===TUFLOW FV Coverages===<br />
TUFLOW FV simulations require a boundary condition coverage and a materials coverage.<br />
<br />
====Boundary Conditions Coverage====<br />
[[File:TUFLOWFV AssignBC.png|thumb|300 px|The TUFLOW FV Assign Boundary Condition dialog]]<br />
The TUFLOW FV boundary conditions coverage allows assigning boundary condition attributes to arcs drawn in the coverage. These attributes will then be assigned, or snapped, to the 2D mesh during the simulation run.<br />
<br />
Attributes are assigned to arcs by right-clicking a selected arc and selecting the Assign BC command. This will open the ''Assign Boundary Condition'' dialog for TUFLOW FV.<br />
<br />
The TUFLOW FV ''Assign Boundary Condition'' dialog has the following options:<br />
<br />
''BC Options'' &ndash; The ''BC Options'' tab has options for assigning attributes to the arc.<br />
*''Type'' &ndash; The option here determines what type of boundary condition will be assigned to the arc. The following types are available:<br />
**"Monitor" &ndash; Sets the arc to be a monitoring line.<br />
**"HQ (Head Discharge)" &ndash; <br />
**"Q (Nodestring Flow)"<br />
**"QN (Head Discharge)"<br />
**"WL (Water Level)"<br />
**"WLS (Sloping Water Level"<br />
**"WL_CURT (Water Level Curtain"<br />
**"ZG (Zero Gradient)"<br />
*''Subtype''<br />
*''Define Curve''<br />
*''Friction slope''<br />
*''Dataset file''<br />
*''Define Varaibles''<br />
*''View Curve''<br />
*''Define default''<br />
**'Q default''<br />
*''Define offset''<br />
**''Q offset''<br />
*''Define scale''<br />
**''Q scale''<br />
*''Define update increment''<br />
**''Time''<br />
*''Include mean sea level pressure''<br />
<br />
====Materials====<br />
The TUFLOW FV materials coverage allows creating the polygons to hold the material attributes for the simulation run. The assigned material attributes will be mapped to the mesh/grid during the simulation run.<br />
<br />
===TUFLOW FV Simulation Menu===<br />
The TUFLOW FV simulation item in the Project Explorer contains a right-click menu with commands for accessing TUFLOW FV simulation options. The menu has the following commands:<br />
* '''Simulation Run Queue''' &ndash; Opens the ''Simulation Run Queue'' dialog.<br />
* '''Model Control''' &ndash; Opens the ''TUFLOWFV Model Control'' dialog.<br />
*'''Save Simulation''' &ndash; Saves the simulations and exports the simulations files needed for the simulation run.<br />
*'''Run Simulation''' &ndash; Runs the simulation using the exported simulation files. will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Save Project, Simulation and Run''' &ndash; Exports the simulation files, saves the project and project files, and runs the simulation. Will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Read Solution''' &ndash; Opens a browser to import the solution files.<br />
*'''Simulation Properties''' &ndash; Opens the ''Simulation Propertes'' dialog where basic information about the simulation can be viewed.<br />
The specific menu commands may be different depending on the selected option in the ''Preferences'' dialog.<br />
<br />
===TUFLOW FV Model Control===<br />
The ''TUFLOW FV Model Control'' dialog contains options for setting the parameters that will be used during the simulation run. The dialog is accessed by right-clicking on the simulation in the Project Explorer and selecting the '''Model Control''' command. The dialog contains multiple options organized on multiple tables. The options are as follows:<br />
====General====<br />
[[File:TUFLOWFV MC General.png|thumb|300 px|The ''General'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''General'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define spatial order'' &ndash; Option to define horizontal spatial scheme.<br />
**''Horizontal'' &ndash; Select "1st" order scheme or "2nd" order scheme.<br />
***"1st" &ndash; Sets the simulation to use a 1<sup>st</sup> order scheme. This can be used when there is not a significant difference between the results for 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's also generally used for the beginning stages of most model development.<br />
***"2nd" &ndash; Sets the simulation to use a 2<sup>nd</sup> order scheme. This is used when a significant difference is noticed between 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's usually tested in more advanced stages of model development. Fast-changing flow conditions or high gradients in conserved variables might warrant or necessitate use of this spatial scheme.<br />
*''Define display interval'' &ndash; Option to set the interval in seconds at which time step information will be displayed to the log and terminal window.<br />
**''Display interval'' &ndash; Sets the interval in seconds for the display of time step information.<br />
*''Define hardware solver'' &ndash; Option to enable computing through the CPU or the GPU. Can produce slight differences in results.<br />
**"CPU" &ndash; Calculations will use the "Central Processing Unit".<br />
**"GPU" &ndash; Calculations will use the "Graphical Processing Unit". Using GPU with TUFLOW<br />
***''Device ID'' &ndash; Option to select which GPU device is used for computers or GPUs with multiple CUDA enabled GPU cards. <br />
*''Warn on projection mismatch of GIS inputs'' &ndash; Sets the program to warn if GIS inputs are not all in the same projection.<br />
*''Tutorial model'' <!--&ndash; (Allows simulation of the TUFLOW Tutorial Models without the need for a TUFLOW license.??)--><br />
{{-}}<br />
<br />
====Time====<br />
[[File:TUFLOWFV MC Time.png|thumb|300 px|The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Simulation time''<br />
**''Use ISODate'' &ndash; Option to use ISODate format which requires data be input in the form dd/mm/yyyy HH:MM:SS. If left off, default time format is hours.<br />
**''Reference time'' &ndash; Will set simulation reference time. Times set for starting and ending have reference to this time. This can affect output times when processing and visualizing results from certain programs.<br />
**''Starting time'' &ndash; Will set simulation start time.<br />
**''Ending time'' &ndash; Will set simulation end time.<br />
*''Time step limits''<br />
**''CFL'' &ndash; Sets the Courant-Friedrichs-Lewy condition. Can be no larger than one since this is the theoretical stability limit. Often, inputting a value lower than one ensures greater model stability.<br />
**''Min time step(s)'' &ndash; Specifies minimum variable time step allowed according to CFL stability criterion.<br />
**''Max time step(s)'' &ndash; Specifies maximum variable time step allowed according to CFL stability criterion.<br />
{{-}}<br />
<br />
====Global parameters====<br />
[[File:TUFLOWFV MC Global.png|thumb|300 px|The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define bottom drag model'' &ndash; Option to specify bottom drag model for the simulation. The bottom drag model will be used to describe bed boundary resistance in the simulation. The same bottom drag model will be used for every calculation that uses it.<br />
**''Method'' &ndash; Option to set bottom drag model to use "Manning" or "KS".<br />
***"Manning" &ndash; Uses the Manning model and requires a Manning's ''n'' coefficient<br />
****''Manning's n coefficient'' &ndash; Sets the Manning's ''n'' coefficient.<br />
***"KS" &ndash; Uses a model that assumes a log-law velocity profile and requires specification of a surface roughness length-scale.<br />
****''Nikuradse roughness'' &ndash; Sets the Nikuradse roughness for the bottom drag model.<br />
*''Horizontal mixing model'' &ndash; Defines horizontal mixing eddy viscosity calculation according to options in drop-down menu. <!--((In TUFLOW FV documentation it's called momentum mixing model??))--><br />
**"None" &ndash; Will not represent horizontal momentum mixing. <br />
**"Constant" &ndash; Option to globally define a specific constant eddy viscosity.<br />
***''Global horizontal eddy viscosity'' &ndash; Specifies the constant eddy viscosity for the entire simulation.<br />
**"Smagorinsky" &ndash; The horizontal eddy viscosity will be calculated according to the Smagorinsky model which sets the diffusivity proportional to the local strain rate. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity coefficient'' &ndash; Sets the Smagorinsky coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets for the entire simulation the limits for the horizontal eddy viscosity values. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
**"Wu" &ndash; The horizontal eddy viscosity will be calculated according to the Wu model. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity'' &ndash; Sets the Wu coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets the limits for the horizontal eddy viscosity values for the entire simulation. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
*''Define stability limits'' &ndash; Option to define the maximum acceptable values relevant for the model. If water level or velocity exceed the given values, the model will stop computations and give an error. This feature helps to identify a model with instabilities by recognizing unrealistic values that the model produces. Small anomalies and acceptable spikes in data values will not stop computations.<br />
**''Maximum water level'' &ndash; Sets maximum acceptable water level for the model.<br />
**''Maximum velocity'' &ndash; Sets maximum acceptable velocity for the model.<br />
{{-}}<br />
<br />
====Wind stress====<br />
[[File:TUFLOWFV MC Wind.png|thumb|300 px|The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define wind model'' &ndash; Option to define the model used in calculating wind stress for any wind inputs in the simulation.<br />
**''Model'' &ndash; Drop-down menu with options for models that can be used to calculate wind stress.<br />
***"Wu" &ndash; Sets the wind stress model to the Wu model. Scales wind stress parameterisation based on wind speed.<br />
***"Constant" &ndash; Applies wind stress parameterisation using Bulk momentum transfer coefficient as in pre-2019 builds of TUFLOW.<br />
***"Kondo" &ndash; Applies a scaling factor <!--((for the wind stress parameters??))--> using a single term.<br />
*''Define wind parameters'' &ndash; <!--((Sets the wind drag coefficients that the selected model will use to scale the wind stress parameterisation??))--> Varies according to the wind model selected.<br />
**''Wa'' &ndash; <!--((??Wind speed in meters per second))--><br />
**''Ca'' &ndash; <br />
**''Wb'' &ndash;<br />
**''Cb'' &ndash;<br />
**''Bulk momentum transfer coefficient'' &ndash; Sets the coefficient for the Constant wind stress model.<br />
**''Scale factor'' &ndash; Sets the scaling factor for the Kondo wind stress model.<br />
{{-}}<br />
<br />
====Geometry====<br />
[[File:TUFLOWFV MC Geometry.png|thumb|300 px|The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define global bed elevation limits'' &ndash; Option to apply bed elevation limits to the entire model. Bed elevations in the model that are outside the set limits will be set to the minimum or the maximum. <br />
**''Bed elevation minimum'' &ndash; Defines minimum bed elevation. Bed Elevations in the model below this value will be set to this value.<br />
**''Bed elevation maximum'' &ndash; Defines maximum bed elevations. Bed Elevations in the model above this value will be set to this value.<br />
*''Define cell wet/dry depths'' &ndash; Sets the depth limits that define certain attributes of cells in the model.<br />
**''Dry depth'' &ndash; Sets a minimum depth value below which the simulation drops a cell from calculations.<br />
**''Wet depth'' &ndash; Sets a minimum depth value below which the simulation sets a cell's momentum to zero.<br />
*''Z modifications'' &ndash; Options for adjusting and applying elevation data<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a row of elevation data to the ''Z modifications'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of elevation data from the ''Z modifications'' table.<br />
**[[File:Row-up.svg|pi|16 px]]'''Move up''' &ndash; Moves the selected row of elevation data to be above the row immediately above it.<br />
**[[File:Row-down.svg|pi|16 px]] '''Move down''' &ndash; Moves the selected row of elevation data to be below the row immediately below it.<br />
**''Type'' &ndash; Option to select which type of elevation input is desired on this row of data. The other columns in the table become active or inactive based on the type selected here.<br />
**''Set Zpts'' &ndash; Sets elevation values for the center of all cells in the model domain to the given value.<br />
**''GRID Zpts'' &ndash; Interpolates a grid file to set elevations for the mesh cell center. Select '''(none selected)''' to open a dialog box and select the desired grid file. Either .asc or .flt. can be used for this feature.<br />
**''CSV File'' &ndash; Option to update cell elevations using a .csv file. The .csv file can identify cells using x,y coordinates or cell IDs.<br />
**''CSV Type'' &ndash; Select which type of data the .csv file will contain.<br />
***"Cell ID" &ndash; Sets the program to read the .csv file data for cell IDs matched with elevation data. <br />
***"Coordinate" &ndash; Sets the program to read the .csv file data for x,y coordinates matched with elevation data.<br />
**''ZLine Shapes'' &ndash; Sets breakline features and polygon features according to an already imported .shp or .mif/.mid file. Select '''(none selected)''' to open a dialog and select the desired file.<br />
**''ZPoint Shapes'' &ndash; Sets elevation points according to an already imported .shp or .mif/.mid file. Using this feature, multiple layers of elevation information can be used. This allows for dividing the layers for better data management. Select '''(none selected)''' to open the ''Select Z Point Layers'' dialog.<br />
=====Select Z Point Layers=====<br />
[[File:TUFLOWFV MC Geometry Select Zpt Layers.png|thumb|200 px|The ''Select Z Point Layers'' dialog which opens when '''Select Z Point Layers...''' is clicked in the ''Geometry'' tab.]]<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Opens a dialog for selecting a file to define the Z point layer. Adds that layer to a new table row.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of data.<br />
{{-}}<br />
<br />
====Initial conditions====<br />
[[File:TUFLOWFV MC Initial.png|thumb|300 px|The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define initial water level'' &ndash; Option set water level to a constant value for the entire simulation. It's best for the water level boundary conditions for the initial time steps to be as close as possible to this setting.<br />
*''Use restart file'' &ndash; Option to use a restart file to define the initial conditions for the current run. The restart file must come from a model that uses the same mesh, bathymetry, vertical layering, and number of conserved variables as the model for the current simulation.<br />
**'''Select...''' &ndash; Opens dialog box for selecting restart file to be used.<br />
**''Use restart file time'' &ndash; Option to use the time stamp on the restart file as the starting time of the current run. On by default.<br />
{{-}}<br />
<br />
====Output====<br />
[[File:TUFLOWFV MC Output.png|thumb|300px|The ''Output'' tab of the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Output'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Output blocks'' &ndash; Output blocks set output file types as well as certain output file properties. They also allow for selecting desired datasets to be included in the output file and the time steps at which to output the information.<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a output block to the ''Output blocks'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the selected output block from the ''Output blocks'' table.<br />
**"DATV" &ndash; SMS will give mapped output in DATV format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"XMDF" &ndash; SMS will give mapped output in XMDF format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"NetCDF" &ndash; SMS will give mapped output in NetCDF (network Common Data Form) format with user specified datasets and parameters. Includes mapped output information at the desired time intervals as well as information about model geometry.<br />
**"Flux" &ndash; Outputs a CSV file that will give the values of fluid flow and, if applicable, the movement of other quantities that cross model boundaries or other specified nodestrings.<br />
**"Mass" &ndash; Outputs a CSV file that can be used to check certain simulated quantities, mainly the volume of fluid within the model domain. <br />
**"Points" &ndash; Outputs a CSV file containing model parameter time-series. This includes coordinates and associated data for the points of interest. <!--((as defined in a coverage dedicated to this task.??))--><br />
**"Transport" &ndash; Outputs a NetCDF file that can be used to improve the runtime of subsequent advection-diffusion, sediment, or particle tracking simulations. It stores conserved variables on the TUFLOW FV mesh for use in future simulations.<br />
<br />
*''Output block options - Row (value of active row)'' &ndash; Gives options to define attributes and datasets for a selected output block. Many options are only available when certain output blocks are selected. (See table below)<br />
**''Output points feature coverage'' &ndash; Only available when a "Points" output block is active. Click '''Select...''' to set the coverage that will define the coordinates of the desired output points<br />
**''Define Interval'' &ndash; Option to set the interval for the specified output in seconds. If not specified, the program will produce the specified output at every time step, sometimes resulting in output files that are too large.<br />
**''Define start time'' &ndash; Sets output request start time. When not specified, the output start time will be the simulation start time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define final time'' &ndash; Sets output request final time. When not specified, the output final time will be the simulation end time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define compression'' &ndash; Option to compress output file.<br />
***''Compression on'' &ndash; If turned on, output file will be compressed. On by default.<br />
**''Define Statistics'' &ndash; Option to track minimum and/or maximum values of selected datasets.<br />
***''Type'' &ndash; Select the values to track from the drop-down menu.<br />
****"Both" &ndash; Both maximum and minimum values for selected datasets will be tracked.<br />
****"Minimums" &ndash; Only minimum values for selected datasets will be tracked. <br />
****"Maximums" &ndash; Only maximum values for selected datasets will be tracked.<br />
***''Define statistics dt'' &ndash; Option to define independent output interval for tracking of minimum and maximum values. If not defined, defaults to 0 and uses the model interval.<br />
**''Filename suffix'' &ndash; Option to specify a desired suffix for output file.<br />
**''Datasets'' &ndash; Specify datasets for inclusion in output file. This will only appear when a DATV, XMDF, NetCDF, or points output block is active. For more information, see the table below.<br />
*''Directories'' <br />
**''Log directory'' &ndash; Option to specify directory for simulation log file (.log) output. When not specified, log file will be written to same location as simulation control file.<br />
**''Output directory'' &ndash; Option to specify location in which simulation output files will be written. When not specified, output files will be written to same location as simulation control file.<br />
**''Write restart file'' &ndash; TUFLOW FV writes the values of the selected datasets in each cell at desired regular time steps. Specify these time steps in ''Write restart dt''.<br />
***''Write restart dt'' &ndash; Specify the desired interval of time steps at which TUFLOW FV will write the restart file.<br />
***''Enable restart overwrite'' &ndash; Option to overwrite the restart file being used at the time interval specified in ''Write restart dt''. On by default.<br />
**''Write check files'' &ndash; Option to create a number of check files that can be used to verify model inputs.<br />
***''Check files directory'' &ndash;<br />
**''Write empty GIS files'' &ndash; Option to automatically create GIS template files in .mid/.mif or .shp format with recommended GIS naming conventions that "contain the correct GIS attributes".<br />
***''Template files directory'' &ndash; Sets the location in which the empty GIS files will be written.<br />
<br />
<br />
<br />
{| class="wikitable"<br />
!Category<br />
! scope="col" style="width: 250px;" | Output Block Options<br />
!Output blocks that use this option<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="8"|General<br />
|-<br />
|''Output points feature coverage''<br />
|Points<br />
|-<br />
|''Define interval''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport <br />
|-<br />
|''Define start time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define final time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define compression''<br />
|XMDF, NetCDF<br />
|-<br />
|''Define statistics''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Filename suffix''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="20"|Datasets<br />
|''Water depth''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Water surface elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Surface shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity vector and magnitude''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity magnitude only''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Turbulent viscosity''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Evaporation rate''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category based on the Australian NSW Flood plain management Manual (NSWG, 2005)''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category as outlined by Australian Emergency Management Institute in 2014'' <br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Hazard categories for the Queensland Reconstruction Authority''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Mean sea level pressure''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Downward short-wave radiation flux''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Temperatre''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''10 m wind speed vector''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave height'' &ndash; typically significant wave height<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave period'' &ndash; typically peak wave period<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave direction''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave stress vector''<br />
|DATV, XMDF, NetCDF, Points<br />
<br />
|}<br />
<br />
<br />
====Materials====<br />
[[File:TUFLOWFV MC Material.png|thumb|300 px|The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define default material (set mat)'' &ndash; Sets the material settings for every cell in the model domain. This material and its attributes will be the assumed material for each cell <!--((unless a material block defines them otherwise??))--><br />
**''Override Bottom Roughness'' &ndash; Select to allow for editing bottom roughness of this material.<br />
**''Bottom Roughness'' &ndash; Sets the default bottom roughness for the entire model. Will be factored in according to the bottom drag model selected on the ''Global parameters'' tab. <br />
**''Advanced Options'' &ndash; Select '''Advanced...''' to open the ''Materials (advanced) - Default material (set mat)'' dialog.<br />
=====Materials (advanced) - Default material (set mat)=====<br />
*''Define horizontal eddy viscosity'' &ndash; Option to adjust the horizontal eddy viscosity settings for this material. The input asked for here varies depending on the horizontal mixing model selected on the ''Global Parameters'' tab.<br />
**''Horizontal eddy viscosity'' &ndash; Sets the horizontal eddy viscosity for this material. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to "None" or "Constant".<br />
**''Horizontal eddy viscosity coefficient'' &ndash; Sets the coefficient for either the "Wu" or "Smagorinsky" mixing models, depending on the model selected on the ''Global Parameters'' tab. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to ''Smagorinsky'' or ''Wu''.<br />
*''Define bed elevations limits'' &ndash; Option to set limits for the bed elevation of cells defined by this material.<br />
**''Minimum bed elevation'' &ndash; Sets minimum bed elevation.<br />
**''Maximum bed elevation'' &ndash; Sets maximum bed elevation.<br />
*''Spatial reconstruction'' &ndash; Option to limit spatial reconstruction <!--(??for cells that are defined by the default material)-->. This reverts the calculations for this area to first-order calculations in a model that is second-order. This has no effect if the model is already first order as defined in the ''General'' tab under ''Define spatial order''.<br />
[[File:TUFLOWFV MC Materials Advanced DM Set Mat.png|left|380px|The ''Materials (advanced) - Default material (set mat)'' dialog which opens when '''Advanced...''' is selected on the ''Materials'' tab.]]<br />
{{-}}<br />
<br />
====Boundary Conditions====<br />
[[File:TUFLOWFV MC Boundary Conditions.png|thumb|450px|The ''Boundary Conditions'' tab on the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Boundary conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define BC default update dt'' &ndash; Option to set the time step for all boundary conditions to update. If unspecified, TUFLOW FV will interpolate values to each time step. If specified, TUFLOW FV will keep all values after one update but before the next update at a constant value.<br />
**''BC default update dt'' &ndash; <!--((sets the time value of the time steps that TUFLOW FV will interpolate to??))--><br />
*''Run in transport mode'' &ndash; Option to run a simulation that includes a transport boundary condition. This option can be useful for later models that use many of the same conditions but require different inputs.<br />
**''Transport BC file'' &ndash; Click '''Select...''' to set which transport file will be used in this simulation.<br />
*''Global boundaries'' &ndash; ((Boundary condition blocks that can be used to apply conditions to every cell in the model domain. For example, it can be used to account for inflow from rain or evaporation.<br />
**[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a boundary condition block that specifies conditions over the entire model domain.<br />
**[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the active global boundary condition block.<br />
**''Type'' &ndash; Shows the type of boundary condition assigned to this boundary condition block.<br />
**''Attributes''<br />
***'''Assign BC''' &ndash; Opens the ''Assign Global Boundary Condition'' dialog.<br />
*''Gridded boundaries'' &ndash; <br />
** [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a Gridded BC row to the ''Gridded boundaries'' table. Opens the ''Define BC Grid'' dialog.<br />
** [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes a Gridded BC row from the ''Gridded boundaries'' table.<br />
**''Grid Definition''<br />
***'''Define Grid...''' &ndash; Opens ''Define BC Grid'' dialog for selecting the grid and associated settings for selected grid definition block.<br />
**''Boundaries''<br />
***'''Define BCs...''' &ndash; Opens ''Add Gridded BCs'' dialog.<br />
*''Global wave options'' &ndash: Options for use if a linked Boundary Conditions coverage with a wave boundary type and/or a gridded wave boundary defined.<br />
**''Include wave stress'' &ndash;<br />
**''Include Stokes drift'' &ndash; Option to include Stokes drift in calculations. <!--((Interpolates mass transport for cells between the deepwater and surfzone depth??))--><br />
<br />
======Assign Global Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Global BC.png|thumb|450px|The ''Assign Global Boundary Condition'' dialog which opens when '''Assign BC''' is selected on the ''Boundary conditions'' tab.]]<br />
*''Options'' &ndash; <br />
**''Type'' &ndash; Sets which type of boundary condition to set globally for the model. The one option is "QG (Global Cell Inflow)".<br />
***"QG (Global Cell Inflow)" &ndash; Sets boundary condition as flow into every cell in model domain. Useful to account for effects of rain or evaporation.<br />
**''Subtype'' &ndash; Option to adjust how a boundary type functions numerically in the model.<br />
***"Sub-type 1" &ndash; The interior model concentration will be used to determine the scalar flux.<br />
***"Sub-type 2" &ndash; The value specified in the BC file will determine the scalar flux.<br />
**'''Define Curve...''' &ndash; Opens "BC Curve Editor" dialog.<br />
<br />
**''Define default'' &ndash; Defines default value for a given variable when TUFLOW FV gets a null-value from a boundary condition input.<br />
***''Q/A default'' &ndash;<br />
**''Define offset'' &ndash; Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale<br />
***''Q/A offset'' &ndash;<br />
**''Define scale'' &ndash; Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
***''Q/A scale'' &ndash;<br />
**''Define update increment'' &ndash; Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
***''Time'' &ndash; The value of the update intervals of time steps.<br />
**''Includes mean sea level pressure'' &ndash; Option to specify if an inverse barometer offset is already included in a water level boundary condition. By default, it is on to indicate there is an inverse barometer offset included. If turned off, the difference between the local MSLP and the reference MSLP will be applied at the boundary.<br />
<br />
======BC Curve Editor======<br />
<!--This is the only dialog that RC didn't upload an image for--><br />
*''Define reference time'' &ndash; <br />
**''Use ISODate'' &ndash;<br />
**''Reference time'' &ndash;<br />
*''Number of rows''<br />
*''Time Units''<br />
*'''Import...'''<br />
*''Time''<br />
*''Q/A''<br />
*[[File:Pan Tool.svg|16px]]'''Pan''' &ndash;<br />
<br />
=====Define BC Grid=====<br />
[[File:TUFLOWFV MC BC Define BC Grid.png|thumb|350px|The ''Define BC Grid'' dialog, which opens when '''Define Grid''' is selected in ''Boundary conditions'' tab.]]<br />
*''Grid Definition'' &ndash; Space for defining the location, filename, and settings for a NetCDF file that will be used to map input files to the model mesh.<br />
**''File'' &ndash; Click '''Select...''' to set the NetCDF file that contains the coordinates that define a grid. The gridded boundary conditions will be applied to this grid.<br />
**''Name'' &ndash; Name applied to the grid. Name might be used later to refer to this grid by other boundary conditions in this model.<br />
**''NetCDF variables'' &ndash; Sets the variables from the NetCDF file that the program should use to create the grid map.<br />
***''X-Variable'' &ndash; <br />
***''Y-Variable'' &ndash;<br />
***''Z-Variable'' &ndash;<br />
**''Define vertical coordinate type'' &ndash; Option to specify the vertical coordinate convention. The different convention names correspond to distinct kinds of depth averaging. <br />
***"Elevation" &ndash; [https://fvwiki.tuflow.com/index.php?title=Depth_Averaging_Results]. Here is the information. Not sure how to interpret it yet.<br />
***"Depth" &ndash;<br />
***"Sigma" &ndash;<br />
***"Height" &ndash;<br />
**''Cell gridmap'' &ndash; When turned off, (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Boundary gridmap'' &ndash; If on, calculates (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Suppress coverage warnings'' &ndash; Will suppress warnings that indicate the grid does not cover the entire domain.<br />
<br />
=====Add Gridded BCs=====<br />
[[File:TUFLOWFV MC BC Add Gridded BC.png|thumb|300px|The ''Add Gridded BCs'' dialog which opens when '''Define BCs...''' is selected on the ''Boundary Conditions'' tab.]]<br />
This dialog allows for assigning multiple boundary conditions to the one grid in the selected row.<br />
* [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a gridded boundary condition block to the grid associated with the active grid block.<br />
* [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the selected gridded boundary condition block.<br />
*''Type'' &ndash; Shows the type of boundary condition grid assigned to this boundary condition block.<br />
*''Attributes'' &ndash; <br />
**'''Assign BC...''' &ndash; Opens ''Assign Gridded Boundary Condition'' dialog.<br />
<br />
<br />
======Assign Gridded Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Gridded BC.png|thumb|300px|''Assign Gridded Boundary Condition'' dialog which opens when '''Assign BC...''' is selected in the ''Add Gridded BCs'' dialog.]]<br />
*''Options'' &ndash; TUFLOW Manual 15.4.4 BC Scale and BC Offset<br />
**''Type'' &ndash; Sets type of boundary condition to be used.<br />
***"MSLP_Grid" &ndash; Sets boundary condition type to mean sea level pressure field.<br />
***"W10_Grid" &ndash; Sets boundary condition type to wind velocity at 10m.<br />
***"Wave" &ndash; <br />
**''Dataset file'' &ndash; Opens dialog to select NetCDF file to define the data for the boundary condition.<br />
**'''Define Variables''' &ndash; Opens ''Select NetCDF Gridded BC Variable Names'' dialog.<br />
**For ''Define default'', ''Define offset'', ''Define scale'', ''Define reference time'', ''Define time units'', and ''Define update increment'', see table below.<br />
<br />
{| class="wikitable"<br />
!Grid Type<br />
!Option or Variable<br />
! scope="col" style="width: 550px;" | Definition<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="6" | All Grids<br />
|''Define default''<br />
|Defines default value for a given variable when a boundary condition input gives TUFLOW FV a null-value. <br />
|-<br />
|''Define offset''<br />
|Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale.<br />
|-<br />
|''Define scale''<br />
|Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
|-<br />
|''Define reference time''<br />
|Sets reference time for the boundary condition. When not set, the reference time will be the same as the simulation time. Option set reference time in hours, which is the default. Turn on ''Use ISODate'' to use that format if desired.<br />
|-<br />
|''Define time units''<br />
|Sets time units to be used for the boundary condition. The options are: <br />
*"Days"<br />
*"Hours"<br />
*"Minutes"<br />
*"Seconds"<br />
*"Isotime"<br />
|-<br />
|''Define update increment''<br />
|Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
|-<br />
!rowspan="1" | MSLP_Grid<br />
|''MSLP''<br />
|Mean sea level pressure<br />
|-<br />
!rowspan="2" | W10_Grid<br />
|''W10_X''<br />
|"10 m wind speed vector"<br />
|-<br />
|''W10_Y''<br />
|"10 m wind speed vector"<br />
|-<br />
!rowspan="8" | Wave<br />
|''HSIGN''<br />
|Significant wave height <!--(??In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''TPS''<br />
|Smoothed peak wave period<br />
|-<br />
|''DIR''<br />
|Mean wave direction. This is direction to which waves are heading when the <br />
|-<br />
|''UBOT''<br />
|The rms-value <!--(root mean square value?)--> of the maxima of the orbital velocity near the bottom. If it is left undefined, TUFLOW FV will calculate it using linear wave theory.<br />
|-<br />
|''TMBOT''<br />
|The bottom wave period<br />
|-<br />
|''FORCE_X''<br />
|X wave induced force vector component (In TUFLOW FV documentation, it's usually called WFORCE_X except for in Table 15-3).<br />
|-<br />
|''FORCE_Y''<br />
|Y wave induced force vector component <!--(In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''DEPTH''<br />
|Wave model water depth<br />
|}<br />
<br />
======Select NetCDF Gridded BC Variable Names======<br />
[[File:TUFLOWFV MC BC Select NetCDF Gridded Variable Names.png|thumb|200px|The ''Select NetCDF Gridded BC Variable Names'' dialog which opens when '''Define Variables...''' is selected under the ''Assign Gridded Boundary Condition'' dialog. This dialog is for a "Waves" boundary condition type as selected on the ''Assign Gridded Boundary Condition'' dialog.]]<br />
*''Variable names'' &ndash; The variables that appear (other than TIME, which appears no matter which grid type is selected) will be exactly the same as the variables that appear in the ''Assign Gridded Boundary Condition'' dialog under ''Define default'', ''Define offset'', and ''Define scale''. It varies depending on the grid type selected.<br />
**''TIME variable name'' &ndash; <!--(??Advanced option to select a ??header in the selected file for the TIME variable. Does this vary depending on what file you have selected? Jeff, there's not much information, but it's on page 335 in Appendix F of TUFLOW FV manual--><br />
**Grid Specific variables<br />
***MSLP_GRID variables:<br />
****''MSLP variable name'' &ndash; Advanced option to select a header in the selected file for the MSLP variable.<br />
***W10_GRID variables:<br />
****''W10_X variable name'' &ndash; Advanced option to select a header in the selected file for the W10_X variable.<br />
****''W10_Y variable name'' &ndash; Advanced option to select a header in the selected file for the W10_Y variable.<br />
***Wave variables:<br />
****''HSIGN variable name'' &ndash; Advanced option to select a header in the selected file for the HSIGN variable.<br />
****''TPS variable name'' &ndash; Advanced option to select a header in the selected file for the TPS variable.<br />
****''DIR variable name'' &ndash; Advanced option to select a header in the selected file for the DIR variable.<br />
****''UBOT variable name'' &ndash; Advanced option to select a header in the selected file for the UBOT variable.<br />
****''TMBOT variable name'' &ndash; Advanced option to select a header in the selected file for the TMBOT variable.<br />
****''FORCE_X variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_X variable.<br />
****''FORCE_Y variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_Y variable.<br />
****''DEPTH variable name'' &ndash; Advanced option to select a header in the selected file for the DEPTH variable.<br />
<br />
====Simulation links====<br />
[[File:TUFLOWFV MC Simulationlinks.png|thumb|300 px|The ''Simulation Links'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Simulation links'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Brings up the ''Select Child TUFLOW FV Simulation'' dialog. In this dialog another TUFLOW FV simulation can be select to link as a child simulation to the current simulation.<br />
*[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Unlinks the selected simulation.<br />
{{-}}<br />
<br />
====Advanced====<br />
The ''Advanced'' tab of the ''TUFLOW FV Model Control'' dialog contains the option to include advanced options These options can be added in the text editor located in this tab. The text will be appended to the FVC file with the simulation is exported.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
<!--Obsolete<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the [[SMS:Generic Model Graphical Interface|generic model interface]].<br />
<br />
===TUFLOW FV Menu===<br />
If the TUFLOW FV model paremeters have been correctly loaded into SMS, the ''TUFLOW FV'' menu is available when the Mesh module is active. The menu has the following commands:<br />
*'''Check Mesh''' &ndash; Performs a general model check and will bring up the [[SMS:Model Checker|''Model Checker'']] dialog if errors are found.<br />
*'''Define Model''' &ndash; Opens the model definitions. This is only accessible to the TUFLOW FV model developers.<br />
*'''Global Parameters''' &ndash; Brings up the ''TUFLOW FV Global Parameters'' dialog where parameters for the model run are specified.<br />
*'''Assign BC''' &ndash; Brings up the ''TUFLOW FV Nodestring Boundary Conditions'' dialog. Available when a boundary nodestring is selected.<br />
*'''Material Properties''' &ndash; Brings up the ''TUFLOW FV Material Properties'' dialog.<br />
*'''Run TUFLOW FV''' &ndash; Launches the TUFLOW FV model run.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
--><br />
==External Links==<br />
*[http://www.tuflow.com/Download/TUFLOW_FV/Manual/FV-UserManual-2014.01.pdf TUFLOW FV Manual]<br />
*[http://fvwiki.tuflow.com/index.php?title=Main_Page TUFLOW FV Wiki]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|TUFLOW]]<br />
[[Category:TUFLOW|FV]]<br />
[[Category:Generic Interface]]<br />
[[Category:External Links]]<br />
[[Category:Needs Update]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:TUFLOW_FV&diff=157024SMS:TUFLOW FV2022-11-07T20:00:40Z<p>Rcorrigan: </p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= TUFLOW FV<br />
|model_type= Two-dimensional (2D) flexible mesh finite volume flood, tide and water quality simulation software. <br />
|developer= <br />
WBM [http://www.wbmpl.com.au/ BMT WBM (Australia)]<br />
|web_site= [http://www.tuflow.com/Tuflow%20FV.aspx www.tuflow.com]<br />
|tutorials= [http://www.aquaveo.com/software/sms-learning-tutorials SMS Learning Center]<br />
<br />
}}<br />
TUFLOW FV (which stands for Two-dimensional Unsteady FLOW Finite Volume) is a flexible mesh finite volume numerical model that simulates hydrodynamic, sediment transport and water quality processes in oceans, coastal waters, estuaries and rivers. The model may be used for coastal and nearshore environments including beaches and coastlines as well as offshore environments such as estuaries, river entrances and deltas, and floodplains. Uses include modeling river flood flow, [http://www.tuflow.com/Download/Publications/2013IAHR_A11315.pdf tsunami] inundation (the finite-volume scheme is well suited for a tsunami's mixed sub/super-critical flow regimes), beach erosion, ocean pollution, and estuary flow.<br />
<br />
Unlike the fixed square grids of TUFLOW Classic, the flexible triangular or quadrilateral mesh of TUFLOW FV allows users to modify mesh resolution spatially, seamlessly increasing the model resolution in areas of interest. This modelling approach reduces the number of computation cells needed in a model reducing run times. Additionally, TUFLOW FV can be run in parallel on multiple processors, threads, or computers.<br />
<br />
The TUFLOW FV model can be added to a [http://www.aquaveo.com/software/sms-pricing paid edition] of SMS.<br />
[[Category:Link to Store]]<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the dynamic model interface. It makes use of the SMS [[SMS:Simulations|simulation]] workflow.<br />
<br />
===TUFLOW FV Coverages===<br />
TUFLOW FV simulations require a boundary condition coverage and a materials coverage.<br />
<br />
====Boundary Conditions Coverage====<br />
[[File:TUFLOWFV AssignBC.png|thumb|300 px|The TUFLOW FV Assign Boundary Condition dialog]]<br />
The TUFLOW FV boundary conditions coverage allows assigning boundary condition attributes to arcs drawn in the coverage. These attributes will then be assigned, or snapped, to the 2D mesh during the simulation run.<br />
<br />
Attributes are assigned to arcs by right-clicking a selected arc and selecting the Assign BC command. This will open the ''Assign Boundary Condition'' dialog for TUFLOW FV.<br />
<br />
The TUFLOW FV ''Assign Boundary Condition'' dialog has the following options:<br />
<br />
''BC Options'' &ndash; The ''BC Options'' tab has options for assigning attributes to the arc.<br />
*''Type'' &ndash; The option here determines what type of boundary condition will be assigned to the arc. The following types are available:<br />
**"Monitor" &ndash; Sets the arc to be a monitoring line.<br />
**"HQ (Head Discharge)" &ndash; <br />
**"Q (Nodestring Flow)"<br />
**"QN (Head Discharge)"<br />
**"WL (Water Level)"<br />
**"WLS (Sloping Water Level"<br />
**"WL_CURT (Water Level Curtain"<br />
**"ZG (Zero Gradient)"<br />
*''Subtype''<br />
*''Define Curve''<br />
*''Friction slope''<br />
*''Dataset file''<br />
*''Define Varaibles''<br />
*''View Curve''<br />
*''Define default''<br />
**'Q default''<br />
*''Define offset''<br />
**''Q offset''<br />
*''Define scale''<br />
**''Q scale''<br />
*''Define update increment''<br />
**''Time''<br />
*''Include mean sea level pressure''<br />
<br />
====Materials====<br />
The TUFLOW FV materials coverage allows creating the polygons to hold the material attributes for the simulation run. The assigned material attributes will be mapped to the mesh/grid during the simulation run.<br />
<br />
===TUFLOW FV Simulation Menu===<br />
The TUFLOW FV simulation item in the Project Explorer contains a right-click menu with commands for accessing TUFLOW FV simulation options. The menu has the following commands:<br />
* '''Simulation Run Queue''' &ndash; Opens the ''Simulation Run Queue'' dialog.<br />
* '''Model Control''' &ndash; Opens the ''TUFLOWFV Model Control'' dialog.<br />
*'''Save Simulation''' &ndash; Saves the simulations and exports the simulations files needed for the simulation run.<br />
*'''Run Simulation''' &ndash; Runs the simulation using the exported simulation files. will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Save Project, Simulation and Run''' &ndash; Exports the simulation files, saves the project and project files, and runs the simulation. Will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Read Solution''' &ndash; Opens a browser to import the solution files.<br />
*'''Simulation Properties''' &ndash; Opens the ''Simulation Propertes'' dialog where basic information about the simulation can be viewed.<br />
The specific menu commands may be different depending on the selected option in the ''Preferences'' dialog.<br />
<br />
===TUFLOW FV Model Control===<br />
The ''TUFLOW FV Model Control'' dialog contains options for setting the parameters that will be used during the simulation run. The dialog is accessed by right-clicking on the simulation in the Project Explorer and selecting the '''Model Control''' command. The dialog contains multiple options organized on multiple tables. The options are as follows:<br />
====General====<br />
[[File:TUFLOWFV MC General.png|thumb|300 px|The ''General'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''General'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define spatial order'' &ndash; Option to define horizontal spatial scheme.<br />
**''Horizontal'' &ndash; Select "1st" order scheme or "2nd" order scheme.<br />
***"1st" &ndash; Sets the simulation to use a 1<sup>st</sup> order scheme. This can be used when there is not a significant difference between the results for 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's also generally used for the beginning stages of most model development.<br />
***"2nd" &ndash; Sets the simulation to use a 2<sup>nd</sup> order scheme. This is used when a significant difference is noticed between 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's usually tested in more advanced stages of model development. Fast-changing flow conditions or high gradients in conserved variables might warrant or necessitate use of this spatial scheme.<br />
*''Define display interval'' &ndash; Option to set the interval in seconds at which time step information will be displayed to the log and terminal window.<br />
**''Display interval'' &ndash; Sets the interval in seconds for the display of time step information.<br />
*''Define hardware solver'' &ndash; Option to enable computing through the CPU or the GPU. Can produce slight differences in results.<br />
**"CPU" &ndash; Calculations will use the "Central Processing Unit".<br />
**"GPU" &ndash; Calculations will use the "Graphical Processing Unit". Using GPU with TUFLOW<br />
***''Device ID'' &ndash; Option to select which GPU device is used for computers or GPUs with multiple CUDA enabled GPU cards. <br />
*''Warn on projection mismatch of GIS inputs'' &ndash; Sets the program to warn if GIS inputs are not all in the same projection.<br />
*''Tutorial model'' <!--&ndash; (Allows simulation of the TUFLOW Tutorial Models without the need for a TUFLOW license.??)--><br />
{{-}}<br />
<br />
====Time====<br />
[[File:TUFLOWFV MC Time.png|thumb|300 px|The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Simulation time''<br />
**''Use ISODate'' &ndash; Option to use ISODate format which requires data be input in the form dd/mm/yyyy HH:MM:SS. If left off, default time format is hours.<br />
**''Reference time'' &ndash; Will set simulation reference time. Times set for starting and ending have reference to this time. This can affect output times when processing and visualizing results from certain programs.<br />
**''Starting time'' &ndash; Will set simulation start time.<br />
**''Ending time'' &ndash; Will set simulation end time.<br />
*''Time step limits''<br />
**''CFL'' &ndash; Sets the Courant-Friedrichs-Lewy condition. Can be no larger than one since this is the theoretical stability limit. Often, inputting a value lower than one ensures greater model stability.<br />
**''Min time step(s)'' &ndash; Specifies minimum variable time step allowed according to CFL stability criterion.<br />
**''Max time step(s)'' &ndash; Specifies maximum variable time step allowed according to CFL stability criterion.<br />
{{-}}<br />
<br />
====Global parameters====<br />
[[File:TUFLOWFV MC Global.png|thumb|300 px|The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define bottom drag model'' &ndash; Option to specify bottom drag model for the simulation. The bottom drag model will be used to describe bed boundary resistance in the simulation. The same bottom drag model will be used for every calculation that uses it.<br />
**''Method'' &ndash; Option to set bottom drag model to use "Manning" or "KS".<br />
***"Manning" &ndash; Uses the Manning model and requires a Manning's ''n'' coefficient<br />
****''Manning's n coefficient'' &ndash; Sets the Manning's ''n'' coefficient.<br />
***"KS" &ndash; Uses a model that assumes a log-law velocity profile and requires specification of a surface roughness length-scale.<br />
****''Nikuradse roughness'' &ndash; Sets the Nikuradse roughness for the bottom drag model.<br />
*''Horizontal mixing model'' &ndash; Defines horizontal mixing eddy viscosity calculation according to options in drop-down menu. <!--((In TUFLOW FV documentation it's called momentum mixing model??))--><br />
**"None" &ndash; Will not represent horizontal momentum mixing. <br />
**"Constant" &ndash; Option to globally define a specific constant eddy viscosity.<br />
***''Global horizontal eddy viscosity'' &ndash; Specifies the constant eddy viscosity for the entire simulation.<br />
**"Smagorinsky" &ndash; The horizontal eddy viscosity will be calculated according to the Smagorinsky model which sets the diffusivity proportional to the local strain rate. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity coefficient'' &ndash; Sets the Smagorinsky coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets for the entire simulation the limits for the horizontal eddy viscosity values. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
**"Wu" &ndash; The horizontal eddy viscosity will be calculated according to the Wu model. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity'' &ndash; Sets the Wu coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets the limits for the horizontal eddy viscosity values for the entire simulation. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
*''Define stability limits'' &ndash; Option to define the maximum acceptable values relevant for the model. If water level or velocity exceed the given values, the model will stop computations and give an error. This feature helps to identify a model with instabilities by recognizing unrealistic values that the model produces. Small anomalies and acceptable spikes in data values will not stop computations.<br />
**''Maximum water level'' &ndash; Sets maximum acceptable water level for the model.<br />
**''Maximum velocity'' &ndash; Sets maximum acceptable velocity for the model.<br />
{{-}}<br />
<br />
====Wind stress====<br />
[[File:TUFLOWFV MC Wind.png|thumb|300 px|The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define wind model'' &ndash; Option to define the model used in calculating wind stress for any wind inputs in the simulation.<br />
**''Model'' &ndash; Drop-down menu with options for models that can be used to calculate wind stress.<br />
***"Wu" &ndash; Sets the wind stress model to the Wu model. Scales wind stress parameterisation based on wind speed.<br />
***"Constant" &ndash; Applies wind stress parameterisation using Bulk momentum transfer coefficient as in pre-2019 builds of TUFLOW.<br />
***"Kondo" &ndash; Applies a scaling factor <!--((for the wind stress parameters??))--> using a single term.<br />
*''Define wind parameters'' &ndash; <!--((Sets the wind drag coefficients that the selected model will use to scale the wind stress parameterisation??))--> Varies according to the wind model selected.<br />
**''Wa'' &ndash; <!--((??Wind speed in meters per second))--><br />
**''Ca'' &ndash; <br />
**''Wb'' &ndash;<br />
**''Cb'' &ndash;<br />
**''Bulk momentum transfer coefficient'' &ndash; Sets the coefficient for the Constant wind stress model.<br />
**''Scale factor'' &ndash; Sets the scaling factor for the Kondo wind stress model.<br />
{{-}}<br />
<br />
====Geometry====<br />
[[File:TUFLOWFV MC Geometry.png|thumb|300 px|The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define global bed elevation limits'' &ndash; Option to apply bed elevation limits to the entire model. Bed elevations in the model that are outside the set limits will be set to the minimum or the maximum. <br />
**''Bed elevation minimum'' &ndash; Defines minimum bed elevation. Bed Elevations in the model below this value will be set to this value.<br />
**''Bed elevation maximum'' &ndash; Defines maximum bed elevations. Bed Elevations in the model above this value will be set to this value.<br />
*''Define cell wet/dry depths'' &ndash; Sets the depth limits that define certain attributes of cells in the model.<br />
**''Dry depth'' &ndash; Sets a minimum depth value below which the simulation drops a cell from calculations.<br />
**''Wet depth'' &ndash; Sets a minimum depth value below which the simulation sets a cell's momentum to zero.<br />
*''Z modifications'' &ndash; Options for adjusting and applying elevation data<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a row of elevation data to the ''Z modifications'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of elevation data from the ''Z modifications'' table.<br />
**[[File:Row-up.svg|pi|16 px]]'''Move up''' &ndash; Moves the selected row of elevation data to be above the row immediately above it.<br />
**[[File:Row-down.svg|pi|16 px]] '''Move down''' &ndash; Moves the selected row of elevation data to be below the row immediately below it.<br />
**''Type'' &ndash; Option to select which type of elevation input is desired on this row of data. The other columns in the table become active or inactive based on the type selected here.<br />
**''Set Zpts'' &ndash; Sets elevation values for the center of all cells in the model domain to the given value.<br />
**''GRID Zpts'' &ndash; Interpolates a grid file to set elevations for the mesh cell center. Select '''(none selected)''' to open a dialog box and select the desired grid file. Either .asc or .flt. can be used for this feature.<br />
**''CSV File'' &ndash; Option to update cell elevations using a .csv file. The .csv file can identify cells using x,y coordinates or cell IDs.<br />
**''CSV Type'' &ndash; Select which type of data the .csv file will contain.<br />
***"Cell ID" &ndash; Sets the program to read the .csv file data for cell IDs matched with elevation data. <br />
***"Coordinate" &ndash; Sets the program to read the .csv file data for x,y coordinates matched with elevation data.<br />
**''ZLine Shapes'' &ndash; Sets breakline features and polygon features according to an already imported .shp or .mif/.mid file. Select '''(none selected)''' to open a dialog and select the desired file.<br />
**''ZPoint Shapes'' &ndash; Sets elevation points according to an already imported .shp or .mif/.mid file. Using this feature, multiple layers of elevation information can be used. This allows for dividing the layers for better data management. Select '''(none selected)''' to open the ''Select Z Point Layers'' dialog.<br />
=====Select Z Point Layers=====<br />
[[File:TUFLOWFV MC Geometry Select Zpt Layers.png|thumb|200 px|The ''Select Z Point Layers'' dialog which opens when '''Select Z Point Layers...''' is clicked in the ''Geometry'' tab.]]<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Opens a dialog for selecting a file to define the Z point layer. Adds that layer to a new table row.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of data.<br />
{{-}}<br />
<br />
====Initial conditions====<br />
[[File:TUFLOWFV MC Initial.png|thumb|300 px|The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define initial water level'' &ndash; Option set water level to a constant value for the entire simulation. It's best for the water level boundary conditions for the initial time steps to be as close as possible to this setting.<br />
*''Use restart file'' &ndash; Option to use a restart file to define the initial conditions for the current run. The restart file must come from a model that uses the same mesh, bathymetry, vertical layering, and number of conserved variables as the model for the current simulation.<br />
**'''Select...''' &ndash; Opens dialog box for selecting restart file to be used.<br />
**''Use restart file time'' &ndash; Option to use the time stamp on the restart file as the starting time of the current run. On by default.<br />
{{-}}<br />
<br />
====Output====<br />
[[File:TUFLOWFV MC Output.png|thumb|300px|The ''Output'' tab of the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Output'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Output blocks'' &ndash; Output blocks set output file types as well as certain output file properties. They also allow for selecting desired datasets to be included in the output file and the time steps at which to output the information.<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a output block to the ''Output blocks'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the selected output block from the ''Output blocks'' table.<br />
**"DATV" &ndash; SMS will give mapped output in DATV format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"XMDF" &ndash; SMS will give mapped output in XMDF format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"NetCDF" &ndash; SMS will give mapped output in NetCDF (network Common Data Form) format with user specified datasets and parameters. Includes mapped output information at the desired time intervals as well as information about model geometry.<br />
**"Flux" &ndash; Outputs a CSV file that will give the values of fluid flow and, if applicable, the movement of other quantities that cross model boundaries or other specified nodestrings.<br />
**"Mass" &ndash; Outputs a CSV file that can be used to check certain simulated quantities, mainly the volume of fluid within the model domain. <br />
**"Points" &ndash; Outputs a CSV file containing model parameter time-series. This includes coordinates and associated data for the points of interest. <!--((as defined in a coverage dedicated to this task.??))--><br />
**"Transport" &ndash; Outputs a NetCDF file that can be used to improve the runtime of subsequent advection-diffusion, sediment, or particle tracking simulations. It stores conserved variables on the TUFLOW FV mesh for use in future simulations.<br />
<br />
*''Output block options - Row (value of active row)'' &ndash; Gives options to define attributes and datasets for a selected output block. Many options are only available when certain output blocks are selected. (See table below)<br />
**''Output points feature coverage'' &ndash; Only available when a "Points" output block is active. Click '''Select...''' to set the coverage that will define the coordinates of the desired output points<br />
**''Define Interval'' &ndash; Option to set the interval for the specified output in seconds. If not specified, the program will produce the specified output at every time step, sometimes resulting in output files that are too large.<br />
**''Define start time'' &ndash; Sets output request start time. When not specified, the output start time will be the simulation start time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define final time'' &ndash; Sets output request final time. When not specified, the output final time will be the simulation end time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define compression'' &ndash; Option to compress output file.<br />
***''Compression on'' &ndash; If turned on, output file will be compressed. On by default.<br />
**''Define Statistics'' &ndash; Option to track minimum and/or maximum values of selected datasets.<br />
***''Type'' &ndash; Select the values to track from the drop-down menu.<br />
****"Both" &ndash; Both maximum and minimum values for selected datasets will be tracked.<br />
****"Minimums" &ndash; Only minimum values for selected datasets will be tracked. <br />
****"Maximums" &ndash; Only maximum values for selected datasets will be tracked.<br />
***''Define statistics dt'' &ndash; Option to define independent output interval for tracking of minimum and maximum values. If not defined, defaults to 0 and uses the model interval.<br />
**''Filename suffix'' &ndash; Option to specify a desired suffix for output file.<br />
**''Datasets'' &ndash; Specify datasets for inclusion in output file. This will only appear when a DATV, XMDF, NetCDF, or points output block is active. For more information, see the table below.<br />
*''Directories'' <br />
**''Log directory'' &ndash; Option to specify directory for simulation log file (.log) output. When not specified, log file will be written to same location as simulation control file.<br />
**''Output directory'' &ndash; Option to specify location in which simulation output files will be written. When not specified, output files will be written to same location as simulation control file.<br />
**''Write restart file'' &ndash; TUFLOW FV writes the values of the selected datasets in each cell at desired regular time steps. Specify these time steps in ''Write restart dt''.<br />
***''Write restart dt'' &ndash; Specify the desired interval of time steps at which TUFLOW FV will write the restart file.<br />
***''Enable restart overwrite'' &ndash; Option to overwrite the restart file being used at the time interval specified in ''Write restart dt''. On by default.<br />
**''Write check files'' &ndash; Option to create a number of check files that can be used to verify model inputs.<br />
***''Check files directory'' &ndash;<br />
**''Write empty GIS files'' &ndash; Option to automatically create GIS template files in .mid/.mif or .shp format with recommended GIS naming conventions that "contain the correct GIS attributes".<br />
***''Template files directory'' &ndash; Sets the location in which the empty GIS files will be written.<br />
<br />
<br />
<br />
{| class="wikitable"<br />
!Category<br />
! scope="col" style="width: 250px;" | Output Block Options<br />
!Output blocks that use this option<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="8"|General<br />
|-<br />
|''Output points feature coverage''<br />
|Points<br />
|-<br />
|''Define interval''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport <br />
|-<br />
|''Define start time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define final time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define compression''<br />
|XMDF, NetCDF<br />
|-<br />
|''Define statistics''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Filename suffix''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="20"|Datasets<br />
|''Water depth''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Water surface elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Surface shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity vector and magnitude''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity magnitude only''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Turbulent viscosity''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Evaporation rate''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category based on the Australian NSW Flood plain management Manual (NSWG, 2005)''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category as outlined by Australian Emergency Management Institute in 2014'' <br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Hazard categories for the Queensland Reconstruction Authority''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Mean sea level pressure''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Downward short-wave radiation flux''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Temperatre''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''10 m wind speed vector''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave height'' &ndash; typically significant wave height<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave period'' &ndash; typically peak wave period<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave direction''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave stress vector''<br />
|DATV, XMDF, NetCDF, Points<br />
<br />
|}<br />
<br />
<br />
====Materials====<br />
[[File:TUFLOWFV MC Material.png|thumb|300 px|The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define default material (set mat)'' &ndash; Sets the material settings for every cell in the model domain. This material and its attributes will be the assumed material for each cell <!--((unless a material block defines them otherwise??))--><br />
**''Override Bottom Roughness'' &ndash; Select to allow for editing bottom roughness of this material.<br />
**''Bottom Roughness'' &ndash; Sets the default bottom roughness for the entire model. Will be factored in according to the bottom drag model selected on the ''Global parameters'' tab. <br />
**''Advanced Options'' &ndash; Select '''Advanced...''' to open the ''Materials (advanced) - Default material (set mat)'' dialog.<br />
=====Materials (advanced) - Default material (set mat)=====<br />
*''Define horizontal eddy viscosity'' &ndash; Option to adjust the horizontal eddy viscosity settings for this material. The input asked for here varies depending on the horizontal mixing model selected on the ''Global Parameters'' tab.<br />
**''Horizontal eddy viscosity'' &ndash; Sets the horizontal eddy viscosity for this material. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to "None" or "Constant".<br />
**''Horizontal eddy viscosity coefficient'' &ndash; Sets the coefficient for either the "Wu" or "Smagorinsky" mixing models, depending on the model selected on the ''Global Parameters'' tab. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to ''Smagorinsky'' or ''Wu''.<br />
*''Define bed elevations limits'' &ndash; Option to set limits for the bed elevation of cells defined by this material.<br />
**''Minimum bed elevation'' &ndash; Sets minimum bed elevation.<br />
**''Maximum bed elevation'' &ndash; Sets maximum bed elevation.<br />
*''Spatial reconstruction'' &ndash; Option to limit spatial reconstruction <!--(??for cells that are defined by the default material)-->. This reverts the calculations for this area to first-order calculations in a model that is second-order. This has no effect if the model is already first order as defined in the ''General'' tab under ''Define spatial order''.<br />
[[File:TUFLOWFV MC Materials Advanced DM Set Mat.png|left|380px|The ''Materials (advanced) - Default material (set mat)'' dialog which opens when '''Advanced...''' is selected on the ''Materials'' tab.]]<br />
{{-}}<br />
<br />
====Boundary Conditions====<br />
[[File:TUFLOWFV MC Boundary Conditions.png|thumb|450px|The ''Boundary Conditions'' tab on the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Boundary conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define BC default update dt'' &ndash; Option to set the time step for all boundary conditions to update. If unspecified, TUFLOW FV will interpolate values to each time step. If specified, TUFLOW FV will keep all values after one update but before the next update at a constant value.<br />
**''BC default update dt'' &ndash; <!--((sets the time value of the time steps that TUFLOW FV will interpolate to??))--><br />
*''Run in transport mode'' &ndash; Option to run a simulation that includes a transport boundary condition. This option can be useful for later models that use many of the same conditions but require different inputs.<br />
**''Transport BC file'' &ndash; Click '''Select...''' to set which transport file will be used in this simulation.<br />
*''Global boundaries'' &ndash; ((Boundary condition blocks that can be used to apply conditions to every cell in the model domain. For example, it can be used to account for inflow from rain or evaporation.<br />
**[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a boundary condition block that specifies conditions over the entire model domain.<br />
**[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the active global boundary condition block.<br />
**''Type'' &ndash; Shows the type of boundary condition assigned to this boundary condition block.<br />
**''Attributes''<br />
***'''Assign BC''' &ndash; Opens the ''Assign Global Boundary Condition'' dialog.<br />
*''Gridded boundaries'' &ndash; <br />
** [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a Gridded BC row to the ''Gridded boundaries'' table. Opens the ''Define BC Grid'' dialog.<br />
** [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes a Gridded BC row from the ''Gridded boundaries'' table.<br />
**''Grid Definition''<br />
***'''Define Grid...''' &ndash; Opens ''Define BC Grid'' dialog for selecting the grid and associated settings for selected grid definition block.<br />
**''Boundaries''<br />
***'''Define BCs...''' &ndash; Opens ''Add Gridded BCs'' dialog.<br />
*''Global wave options'' &ndash: Options for use if a linked Boundary Conditions coverage with a wave boundary type and/or a gridded wave boundary defined.<br />
**''Include wave stress'' &ndash;<br />
**''Include Stokes drift'' &ndash; Option to include Stokes drift in calculations. <!--((Interpolates mass transport for cells between the deepwater and surfzone depth??))--><br />
<br />
======Assign Global Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Global BC.png|thumb|450px|The ''Assign Global Boundary Condition'' dialog which opens when '''Assign BC''' is selected on the ''Boundary conditions'' tab.]]<br />
*''Options'' &ndash; <br />
**''Type'' &ndash; Sets which type of boundary condition to set globally for the model. The one option is "QG (Global Cell Inflow)".<br />
***"QG (Global Cell Inflow)" &ndash; Sets boundary condition as flow into every cell in model domain. Useful to account for effects of rain or evaporation.<br />
**''Subtype'' &ndash; Option to adjust how a boundary type functions numerically in the model.<br />
***"Sub-type 1" &ndash; The interior model concentration will be used to determine the scalar flux.<br />
***"Sub-type 2" &ndash; The value specified in the BC file will determine the scalar flux.<br />
**'''Define Curve...''' &ndash; Opens "BC Curve Editor" dialog.<br />
<br />
**''Define default'' &ndash; Defines default value for a given variable when TUFLOW FV gets a null-value from a boundary condition input.<br />
***''Q/A default'' &ndash;<br />
**''Define offset'' &ndash; Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale<br />
***''Q/A offset'' &ndash;<br />
**''Define scale'' &ndash; Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
***''Q/A scale'' &ndash;<br />
**''Define update increment'' &ndash; Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
***''Time'' &ndash; The value of the update intervals of time steps.<br />
**''Includes mean sea level pressure'' &ndash; Option to specify if an inverse barometer offset is already included in a water level boundary condition. By default, it is on to indicate there is an inverse barometer offset included. If turned off, the difference between the local MSLP and the reference MSLP will be applied at the boundary.<br />
<br />
======BC Curve Editor======<br />
<!--This is the only dialog that RC didn't upload an image for--><br />
*''Define reference time'' &ndash; <br />
**''Use ISODate'' &ndash;<br />
**''Reference time'' &ndash;<br />
*''Number of rows''<br />
*''Time Units''<br />
*'''Import...'''<br />
*''Time''<br />
*''Q/A''<br />
*[[File:Pan Tool.svg|16px]]'''Pan''' &ndash;<br />
<br />
=====Define BC Grid=====<br />
[[File:TUFLOWFV MC BC Define BC Grid.png|thumb|350px|The ''Define BC Grid'' dialog, which opens when '''Define Grid''' is selected in ''Boundary conditions'' tab.]]<br />
*''Grid Definition'' &ndash; Space for defining the location, filename, and settings for a NetCDF file that will be used to map input files to the model mesh.<br />
**''File'' &ndash; Click '''Select...''' to set the NetCDF file that contains the coordinates that define a grid. The gridded boundary conditions will be applied to this grid.<br />
**''Name'' &ndash; Name applied to the grid. Name might be used later to refer to this grid by other boundary conditions in this model.<br />
**''NetCDF variables'' &ndash; Sets the variables from the NetCDF file that the program should use to create the grid map.<br />
***''X-Variable'' &ndash; <br />
***''Y-Variable'' &ndash;<br />
***''Z-Variable'' &ndash;<br />
**''Define vertical coordinate type'' &ndash; Option to specify the vertical coordinate convention. The different convention names correspond to distinct kinds of depth averaging. <br />
***"Elevation" &ndash; [https://fvwiki.tuflow.com/index.php?title=Depth_Averaging_Results]. Here is the information. Not sure how to interpret it yet.<br />
***"Depth" &ndash;<br />
***"Sigma" &ndash;<br />
***"Height" &ndash;<br />
**''Cell gridmap'' &ndash; When turned off, (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Boundary gridmap'' &ndash; If on, calculates (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Suppress coverage warnings'' &ndash; Will suppress warnings that indicate the grid does not cover the entire domain.<br />
<br />
=====Add Gridded BCs=====<br />
[[File:TUFLOWFV MC BC Add Gridded BC.png|thumb|300px|The ''Add Gridded BCs'' dialog which opens when '''Define BCs...''' is selected on the ''Boundary Conditions'' tab.]]<br />
This dialog allows for assigning multiple boundary conditions to the one grid in the selected row.<br />
* [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a gridded boundary condition block to the grid associated with the active grid block.<br />
* [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the selected gridded boundary condition block.<br />
*''Type'' &ndash; Shows the type of boundary condition grid assigned to this boundary condition block.<br />
*''Attributes'' &ndash; <br />
**'''Assign BC...''' &ndash; Opens ''Assign Gridded Boundary Condition'' dialog.<br />
<br />
<br />
======Assign Gridded Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Gridded BC.png|thumb|300px|''Assign Gridded Boundary Condition'' dialog which opens when '''Assign BC...''' is selected in the ''Add Gridded BCs'' dialog.]]<br />
*''Options'' &ndash; TUFLOW Manual 15.4.4 BC Scale and BC Offset<br />
**''Type'' &ndash; Sets type of boundary condition to be used.<br />
***"MSLP_Grid" &ndash; Sets boundary condition type to mean sea level pressure field.<br />
***"W10_Grid" &ndash; Sets boundary condition type to wind velocity at 10m.<br />
***"Wave" &ndash; <br />
**''Dataset file'' &ndash; Opens dialog to select NetCDF file to define the data for the boundary condition.<br />
**'''Define Variables''' &ndash; Opens ''Select NetCDF Gridded BC Variable Names'' dialog.<br />
**For ''Define default'', ''Define offset'', ''Define scale'', ''Define reference time'', ''Define time units'', and ''Define update increment'', see table below.<br />
<br />
{| class="wikitable"<br />
!Grid Type<br />
!Option or Variable<br />
! scope="col" style="width: 550px;" | Definition<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="6" | All Grids<br />
|''Define default''<br />
|Defines default value for a given variable when a boundary condition input gives TUFLOW FV a null-value. <br />
|-<br />
|''Define offset''<br />
|Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale.<br />
|-<br />
|''Define scale''<br />
|Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
|-<br />
|''Define reference time''<br />
|Sets reference time for the boundary condition. When not set, the reference time will be the same as the simulation time. Option set reference time in hours, which is the default. Turn on ''Use ISODate'' to use that format if desired.<br />
|-<br />
|''Define time units''<br />
|Sets time units to be used for the boundary condition. The options are: <br />
*"Days"<br />
*"Hours"<br />
*"Minutes"<br />
*"Seconds"<br />
*"Isotime"<br />
|-<br />
|''Define update increment''<br />
|Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
|-<br />
!rowspan="1" | MSLP_Grid<br />
|''MSLP''<br />
|Mean sea level pressure<br />
|-<br />
!rowspan="2" | W10_Grid<br />
|''W10_X''<br />
|"10 m wind speed vector"<br />
|-<br />
|''W10_Y''<br />
|"10 m wind speed vector"<br />
|-<br />
!rowspan="8" | Wave<br />
|''HSIGN''<br />
|Significant wave height <!--(??In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''TPS''<br />
|Smoothed peak wave period<br />
|-<br />
|''DIR''<br />
|Mean wave direction. This is direction to which waves are heading when the <br />
|-<br />
|''UBOT''<br />
|The rms-value <!--(root mean square value?)--> of the maxima of the orbital velocity near the bottom. If it is left undefined, TUFLOW FV will calculate it using linear wave theory.<br />
|-<br />
|''TMBOT''<br />
|The bottom wave period<br />
|-<br />
|''FORCE_X''<br />
|X wave induced force vector component (In TUFLOW FV documentation, it's usually called WFORCE_X except for in Table 15-3<br />
|-<br />
|''FORCE_Y''<br />
|Y wave induced force vector component (In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)<br />
|-<br />
|''DEPTH''<br />
|Wave model water depth<br />
|}<br />
<br />
======Select NetCDF Gridded BC Variable Names======<br />
[[File:TUFLOWFV MC BC Select NetCDF Gridded Variable Names.png|thumb|200px|The ''Select NetCDF Gridded BC Variable Names'' dialog which opens when '''Define Variables...''' is selected under the ''Assign Gridded Boundary Condition'' dialog. This dialog is for a "Waves" boundary condition type as selected on the ''Assign Gridded Boundary Condition'' dialog.]]<br />
*''Variable names'' &ndash; The variables that appear (other than TIME, which appears no matter which grid type is selected) will be exactly the same as the variables that appear in the ''Assign Gridded Boundary Condition'' dialog under ''Define default'', ''Define offset'', and ''Define scale''. It varies depending on the grid type selected.<br />
**''TIME variable name'' &ndash; <!--(??Advanced option to select a ??header in the selected file for the TIME variable. Does this vary depending on what file you have selected? Jeff, there's not much information, but it's on page 335 in Appendix F of TUFLOW FV manual--><br />
**Grid Specific variables<br />
***MSLP_GRID variables:<br />
****''MSLP variable name'' &ndash; Advanced option to select a header in the selected file for the MSLP variable.<br />
***W10_GRID variables:<br />
****''W10_X variable name'' &ndash; Advanced option to select a header in the selected file for the W10_X variable.<br />
****''W10_Y variable name'' &ndash; Advanced option to select a header in the selected file for the W10_Y variable.<br />
***Wave variables:<br />
****''HSIGN variable name'' &ndash; Advanced option to select a header in the selected file for the HSIGN variable.<br />
****''TPS variable name'' &ndash; Advanced option to select a header in the selected file for the TPS variable.<br />
****''DIR variable name'' &ndash; Advanced option to select a header in the selected file for the DIR variable.<br />
****''UBOT variable name'' &ndash; Advanced option to select a header in the selected file for the UBOT variable.<br />
****''TMBOT variable name'' &ndash; Advanced option to select a header in the selected file for the TMBOT variable.<br />
****''FORCE_X variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_X variable.<br />
****''FORCE_Y variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_Y variable.<br />
****''DEPTH variable name'' &ndash; Advanced option to select a header in the selected file for the DEPTH variable.<br />
<br />
====Simulation links====<br />
[[File:TUFLOWFV MC Simulationlinks.png|thumb|300 px|The ''Simulation Links'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Simulation links'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Brings up the ''Select Child TUFLOW FV Simulation'' dialog. In this dialog another TUFLOW FV simulation can be select to link as a child simulation to the current simulation.<br />
*[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Unlinks the selected simulation.<br />
{{-}}<br />
<br />
====Advanced====<br />
The ''Advanced'' tab of the ''TUFLOW FV Model Control'' dialog contains the option to include advanced options These options can be added in the text editor located in this tab. The text will be appended to the FVC file with the simulation is exported.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
<!--Obsolete<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the [[SMS:Generic Model Graphical Interface|generic model interface]].<br />
<br />
===TUFLOW FV Menu===<br />
If the TUFLOW FV model paremeters have been correctly loaded into SMS, the ''TUFLOW FV'' menu is available when the Mesh module is active. The menu has the following commands:<br />
*'''Check Mesh''' &ndash; Performs a general model check and will bring up the [[SMS:Model Checker|''Model Checker'']] dialog if errors are found.<br />
*'''Define Model''' &ndash; Opens the model definitions. This is only accessible to the TUFLOW FV model developers.<br />
*'''Global Parameters''' &ndash; Brings up the ''TUFLOW FV Global Parameters'' dialog where parameters for the model run are specified.<br />
*'''Assign BC''' &ndash; Brings up the ''TUFLOW FV Nodestring Boundary Conditions'' dialog. Available when a boundary nodestring is selected.<br />
*'''Material Properties''' &ndash; Brings up the ''TUFLOW FV Material Properties'' dialog.<br />
*'''Run TUFLOW FV''' &ndash; Launches the TUFLOW FV model run.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
--><br />
==External Links==<br />
*[http://www.tuflow.com/Download/TUFLOW_FV/Manual/FV-UserManual-2014.01.pdf TUFLOW FV Manual]<br />
*[http://fvwiki.tuflow.com/index.php?title=Main_Page TUFLOW FV Wiki]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|TUFLOW]]<br />
[[Category:TUFLOW|FV]]<br />
[[Category:Generic Interface]]<br />
[[Category:External Links]]<br />
[[Category:Needs Update]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:TUFLOW_FV&diff=157023SMS:TUFLOW FV2022-11-07T19:54:19Z<p>Rcorrigan: </p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= TUFLOW FV<br />
|model_type= Two-dimensional (2D) flexible mesh finite volume flood, tide and water quality simulation software. <br />
|developer= <br />
WBM [http://www.wbmpl.com.au/ BMT WBM (Australia)]<br />
|web_site= [http://www.tuflow.com/Tuflow%20FV.aspx www.tuflow.com]<br />
|tutorials= [http://www.aquaveo.com/software/sms-learning-tutorials SMS Learning Center]<br />
<br />
}}<br />
TUFLOW FV (which stands for Two-dimensional Unsteady FLOW Finite Volume) is a flexible mesh finite volume numerical model that simulates hydrodynamic, sediment transport and water quality processes in oceans, coastal waters, estuaries and rivers. The model may be used for coastal and nearshore environments including beaches and coastlines as well as offshore environments such as estuaries, river entrances and deltas, and floodplains. Uses include modeling river flood flow, [http://www.tuflow.com/Download/Publications/2013IAHR_A11315.pdf tsunami] inundation (the finite-volume scheme is well suited for a tsunami's mixed sub/super-critical flow regimes), beach erosion, ocean pollution, and estuary flow.<br />
<br />
Unlike the fixed square grids of TUFLOW Classic, the flexible triangular or quadrilateral mesh of TUFLOW FV allows users to modify mesh resolution spatially, seamlessly increasing the model resolution in areas of interest. This modelling approach reduces the number of computation cells needed in a model reducing run times. Additionally, TUFLOW FV can be run in parallel on multiple processors, threads, or computers.<br />
<br />
The TUFLOW FV model can be added to a [http://www.aquaveo.com/software/sms-pricing paid edition] of SMS.<br />
[[Category:Link to Store]]<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the dynamic model interface. It makes use of the SMS [[SMS:Simulations|simulation]] workflow.<br />
<br />
===TUFLOW FV Coverages===<br />
TUFLOW FV simulations require a boundary condition coverage and a materials coverage.<br />
<br />
====Boundary Conditions Coverage====<br />
[[File:TUFLOWFV AssignBC.png|thumb|300 px|The TUFLOW FV Assign Boundary Condition dialog]]<br />
The TUFLOW FV boundary conditions coverage allows assigning boundary condition attributes to arcs drawn in the coverage. These attributes will then be assigned, or snapped, to the 2D mesh during the simulation run.<br />
<br />
Attributes are assigned to arcs by right-clicking a selected arc and selecting the Assign BC command. This will open the ''Assign Boundary Condition'' dialog for TUFLOW FV.<br />
<br />
The TUFLOW FV ''Assign Boundary Condition'' dialog has the following options:<br />
<br />
''BC Options'' &ndash; The ''BC Options'' tab has options for assigning attributes to the arc.<br />
*''Type'' &ndash; The option here determines what type of boundary condition will be assigned to the arc. The following types are available:<br />
**"Monitor" &ndash; Sets the arc to be a monitoring line.<br />
**"HQ (Head Discharge)" &ndash; <br />
**"Q (Nodestring Flow)"<br />
**"QN (Head Discharge)"<br />
**"WL (Water Level)"<br />
**"WLS (Sloping Water Level"<br />
**"WL_CURT (Water Level Curtain"<br />
**"ZG (Zero Gradient)"<br />
*''Subtype''<br />
*''Define Curve''<br />
*''Friction slope''<br />
*''Dataset file''<br />
*''Define Varaibles''<br />
*''View Curve''<br />
*''Define default''<br />
**'Q default''<br />
*''Define offset''<br />
**''Q offset''<br />
*''Define scale''<br />
**''Q scale''<br />
*''Define update increment''<br />
**''Time''<br />
*''Include mean sea level pressure''<br />
<br />
====Materials====<br />
The TUFLOW FV materials coverage allows creating the polygons to hold the material attributes for the simulation run. The assigned material attributes will be mapped to the mesh/grid during the simulation run.<br />
<br />
===TUFLOW FV Simulation Menu===<br />
The TUFLOW FV simulation item in the Project Explorer contains a right-click menu with commands for accessing TUFLOW FV simulation options. The menu has the following commands:<br />
* '''Simulation Run Queue''' &ndash; Opens the ''Simulation Run Queue'' dialog.<br />
* '''Model Control''' &ndash; Opens the ''TUFLOWFV Model Control'' dialog.<br />
*'''Save Simulation''' &ndash; Saves the simulations and exports the simulations files needed for the simulation run.<br />
*'''Run Simulation''' &ndash; Runs the simulation using the exported simulation files. will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Save Project, Simulation and Run''' &ndash; Exports the simulation files, saves the project and project files, and runs the simulation. Will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Read Solution''' &ndash; Opens a browser to import the solution files.<br />
*'''Simulation Properties''' &ndash; Opens the ''Simulation Propertes'' dialog where basic information about the simulation can be viewed.<br />
The specific menu commands may be different depending on the selected option in the ''Preferences'' dialog.<br />
<br />
===TUFLOW FV Model Control===<br />
The ''TUFLOW FV Model Control'' dialog contains options for setting the parameters that will be used during the simulation run. The dialog is accessed by right-clicking on the simulation in the Project Explorer and selecting the '''Model Control''' command. The dialog contains multiple options organized on multiple tables. The options are as follows:<br />
====General====<br />
[[File:TUFLOWFV MC General.png|thumb|300 px|The ''General'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''General'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define spatial order'' &ndash; Option to define horizontal spatial scheme.<br />
**''Horizontal'' &ndash; Select "1st" order scheme or "2nd" order scheme.<br />
***"1st" &ndash; Sets the simulation to use a 1<sup>st</sup> order scheme. This can be used when there is not a significant difference between the results for 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's also generally used for the beginning stages of most model development.<br />
***"2nd" &ndash; Sets the simulation to use a 2<sup>nd</sup> order scheme. This is used when a significant difference is noticed between 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's usually tested in more advanced stages of model development. Fast-changing flow conditions or high gradients in conserved variables might warrant or necessitate use of this spatial scheme.<br />
*''Define display interval'' &ndash; Option to set the interval in seconds at which time step information will be displayed to the log and terminal window.<br />
**''Display interval'' &ndash; Sets the interval in seconds for the display of time step information.<br />
*''Define hardware solver'' &ndash; Option to enable computing through the CPU or the GPU. Can produce slight differences in results.<br />
**"CPU" &ndash; Calculations will use the "Central Processing Unit".<br />
**"GPU" &ndash; Calculations will use the "Graphical Processing Unit". Using GPU with TUFLOW<br />
***''Device ID'' &ndash; Option to select which GPU device is used for computers or GPUs with multiple CUDA enabled GPU cards. <br />
*''Warn on projection mismatch of GIS inputs'' &ndash; Sets the program to warn if GIS inputs are not all in the same projection.<br />
*''Tutorial model'' <!--&ndash; (Allows simulation of the TUFLOW Tutorial Models without the need for a TUFLOW license.??)--><br />
{{-}}<br />
<br />
====Time====<br />
[[File:TUFLOWFV MC Time.png|thumb|300 px|The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Simulation time''<br />
**''Use ISODate'' &ndash; Option to use ISODate format which requires data be input in the form dd/mm/yyyy HH:MM:SS. If left off, default time format is hours.<br />
**''Reference time'' &ndash; Will set simulation reference time. Times set for starting and ending have reference to this time. This can affect output times when processing and visualizing results from certain programs.<br />
**''Starting time'' &ndash; Will set simulation start time.<br />
**''Ending time'' &ndash; Will set simulation end time.<br />
*''Time step limits''<br />
**''CFL'' &ndash; Sets the Courant-Friedrichs-Lewy condition. Can be no larger than one since this is the theoretical stability limit. Often, inputting a value lower than one ensures greater model stability.<br />
**''Min time step(s)'' &ndash; Specifies minimum variable time step allowed according to CFL stability criterion.<br />
**''Max time step(s)'' &ndash; Specifies maximum variable time step allowed according to CFL stability criterion.<br />
{{-}}<br />
<br />
====Global parameters====<br />
[[File:TUFLOWFV MC Global.png|thumb|300 px|The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define bottom drag model'' &ndash; Option to specify bottom drag model for the simulation. The bottom drag model will be used to describe bed boundary resistance in the simulation. The same bottom drag model will be used for every calculation that uses it.<br />
**''Method'' &ndash; Option to set bottom drag model to use "Manning" or "KS".<br />
***"Manning" &ndash; Uses the Manning model and requires a Manning's ''n'' coefficient<br />
****''Manning's n coefficient'' &ndash; Sets the Manning's ''n'' coefficient.<br />
***"KS" &ndash; Uses a model that assumes a log-law velocity profile and requires specification of a surface roughness length-scale.<br />
****''Nikuradse roughness'' &ndash; Sets the Nikuradse roughness for the bottom drag model.<br />
*''Horizontal mixing model'' &ndash; Defines horizontal mixing eddy viscosity calculation according to options in drop-down menu. <!--((In TUFLOW FV documentation it's called momentum mixing model??))--><br />
**"None" &ndash; Will not represent horizontal momentum mixing. <br />
**"Constant" &ndash; Option to globally define a specific constant eddy viscosity.<br />
***''Global horizontal eddy viscosity'' &ndash; Specifies the constant eddy viscosity for the entire simulation.<br />
**"Smagorinsky" &ndash; The horizontal eddy viscosity will be calculated according to the Smagorinsky model which sets the diffusivity proportional to the local strain rate. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity coefficient'' &ndash; Sets the Smagorinsky coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets for the entire simulation the limits for the horizontal eddy viscosity values. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
**"Wu" &ndash; The horizontal eddy viscosity will be calculated according to the Wu model. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity'' &ndash; Sets the Wu coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets the limits for the horizontal eddy viscosity values for the entire simulation. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
*''Define stability limits'' &ndash; Option to define the maximum acceptable values relevant for the model. If water level or velocity exceed the given values, the model will stop computations and give an error. This feature helps to identify a model with instabilities by recognizing unrealistic values that the model produces. Small anomalies and acceptable spikes in data values will not stop computations.<br />
**''Maximum water level'' &ndash; Sets maximum acceptable water level for the model.<br />
**''Maximum velocity'' &ndash; Sets maximum acceptable velocity for the model.<br />
{{-}}<br />
<br />
====Wind stress====<br />
[[File:TUFLOWFV MC Wind.png|thumb|300 px|The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define wind model'' &ndash; Option to define the model used in calculating wind stress for any wind inputs in the simulation.<br />
**''Model'' &ndash; Drop-down menu with options for models that can be used to calculate wind stress.<br />
***"Wu" &ndash; Sets the wind stress model to the Wu model. Scales wind stress parameterisation based on wind speed.<br />
***"Constant" &ndash; Applies wind stress parameterisation using Bulk momentum transfer coefficient as in pre-2019 builds of TUFLOW.<br />
***"Kondo" &ndash; Applies a scaling factor <!--((for the wind stress parameters??))--> using a single term.<br />
*''Define wind parameters'' &ndash; <!--((Sets the wind drag coefficients that the selected model will use to scale the wind stress parameterisation??))--> Varies according to the wind model selected.<br />
**''Wa'' &ndash; <!--((??Wind speed in meters per second))--><br />
**''Ca'' &ndash; <br />
**''Wb'' &ndash;<br />
**''Cb'' &ndash;<br />
**''Bulk momentum transfer coefficient'' &ndash; Sets the coefficient for the Constant wind stress model.<br />
**''Scale factor'' &ndash; Sets the scaling factor for the Kondo wind stress model.<br />
{{-}}<br />
<br />
====Geometry====<br />
[[File:TUFLOWFV MC Geometry.png|thumb|300 px|The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define global bed elevation limits'' &ndash; Option to apply bed elevation limits to the entire model. Bed elevations in the model that are outside the set limits will be set to the minimum or the maximum. <br />
**''Bed elevation minimum'' &ndash; Defines minimum bed elevation. Bed Elevations in the model below this value will be set to this value.<br />
**''Bed elevation maximum'' &ndash; Defines maximum bed elevations. Bed Elevations in the model above this value will be set to this value.<br />
*''Define cell wet/dry depths'' &ndash; Sets the depth limits that define certain attributes of cells in the model.<br />
**''Dry depth'' &ndash; Sets a minimum depth value below which the simulation drops a cell from calculations.<br />
**''Wet depth'' &ndash; Sets a minimum depth value below which the simulation sets a cell's momentum to zero.<br />
*''Z modifications'' &ndash; Options for adjusting and applying elevation data<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a row of elevation data to the ''Z modifications'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of elevation data from the ''Z modifications'' table.<br />
**[[File:Row-up.svg|pi|16 px]]'''Move up''' &ndash; Moves the selected row of elevation data to be above the row immediately above it.<br />
**[[File:Row-down.svg|pi|16 px]] '''Move down''' &ndash; Moves the selected row of elevation data to be below the row immediately below it.<br />
**''Type'' &ndash; Option to select which type of elevation input is desired on this row of data. The other columns in the table become active or inactive based on the type selected here.<br />
**''Set Zpts'' &ndash; Sets elevation values for the center of all cells in the model domain to the given value.<br />
**''GRID Zpts'' &ndash; Interpolates a grid file to set elevations for the mesh cell center. Select '''(none selected)''' to open a dialog box and select the desired grid file. Either .asc or .flt. can be used for this feature.<br />
**''CSV File'' &ndash; Option to update cell elevations using a .csv file. The .csv file can identify cells using x,y coordinates or cell IDs.<br />
**''CSV Type'' &ndash; Select which type of data the .csv file will contain.<br />
***"Cell ID" &ndash; Sets the program to read the .csv file data for cell IDs matched with elevation data. <br />
***"Coordinate" &ndash; Sets the program to read the .csv file data for x,y coordinates matched with elevation data.<br />
**''ZLine Shapes'' &ndash; Sets breakline features and polygon features according to an already imported .shp or .mif/.mid file. Select '''(none selected)''' to open a dialog and select the desired file.<br />
**''ZPoint Shapes'' &ndash; Sets elevation points according to an already imported .shp or .mif/.mid file. Using this feature, multiple layers of elevation information can be used. This allows for dividing the layers for better data management. Select '''(none selected)''' to open the ''Select Z Point Layers'' dialog.<br />
=====Select Z Point Layers=====<br />
[[File:TUFLOWFV MC Geometry Select Zpt Layers.png|thumb|200 px|The ''Select Z Point Layers'' dialog which opens when '''Select Z Point Layers...''' is clicked in the ''Geometry'' tab.]]<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Opens a dialog for selecting a file to define the Z point layer. Adds that layer to a new table row.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of data.<br />
{{-}}<br />
<br />
====Initial conditions====<br />
[[File:TUFLOWFV MC Initial.png|thumb|300 px|The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define initial water level'' &ndash; Option set water level to a constant value for the entire simulation. It's best for the water level boundary conditions for the initial time steps to be as close as possible to this setting.<br />
*''Use restart file'' &ndash; Option to use a restart file to define the initial conditions for the current run. The restart file must come from a model that uses the same mesh, bathymetry, vertical layering, and number of conserved variables as the model for the current simulation.<br />
**'''Select...''' &ndash; Opens dialog box for selecting restart file to be used.<br />
**''Use restart file time'' &ndash; Option to use the time stamp on the restart file as the starting time of the current run. On by default.<br />
{{-}}<br />
<br />
====Output====<br />
[[File:TUFLOWFV MC Output.png|thumb|300px|The ''Output'' tab of the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Output'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Output blocks'' &ndash; Output blocks set output file types as well as certain output file properties. They also allow for selecting desired datasets to be included in the output file and the time steps at which to output the information.<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a output block to the ''Output blocks'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the selected output block from the ''Output blocks'' table.<br />
**"DATV" &ndash; SMS will give mapped output in DATV format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"XMDF" &ndash; SMS will give mapped output in XMDF format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"NetCDF" &ndash; SMS will give mapped output in NetCDF (network Common Data Form) format with user specified datasets and parameters. Includes mapped output information at the desired time intervals as well as information about model geometry.<br />
**"Flux" &ndash; Outputs a CSV file that will give the values of fluid flow and, if applicable, the movement of other quantities that cross model boundaries or other specified nodestrings.<br />
**"Mass" &ndash; Outputs a CSV file that can be used to check certain simulated quantities, mainly the volume of fluid within the model domain. <br />
**"Points" &ndash; Outputs a CSV file containing model parameter time-series. This includes coordinates and associated data for the points of interest. <!--((as defined in a coverage dedicated to this task.??))--><br />
**"Transport" &ndash; Outputs a NetCDF file that can be used to improve the runtime of subsequent advection-diffusion, sediment, or particle tracking simulations. It stores conserved variables on the TUFLOW FV mesh for use in future simulations.<br />
<br />
*''Output block options - Row (value of active row)'' &ndash; Gives options to define attributes and datasets for a selected output block. Many options are only available when certain output blocks are selected. (See table below)<br />
**''Output points feature coverage'' &ndash; Only available when a "Points" output block is active. Click '''Select...''' to set the coverage that will define the coordinates of the desired output points<br />
**''Define Interval'' &ndash; Option to set the interval for the specified output in seconds. If not specified, the program will produce the specified output at every time step, sometimes resulting in output files that are too large.<br />
**''Define start time'' &ndash; Sets output request start time. When not specified, the output start time will be the simulation start time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define final time'' &ndash; Sets output request final time. When not specified, the output final time will be the simulation end time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define compression'' &ndash; Option to compress output file.<br />
***''Compression on'' &ndash; If turned on, output file will be compressed. On by default.<br />
**''Define Statistics'' &ndash; Option to track minimum and/or maximum values of selected datasets.<br />
***''Type'' &ndash; Select the values to track from the drop-down menu.<br />
****"Both" &ndash; Both maximum and minimum values for selected datasets will be tracked.<br />
****"Minimums" &ndash; Only minimum values for selected datasets will be tracked. <br />
****"Maximums" &ndash; Only maximum values for selected datasets will be tracked.<br />
***''Define statistics dt'' &ndash; Option to define independent output interval for tracking of minimum and maximum values. If not defined, defaults to 0 and uses the model interval.<br />
**''Filename suffix'' &ndash; Option to specify a desired suffix for output file.<br />
**''Datasets'' &ndash; Specify datasets for inclusion in output file. This will only appear when a DATV, XMDF, NetCDF, or points output block is active. For more information, see the table below.<br />
*''Directories'' <br />
**''Log directory'' &ndash; Option to specify directory for simulation log file (.log) output. When not specified, log file will be written to same location as simulation control file.<br />
**''Output directory'' &ndash; Option to specify location in which simulation output files will be written. When not specified, output files will be written to same location as simulation control file.<br />
**''Write restart file'' &ndash; TUFLOW FV writes the values of the selected datasets in each cell at desired regular time steps. Specify these time steps in ''Write restart dt''.<br />
***''Write restart dt'' &ndash; Specify the desired interval of time steps at which TUFLOW FV will write the restart file.<br />
***''Enable restart overwrite'' &ndash; Option to overwrite the restart file being used at the time interval specified in ''Write restart dt''. On by default.<br />
**''Write check files'' &ndash; Option to create a number of check files that can be used to verify model inputs.<br />
***''Check files directory'' &ndash;<br />
**''Write empty GIS files'' &ndash; Option to automatically create GIS template files in .mid/.mif or .shp format with recommended GIS naming conventions that "contain the correct GIS attributes".<br />
***''Template files directory'' &ndash; Sets the location in which the empty GIS files will be written.<br />
<br />
<br />
<br />
{| class="wikitable"<br />
!Category<br />
! scope="col" style="width: 250px;" | Output Block Options<br />
!Output blocks that use this option<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="8"|General<br />
|-<br />
|''Output points feature coverage''<br />
|Points<br />
|-<br />
|''Define interval''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport <br />
|-<br />
|''Define start time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define final time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define compression''<br />
|XMDF, NetCDF<br />
|-<br />
|''Define statistics''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Filename suffix''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="20"|Datasets<br />
|''Water depth''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Water surface elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Surface shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity vector and magnitude''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity magnitude only''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Turbulent viscosity''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Evaporation rate''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category based on the Australian NSW Flood plain management Manual (NSWG, 2005)''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category as outlined by Australian Emergency Management Institute in 2014'' <br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Hazard categories for the Queensland Reconstruction Authority''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Mean sea level pressure''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Downward short-wave radiation flux''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Temperatre''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''10 m wind speed vector''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave height'' &ndash; typically significant wave height<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave period'' &ndash; typically peak wave period<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave direction''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave stress vector''<br />
|DATV, XMDF, NetCDF, Points<br />
<br />
|}<br />
<br />
<br />
====Materials====<br />
[[File:TUFLOWFV MC Material.png|thumb|300 px|The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define default material (set mat)'' &ndash; Sets the material settings for every cell in the model domain. This material and its attributes will be the assumed material for each cell <!--((unless a material block defines them otherwise??))--><br />
**''Override Bottom Roughness'' &ndash; Select to allow for editing bottom roughness of this material.<br />
**''Bottom Roughness'' &ndash; Sets the default bottom roughness for the entire model. Will be factored in according to the bottom drag model selected on the ''Global parameters'' tab. <br />
**''Advanced Options'' &ndash; Select '''Advanced...''' to open the ''Materials (advanced) - Default material (set mat)'' dialog.<br />
=====Materials (advanced) - Default material (set mat)=====<br />
*''Define horizontal eddy viscosity'' &ndash; Option to adjust the horizontal eddy viscosity settings for this material. The input asked for here varies depending on the horizontal mixing model selected on the ''Global Parameters'' tab.<br />
**''Horizontal eddy viscosity'' &ndash; Sets the horizontal eddy viscosity for this material. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to "None" or "Constant".<br />
**''Horizontal eddy viscosity coefficient'' &ndash; Sets the coefficient for either the "Wu" or "Smagorinsky" mixing models, depending on the model selected on the ''Global Parameters'' tab. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to ''Smagorinsky'' or ''Wu''.<br />
*''Define bed elevations limits'' &ndash; Option to set limits for the bed elevation of cells defined by this material.<br />
**''Minimum bed elevation'' &ndash; Sets minimum bed elevation.<br />
**''Maximum bed elevation'' &ndash; Sets maximum bed elevation.<br />
*''Spatial reconstruction'' &ndash; Option to limit spatial reconstruction <!--(??for cells that are defined by the default material)-->. This reverts the calculations for this area to first-order calculations in a model that is second-order. This has no effect if the model is already first order as defined in the ''General'' tab under ''Define spatial order''.<br />
[[File:TUFLOWFV MC Materials Advanced DM Set Mat.png|left|380px|The ''Materials (advanced) - Default material (set mat)'' dialog which opens when '''Advanced...''' is selected on the ''Materials'' tab.]]<br />
{{-}}<br />
<br />
====Boundary Conditions====<br />
[[File:TUFLOWFV MC Boundary Conditions.png|thumb|450px|The ''Boundary Conditions'' tab on the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Boundary conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define BC default update dt'' &ndash; Option to set the time step for all boundary conditions to update. If unspecified, TUFLOW FV will interpolate values to each time step. If specified, TUFLOW FV will keep all values after one update but before the next update at a constant value.<br />
**''BC default update dt'' &ndash; <!--((sets the time value of the time steps that TUFLOW FV will interpolate to??))--><br />
*''Run in transport mode'' &ndash; Option to run a simulation that includes a transport boundary condition. This option can be useful for later models that use many of the same conditions but require different inputs.<br />
**''Transport BC file'' &ndash; Click '''Select...''' to set which transport file will be used in this simulation.<br />
*''Global boundaries'' &ndash; ((Boundary condition blocks that can be used to apply conditions to every cell in the model domain. For example, it can be used to account for inflow from rain or evaporation.<br />
**[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a boundary condition block that specifies conditions over the entire model domain.<br />
**[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the active global boundary condition block.<br />
**''Type'' &ndash; Shows the type of boundary condition assigned to this boundary condition block.<br />
**''Attributes''<br />
***'''Assign BC''' &ndash; Opens the ''Assign Global Boundary Condition'' dialog.<br />
*''Gridded boundaries'' &ndash; <br />
** [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a Gridded BC row to the ''Gridded boundaries'' table. Opens the ''Define BC Grid'' dialog.<br />
** [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes a Gridded BC row from the ''Gridded boundaries'' table.<br />
**''Grid Definition''<br />
***'''Define Grid...''' &ndash; Opens ''Define BC Grid'' dialog for selecting the grid and associated settings for selected grid definition block.<br />
**''Boundaries''<br />
***'''Define BCs...''' &ndash; Opens ''Add Gridded BCs'' dialog.<br />
*''Global wave options'' &ndash: Options for use if a linked Boundary Conditions coverage with a wave boundary type and/or a gridded wave boundary defined.<br />
**''Include wave stress'' &ndash;<br />
**''Include Stokes drift'' &ndash; Option to include Stokes drift in calculations. <!--((Interpolates mass transport for cells between the deepwater and surfzone depth??))--><br />
<br />
======Assign Global Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Global BC.png|thumb|450px|The ''Assign Global Boundary Condition'' dialog which opens when '''Assign BC''' is selected on the ''Boundary conditions'' tab.]]<br />
*''Options'' &ndash; <br />
**''Type'' &ndash; Sets which type of boundary condition to set globally for the model. The one option is "QG (Global Cell Inflow)".<br />
***"QG (Global Cell Inflow)" &ndash; Sets boundary condition as flow into every cell in model domain. Useful to account for effects of rain or evaporation.<br />
**''Subtype'' &ndash; Option to adjust how a boundary type functions numerically in the model.<br />
***"Sub-type 1" &ndash; The interior model concentration will be used to determine the scalar flux.<br />
***"Sub-type 2" &ndash; The value specified in the BC file will determine the scalar flux.<br />
**'''Define Curve...''' &ndash; Opens "BC Curve Editor" dialog.<br />
<br />
**''Define default'' &ndash; Defines default value for a given variable when TUFLOW FV gets a null-value from a boundary condition input.<br />
***''Q/A default'' &ndash;<br />
**''Define offset'' &ndash; Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale<br />
***''Q/A offset'' &ndash;<br />
**''Define scale'' &ndash; Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
***''Q/A scale'' &ndash;<br />
**''Define update increment'' &ndash; Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
***''Time'' &ndash; The value of the update intervals of time steps.<br />
**''Includes mean sea level pressure'' &ndash; Option to specify if an inverse barometer offset is already included in a water level boundary condition. By default, it is on to indicate there is an inverse barometer offset included. If turned off, the difference between the local MSLP and the reference MSLP will be applied at the boundary.<br />
<br />
======BC Curve Editor======<br />
<!--This is the only dialog that RC didn't upload an image for--><br />
*''Define reference time'' &ndash; <br />
**''Use ISODate'' &ndash;<br />
**''Reference time'' &ndash;<br />
*''Number of rows''<br />
*''Time Units''<br />
*'''Import...'''<br />
*''Time''<br />
*''Q/A''<br />
*[[File:Pan Tool.svg|16px]]'''Pan''' &ndash;<br />
<br />
=====Define BC Grid=====<br />
[[File:TUFLOWFV MC BC Define BC Grid.png|thumb|350px|The ''Define BC Grid'' dialog, which opens when '''Define Grid''' is selected in ''Boundary conditions'' tab.]]<br />
*''Grid Definition'' &ndash; Space for defining the location, filename, and settings for a NetCDF file that will be used to map input files to the model mesh.<br />
**''File'' &ndash; Click '''Select...''' to set the NetCDF file that contains the coordinates that define a grid. The gridded boundary conditions will be applied to this grid.<br />
**''Name'' &ndash; Name applied to the grid. Name might be used later to refer to this grid by other boundary conditions in this model.<br />
**''NetCDF variables'' &ndash; Sets the variables from the NetCDF file that the program should use to create the grid map.<br />
***''X-Variable'' &ndash; <br />
***''Y-Variable'' &ndash;<br />
***''Z-Variable'' &ndash;<br />
**''Define vertical coordinate type'' &ndash; Option to specify the vertical coordinate convention. The different convention names correspond to distinct kinds of depth averaging. <br />
***"Elevation" &ndash; [https://fvwiki.tuflow.com/index.php?title=Depth_Averaging_Results]. Here is the information. Not sure how to interpret it yet.<br />
***"Depth" &ndash;<br />
***"Sigma" &ndash;<br />
***"Height" &ndash;<br />
**''Cell gridmap'' &ndash; When turned off, (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Boundary gridmap'' &ndash; If on, calculates (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Suppress coverage warnings'' &ndash; Will suppress warnings that indicate the grid does not cover the entire domain.<br />
<br />
=====Add Gridded BCs=====<br />
[[File:TUFLOWFV MC BC Add Gridded BC.png|thumb|300px|The ''Add Gridded BCs'' dialog which opens when '''Define BCs...''' is selected on the ''Boundary Conditions'' tab.]]<br />
This dialog allows for assigning multiple boundary conditions to the one grid in the selected row.<br />
* [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a gridded boundary condition block to the grid associated with the active grid block.<br />
* [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the selected gridded boundary condition block.<br />
*''Type'' &ndash; Shows the type of boundary condition grid assigned to this boundary condition block.<br />
*''Attributes'' &ndash; <br />
**'''Assign BC...''' &ndash; Opens ''Assign Gridded Boundary Condition'' dialog.<br />
<br />
<br />
======Assign Gridded Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Gridded BC.png|thumb|300px|''Assign Gridded Boundary Condition'' dialog which opens when '''Assign BC...''' is selected in the ''Add Gridded BCs'' dialog.]]<br />
*''Options'' &ndash; TUFLOW Manual 15.4.4 BC Scale and BC Offset<br />
**''Type'' &ndash; Sets type of boundary condition to be used.<br />
***"MSLP_Grid" &ndash; Sets boundary condition type to mean sea level pressure field.<br />
***"W10_Grid" &ndash; Sets boundary condition type to wind velocity at 10m.<br />
***"Wave" &ndash; <br />
**''Dataset file'' &ndash; Opens dialog to select NetCDF file to define the data for the boundary condition.<br />
**'''Define Variables''' &ndash; Opens ''Select NetCDF Gridded BC Variable Names'' dialog.<br />
**For ''Define default'', ''Define offset'', ''Define scale'', ''Define reference time'', ''Define time units'', and ''Define update increment'', see table below.<br />
<br />
{| class="wikitable"<br />
!Grid Type<br />
!Option or Variable<br />
! scope="col" style="width: 550px;" | Definition<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="6" | All Grids<br />
|''Define default''<br />
|Defines default value for a given variable when a boundary condition input gives TUFLOW FV a null-value. <br />
|-<br />
|''Define offset''<br />
|Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale.<br />
|-<br />
|''Define scale''<br />
|Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
|-<br />
|''Define reference time''<br />
|Sets reference time for the boundary condition. When not set, the reference time will be the same as the simulation time. Option set reference time in hours, which is the default. Turn on ''Use ISODate'' to use that format if desired.<br />
|-<br />
|''Define time units''<br />
|Sets time units to be used for the boundary condition. The options are: <br />
*"Days"<br />
*"Hours"<br />
*"Minutes"<br />
*"Seconds"<br />
*"Isotime"<br />
|-<br />
|''Define update increment''<br />
|Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
|-<br />
!rowspan="1" | MSLP_Grid<br />
|''MSLP''<br />
|Mean sea level pressure<br />
|-<br />
!rowspan="2" | W10_Grid<br />
|''W10_X''<br />
|"10 m wind speed vector"<br />
|-<br />
|''W10_Y''<br />
|"10 m wind speed vector"<br />
|-<br />
!rowspan="8" | Wave<br />
|''HSIGN''<br />
|Significant wave height <!--(??In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)--><br />
|-<br />
|''TPS''<br />
|Smoothed peak wave period<br />
|-<br />
|''DIR''<br />
|Mean wave direction. This is direction to which waves are heading when the <br />
|-<br />
|''UBOT''<br />
|The rms-value (root mean square value?) of the maxima of the orbital velocity near the bottom. If it is left undefined, TUFLOW FV will calculate it using linear wave theory.<br />
|-<br />
|''TMBOT''<br />
|The bottom wave period<br />
|-<br />
|''FORCE_X''<br />
|X wave induced force vector component (In TUFLOW FV documentation, it's usually called WFORCE_X except for in Table 15-3<br />
|-<br />
|''FORCE_Y''<br />
|Y wave induced force vector component (In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)<br />
|-<br />
|''DEPTH''<br />
|Wave model water depth<br />
|}<br />
<br />
======Select NetCDF Gridded BC Variable Names======<br />
[[File:TUFLOWFV MC BC Select NetCDF Gridded Variable Names.png|thumb|200px|The ''Select NetCDF Gridded BC Variable Names'' dialog which opens when '''Define Variables...''' is selected under the ''Assign Gridded Boundary Condition'' dialog. This dialog is for a "Waves" boundary condition type as selected on the ''Assign Gridded Boundary Condition'' dialog.]]<br />
*''Variable names'' &ndash; The variables that appear (other than TIME, which appears no matter which grid type is selected) will be exactly the same as the variables that appear in the ''Assign Gridded Boundary Condition'' dialog under ''Define default'', ''Define offset'', and ''Define scale''. It varies depending on the grid type selected.<br />
**''TIME variable name'' &ndash; <!--(??Advanced option to select a ??header in the selected file for the TIME variable. Does this vary depending on what file you have selected? Jeff, there's not much information, but it's on page 335 in Appendix F of TUFLOW FV manual--><br />
**Grid Specific variables<br />
***MSLP_GRID variables:<br />
****''MSLP variable name'' &ndash; Advanced option to select a header in the selected file for the MSLP variable.<br />
***W10_GRID variables:<br />
****''W10_X variable name'' &ndash; Advanced option to select a header in the selected file for the W10_X variable.<br />
****''W10_Y variable name'' &ndash; Advanced option to select a header in the selected file for the W10_Y variable.<br />
***Wave variables:<br />
****''HSIGN variable name'' &ndash; Advanced option to select a header in the selected file for the HSIGN variable.<br />
****''TPS variable name'' &ndash; Advanced option to select a header in the selected file for the TPS variable.<br />
****''DIR variable name'' &ndash; Advanced option to select a header in the selected file for the DIR variable.<br />
****''UBOT variable name'' &ndash; Advanced option to select a header in the selected file for the UBOT variable.<br />
****''TMBOT variable name'' &ndash; Advanced option to select a header in the selected file for the TMBOT variable.<br />
****''FORCE_X variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_X variable.<br />
****''FORCE_Y variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_Y variable.<br />
****''DEPTH variable name'' &ndash; Advanced option to select a header in the selected file for the DEPTH variable.<br />
<br />
====Simulation links====<br />
[[File:TUFLOWFV MC Simulationlinks.png|thumb|300 px|The ''Simulation Links'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Simulation links'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Brings up the ''Select Child TUFLOW FV Simulation'' dialog. In this dialog another TUFLOW FV simulation can be select to link as a child simulation to the current simulation.<br />
*[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Unlinks the selected simulation.<br />
{{-}}<br />
<br />
====Advanced====<br />
The ''Advanced'' tab of the ''TUFLOW FV Model Control'' dialog contains the option to include advanced options These options can be added in the text editor located in this tab. The text will be appended to the FVC file with the simulation is exported.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
<!--Obsolete<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the [[SMS:Generic Model Graphical Interface|generic model interface]].<br />
<br />
===TUFLOW FV Menu===<br />
If the TUFLOW FV model paremeters have been correctly loaded into SMS, the ''TUFLOW FV'' menu is available when the Mesh module is active. The menu has the following commands:<br />
*'''Check Mesh''' &ndash; Performs a general model check and will bring up the [[SMS:Model Checker|''Model Checker'']] dialog if errors are found.<br />
*'''Define Model''' &ndash; Opens the model definitions. This is only accessible to the TUFLOW FV model developers.<br />
*'''Global Parameters''' &ndash; Brings up the ''TUFLOW FV Global Parameters'' dialog where parameters for the model run are specified.<br />
*'''Assign BC''' &ndash; Brings up the ''TUFLOW FV Nodestring Boundary Conditions'' dialog. Available when a boundary nodestring is selected.<br />
*'''Material Properties''' &ndash; Brings up the ''TUFLOW FV Material Properties'' dialog.<br />
*'''Run TUFLOW FV''' &ndash; Launches the TUFLOW FV model run.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
--><br />
==External Links==<br />
*[http://www.tuflow.com/Download/TUFLOW_FV/Manual/FV-UserManual-2014.01.pdf TUFLOW FV Manual]<br />
*[http://fvwiki.tuflow.com/index.php?title=Main_Page TUFLOW FV Wiki]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|TUFLOW]]<br />
[[Category:TUFLOW|FV]]<br />
[[Category:Generic Interface]]<br />
[[Category:External Links]]<br />
[[Category:Needs Update]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=SMS:TUFLOW_FV&diff=157020SMS:TUFLOW FV2022-11-07T19:34:34Z<p>Rcorrigan: Deleted a part of unnecessary draft material that was pasted into the final page.</p>
<hr />
<div>{{SMS Infobox Model |<br />
|name= TUFLOW FV<br />
|model_type= Two-dimensional (2D) flexible mesh finite volume flood, tide and water quality simulation software. <br />
|developer= <br />
WBM [http://www.wbmpl.com.au/ BMT WBM (Australia)]<br />
|web_site= [http://www.tuflow.com/Tuflow%20FV.aspx www.tuflow.com]<br />
|tutorials= [http://www.aquaveo.com/software/sms-learning-tutorials SMS Learning Center]<br />
<br />
}}<br />
TUFLOW FV (which stands for Two-dimensional Unsteady FLOW Finite Volume) is a flexible mesh finite volume numerical model that simulates hydrodynamic, sediment transport and water quality processes in oceans, coastal waters, estuaries and rivers. The model may be used for coastal and nearshore environments including beaches and coastlines as well as offshore environments such as estuaries, river entrances and deltas, and floodplains. Uses include modeling river flood flow, [http://www.tuflow.com/Download/Publications/2013IAHR_A11315.pdf tsunami] inundation (the finite-volume scheme is well suited for a tsunami's mixed sub/super-critical flow regimes), beach erosion, ocean pollution, and estuary flow.<br />
<br />
Unlike the fixed square grids of TUFLOW Classic, the flexible triangular or quadrilateral mesh of TUFLOW FV allows users to modify mesh resolution spatially, seamlessly increasing the model resolution in areas of interest. This modelling approach reduces the number of computation cells needed in a model reducing run times. Additionally, TUFLOW FV can be run in parallel on multiple processors, threads, or computers.<br />
<br />
The TUFLOW FV model can be added to a [http://www.aquaveo.com/software/sms-pricing paid edition] of SMS.<br />
[[Category:Link to Store]]<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the dynamic model interface. It makes use of the SMS [[SMS:Simulations|simulation]] workflow.<br />
<br />
===TUFLOW FV Coverages===<br />
TUFLOW FV simulations require a boundary condition coverage and a materials coverage.<br />
<br />
====Boundary Conditions Coverage====<br />
[[File:TUFLOWFV AssignBC.png|thumb|300 px|The TUFLOW FV Assign Boundary Condition dialog]]<br />
The TUFLOW FV boundary conditions coverage allows assigning boundary condition attributes to arcs drawn in the coverage. These attributes will then be assigned, or snapped, to the 2D mesh during the simulation run.<br />
<br />
Attributes are assigned to arcs by right-clicking a selected arc and selecting the Assign BC command. This will open the ''Assign Boundary Condition'' dialog for TUFLOW FV.<br />
<br />
The TUFLOW FV ''Assign Boundary Condition'' dialog has the following options:<br />
<br />
''BC Options'' &ndash; The ''BC Options'' tab has options for assigning attributes to the arc.<br />
*''Type'' &ndash; The option here determines what type of boundary condition will be assigned to the arc. The following types are available:<br />
**"Monitor" &ndash; Sets the arc to be a monitoring line.<br />
**"HQ (Head Discharge)" &ndash; <br />
**"Q (Nodestring Flow)"<br />
**"QN (Head Discharge)"<br />
**"WL (Water Level)"<br />
**"WLS (Sloping Water Level"<br />
**"WL_CURT (Water Level Curtain"<br />
**"ZG (Zero Gradient)"<br />
*''Subtype''<br />
*''Define Curve''<br />
*''Friction slope''<br />
*''Dataset file''<br />
*''Define Varaibles''<br />
*''View Curve''<br />
*''Define default''<br />
**'Q default''<br />
*''Define offset''<br />
**''Q offset''<br />
*''Define scale''<br />
**''Q scale''<br />
*''Define update increment''<br />
**''Time''<br />
*''Include mean sea level pressure''<br />
<br />
====Materials====<br />
The TUFLOW FV materials coverage allows creating the polygons to hold the material attributes for the simulation run. The assigned material attributes will be mapped to the mesh/grid during the simulation run.<br />
<br />
===TUFLOW FV Simulation Menu===<br />
The TUFLOW FV simulation item in the Project Explorer contains a right-click menu with commands for accessing TUFLOW FV simulation options. The menu has the following commands:<br />
* '''Simulation Run Queue''' &ndash; Opens the ''Simulation Run Queue'' dialog.<br />
* '''Model Control''' &ndash; Opens the ''TUFLOWFV Model Control'' dialog.<br />
*'''Save Simulation''' &ndash; Saves the simulations and exports the simulations files needed for the simulation run.<br />
*'''Run Simulation''' &ndash; Runs the simulation using the exported simulation files. will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Save Project, Simulation and Run''' &ndash; Exports the simulation files, saves the project and project files, and runs the simulation. Will bring up the ''Simulation Run Queue'' dialog.<br />
*'''Read Solution''' &ndash; Opens a browser to import the solution files.<br />
*'''Simulation Properties''' &ndash; Opens the ''Simulation Propertes'' dialog where basic information about the simulation can be viewed.<br />
The specific menu commands may be different depending on the selected option in the ''Preferences'' dialog.<br />
<br />
===TUFLOW FV Model Control===<br />
The ''TUFLOW FV Model Control'' dialog contains options for setting the parameters that will be used during the simulation run. The dialog is accessed by right-clicking on the simulation in the Project Explorer and selecting the '''Model Control''' command. The dialog contains multiple options organized on multiple tables. The options are as follows:<br />
====General====<br />
[[File:TUFLOWFV MC General.png|thumb|300 px|The ''General'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''General'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define spatial order'' &ndash; Option to define horizontal spatial scheme.<br />
**''Horizontal'' &ndash; Select "1st" order scheme or "2nd" order scheme.<br />
***"1st" &ndash; Sets the simulation to use a 1<sup>st</sup> order scheme. This can be used when there is not a significant difference between the results for 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's also generally used for the beginning stages of most model development.<br />
***"2nd" &ndash; Sets the simulation to use a 2<sup>nd</sup> order scheme. This is used when a significant difference is noticed between 1<sup>st</sup> and 2<sup>nd</sup> order schemes. It's usually tested in more advanced stages of model development. Fast-changing flow conditions or high gradients in conserved variables might warrant or necessitate use of this spatial scheme.<br />
*''Define display interval'' &ndash; Option to set the interval in seconds at which time step information will be displayed to the (log and terminal window??).<br />
**''Display interval'' &ndash; Sets the interval in seconds for the display of time step information.<br />
*''Define hardware solver'' &ndash; Option to enable computing through the CPU or the GPU. Can produce slight differences in results.<br />
**"CPU" &ndash; Calculations will use the "Central Processing Unit".<br />
**"GPU" &ndash; Calculations will use the "Graphical Processing Unit". Using GPU with TUFLOW<br />
***''Device ID'' &ndash; Option to select which GPU device is used for computers or GPUs with multiple CUDA enabled GPU cards. <br />
*''Warn on projection mismatch of GIS inputs'' &ndash; Sets the program to warn if GIS inputs are not all in the same projection.<br />
*''Tutorial model'' &ndash; (Allows simulation of the TUFLOW Tutorial Models without the need for a TUFLOW license.??)<br />
{{-}}<br />
<br />
====Time====<br />
[[File:TUFLOWFV MC Time.png|thumb|300 px|The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Time'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Simulation time''<br />
**''Use ISODate'' &ndash; Option to use ISODate format which requires data be input in the form dd/mm/yyyy HH:MM:SS. If left off, default time format is hours.<br />
**''Reference time'' &ndash; Will set simulation reference time. Times set for starting and ending have reference to this time. This can affect output times when processing and visualizing results from certain programs.<br />
**''Starting time'' &ndash; Will set simulation start time.<br />
**''Ending time'' &ndash; Will set simulation end time.<br />
*''Time step limits''<br />
**''CFL'' &ndash; Sets the Courant-Friedrichs-Lewy condition. ((This is a control number that gives the model...???)). Can be no larger than one since this is the theoretical stability limit. Often, inputting a value lower than one ensures greater model stability.<br />
**''Min time step(s)'' &ndash; Specifies minimum variable time step allowed according to CFL stability criterion.<br />
**''Max time step(s)'' &ndash; Specifies maximum variable time step allowed according to CFL stability criterion.<br />
{{-}}<br />
<br />
====Global parameters====<br />
[[File:TUFLOWFV MC Global.png|thumb|300 px|The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Global parameters'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define bottom drag model'' &ndash; Option to specify bottom drag model for the simulation. The bottom drag model will be used to describe bed boundary resistance in the simulation. The same bottom drag model will be used for every calculation that uses it.<br />
**''Method'' &ndash; Option to set bottom drag model to use "Manning" or "KS".<br />
***"Manning" &ndash; Uses the Manning model and requires a Manning's ''n'' coefficient<br />
****''Manning's n coefficient'' &ndash; Sets the Manning's ''n'' coefficient.<br />
***"KS" &ndash; Uses a model that assumes a log-law velocity profile and requires specification of a surface roughness length-scale.<br />
****''Nikuradse roughness'' &ndash; Sets the Nikuradse roughness for the bottom drag model.<br />
*''Horizontal mixing model'' &ndash; Defines horizontal mixing eddy viscosity calculation according to options in drop-down menu. ((In TUFLOW FV documentation it's called momentum mixing model??)).<br />
**"None" &ndash; Will not represent horizontal momentum mixing. <br />
**"Constant" &ndash; Option to globally define a specific constant eddy viscosity.<br />
***''Global horizontal eddy viscosity'' &ndash; Specifies the constant eddy viscosity for the entire simulation.<br />
**"Smagorinsky" &ndash; The horizontal eddy viscosity will be calculated according to the Smagorinsky model which sets the diffusivity proportional to the local strain rate. Requires specification of global horizontal eddy viscosity coefficient.<br />
***''Global horizontal eddy viscosity coefficient'' &ndash; Sets the Smagorinsky coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets for the entire simulation (??Is that what globally means) the limits for the horizontal eddy viscosity values. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
**"Wu" &ndash; The horizontal eddy viscosity will be calculated according to the Wu model. Requires specification of global horizontal eddy viscosity coefficient. ((Seems to be a wind stress model. Can't figure out what it has to do with the Horizontal Mixing model did it get included here by accident??))<br />
***''Global horizontal eddy viscosity'' &ndash; Sets the Wu coefficient for the horizontal mixing eddy viscosity calculation.<br />
***''Define global horizontal eddy viscosity limits'' &ndash; Sets the limits for the horizontal eddy viscosity values for the entire simulation. Only for use with Smagorinsky or Wu models.<br />
****''Minimum eddy viscosity'' &ndash; Sets the minimum horizontal eddy viscosity.<br />
****''Maximum eddy viscosity'' &ndash; Sets the maximum horizontal eddy viscosity.<br />
*''Define stability limits'' &ndash; Option to define the maximum acceptable values relevant for the model. If water level or velocity exceed the given values, the model will stop computations and give an error. This feature helps to identify a model with instabilities by recognizing unrealistic values that the model produces. Small anomalies and acceptable spikes in data values will not stop computations.<br />
**''Maximum water level'' &ndash; Sets maximum acceptable water level for the model.<br />
**''Maximum velocity'' &ndash; Sets maximum acceptable velocity for the model.<br />
{{-}}<br />
<br />
====Wind stress====<br />
[[File:TUFLOWFV MC Wind.png|thumb|300 px|The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Wind stress'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define wind model'' &ndash; Option to define the model used in calculating wind stress for any wind inputs in the simulation.<br />
**''Model'' &ndash; Drop-down menu with options for models that can be used to calculate wind stress.<br />
***"Wu" &ndash; Sets the wind stress model to the Wu model. Scales wind stress parameterisation based on wind speed.<br />
***"Constant" &ndash; Applies wind stress parameterisation using Bulk momentum transfer coefficient as in pre-2019 builds of TUFLOW.<br />
***"Kondo" &ndash; Applies a scaling factor ((for the wind stress parameters??)) using a single term.<br />
*''Define wind parameters'' &ndash; ((Sets the wind drag coefficients that the selected model will use to scale the wind stress parameterisation??)) Varies according to the wind model selected.<br />
**''Wa'' &ndash; ((??Wind speed in meters per second))<br />
**''Ca'' &ndash; <br />
**''Wb'' &ndash;<br />
**''Cb'' &ndash;<br />
**''Bulk momentum transfer coefficient'' &ndash; Sets the coefficient for the Constant wind stress model.<br />
**''Scale factor'' &ndash; Sets the scaling factor for the Kondo wind stress model.<br />
{{-}}<br />
<br />
====Geometry====<br />
[[File:TUFLOWFV MC Geometry.png|thumb|300 px|The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Geometry'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define global bed elevation limits'' &ndash; Option to apply bed elevation limits to the entire model. Bed elevations in the model that are outside the set limits will be set to the minimum or the maximum. (Does this change if certain materials are defined contrary to it??))<br />
**''Bed elevation minimum'' &ndash; Defines minimum bed elevation. ((Bed Elevations??Maybe just elevations)) in the model below this value will be set to this value.<br />
**''Bed elevation maximum'' &ndash; Defines maximum bed elevations. ((Bed Elevations??Maybe just elevations)) in the model above this value will be set to this value.<br />
*''Define cell wet/dry depths'' &ndash; Sets the depth limits that define certain attributes of cells in the model.<br />
**''Dry depth'' &ndash; Sets a minimum depth value below which the simulation drops a cell from calculations.<br />
**''Wet depth'' &ndash; Sets a minimum depth value below which the simulation sets a cell's momentum to zero.<br />
*''Z modifications'' &ndash; Options for adjusting and applying elevation data<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a row of elevation data to the ''Z modifications'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of elevation data from the ''Z modifications'' table.<br />
**[[File:Row-up.svg|pi|16 px]]'''Move up''' &ndash; Moves the selected row of elevation data to be above the row immediately above it.<br />
**[[File:Row-down.svg|pi|16 px]] '''Move down''' &ndash; Moves the selected row of elevation data to be below the row immediately below it.<br />
**''Type'' &ndash; Option to select which type of elevation input is desired on this row of data. The other columns in the table become active or inactive based on the type selected here.<br />
**''Set Zpts'' &ndash; Sets elevation values for the center of all cells in the model domain to the given value.<br />
**''GRID Zpts'' &ndash; Interpolates a grid file to set elevations for the mesh cell center. Select '''(none selected)''' to open a dialog box and select the desired grid file. Either .asc or .flt. can be used for this feature.<br />
**''CSV File'' &ndash; Option to update cell elevations using a .csv file. The .csv file can identify cells using x,y coordinates or cell IDs.<br />
**''CSV Type'' &ndash; Select which type of data the .csv file will contain.<br />
***"Cell ID" &ndash; Sets the program to read the .csv file data for cell IDs matched with elevation data. <br />
***"Coordinate" &ndash; Sets the program to read the .csv file data for x,y coordinates matched with elevation data.<br />
**''ZLine Shapes'' &ndash; Sets breakline features and polygon features according to an already imported .shp or .mif/.mid file. Select '''(none selected)''' to open a dialog and select the desired file (all RC sees is coverages here, but maybe they are the only things available. They don't seem like any of the described file types??).<br />
**''ZPoint Shapes'' &ndash; Sets elevation points according to an already imported .shp or .mif/.mid file. Using this feature, multiple layers of elevation information can be used. This allows for dividing the layers for better data management. Select '''(none selected)''' to open the ''Select Z Point Layers'' dialog.<br />
=====Select Z Point Layers=====<br />
[[File:TUFLOWFV MC Geometry Select Zpt Layers.png|thumb|200 px|The ''Select Z Point Layers'' dialog which opens when '''Select Z Point Layers...''' is clicked in the ''Geometry'' tab.]]<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Opens a dialog for selecting a file (??to define the Z point layer). Adds that layer to a new table row.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the active row of data.<br />
{{-}}<br />
<br />
====Initial conditions====<br />
[[File:TUFLOWFV MC Initial.png|thumb|300 px|The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Initial conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define initial water level'' &ndash; Option set water level to a constant value for the entire simulation. It's best for the water level boundary conditions for the initial time steps to be as close as possible to this setting.<br />
*''Use restart file'' &ndash; Option to use a restart file to define the initial conditions for the current run. The restart file must come from a model that uses the same mesh, bathymetry, vertical layering, and number of conserved variables as the model for the current simulation.<br />
**'''Select...''' &ndash; Opens dialog box for selecting restart file to be used.<br />
**''Use restart file time'' &ndash; Option to use the time stamp on the restart file as the starting time of the current run. On by default.<br />
{{-}}<br />
<br />
====Output====<br />
[[File:TUFLOWFV MC Output.png|thumb|300px|The ''Output'' tab of the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Output'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Output blocks'' &ndash; Output blocks set output file types as well as certain output file properties. They also allow for selecting desired datasets to be included in the output file and the time steps at which to output the information.<br />
**[[File:Row-add.svg|pi|16 px]] '''Add Row''' &ndash; Adds a output block to the ''Output blocks'' table.<br />
**[[File:Row-delete.svg|pi|16 px]] '''Delete Row''' &ndash; Deletes the selected output block from the ''Output blocks'' table.<br />
**"DATV" &ndash; SMS will give mapped output in DATV format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"XMDF" &ndash; SMS will give mapped output in XMDF format with user specified datasets and parameters. Often used for data visualization in SMS.<br />
**"NetCDF" &ndash; SMS will give mapped output in NetCDF (network Common Data Form) format with user specified datasets and parameters. Includes mapped output information at the desired time intervals as well as information about model geometry.<br />
**"Flux" &ndash; Outputs a CSV file that will give the values of fluid flow and, if applicable, the movement of other quantities that cross model boundaries or other specified nodestrings.<br />
**"Mass" &ndash; Outputs a CSV file that can be used to check certain simulated quantities, mainly the volume of fluid within the model domain. <br />
**"Points" &ndash; Outputs a CSV file containing model parameter time-series. This includes coordinates and associated data for the points of interest ((as defined in a coverage dedicated to this task.??))<br />
**"Transport" &ndash; Outputs a NetCDF file that can be used to improve the runtime of subsequent advection-diffusion, sediment, or particle tracking simulations. It stores conserved variables on the TUFLOW FV mesh for use in future simulations.<br />
<br />
*''Output block options - Row (value of active row)'' &ndash; Gives options to define attributes and datasets for a selected output block. Many options are only available when certain output blocks are selected. (See table below)<br />
**''Output points feature coverage'' &ndash; Only available when a "Points" output block is active. Click '''Select...''' to set the coverage that will define the coordinates of the desired output points<br />
**''Define Interval'' &ndash; Option to set the interval for the specified output in seconds. If not specified, the program will produce the specified output at every time step, sometimes resulting in output files that are too large.<br />
**''Define start time'' &ndash; Sets output request start time. When not specified, the output start time will be the simulation start time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define final time'' &ndash; Sets output request final time. When not specified, the output final time will be the simulation end time. Time format will be the same as format selected under the ''Time'' tab.<br />
**''Define compression'' &ndash; Option to compress output file.<br />
***''Compression on'' &ndash; If turned on, output file will be compressed. On by default.<br />
**''Define Statistics'' &ndash; Option to track minimum and/or maximum values of selected datasets.<br />
***''Type'' &ndash; Select the values to track from the drop-down menu.<br />
****"Both" &ndash; Both maximum and minimum values for selected datasets will be tracked.<br />
****"Minimums" &ndash; Only minimum values for selected datasets will be tracked. <br />
****"Maximums" &ndash; Only maximum values for selected datasets will be tracked.<br />
***''Define statistics dt'' &ndash; Option to define independent output interval for tracking of minimum and maximum values. If not defined, defaults to 0 and uses the model interval.<br />
**''Filename suffix'' &ndash; Option to specify a desired suffix for output file.<br />
**''Datasets'' &ndash; Specify datasets for inclusion in output file. This will only appear when a DATV, XMDF, NetCDF, or points output block is active. For more information, see the table below.<br />
*''Directories'' <br />
**''Log directory'' &ndash; Option to specify ((directory??)) for simulation log file (.log) output. When not specified, log file will be written to same location as simulation control file.<br />
**''Output directory'' &ndash; Option to specify location in which simulation output files will be written. When not specified, output files will be written to same location as simulation control file.<br />
**''Write restart file'' &ndash; TUFLOW FV writes the values of the selected datasets in each cell at desired regular time steps. Specify these time steps in ''Write restart dt''.<br />
***''Write restart dt'' &ndash; Specify the desired interval of time steps at which TUFLOW FV will write the restart file.<br />
***''Enable restart overwrite'' &ndash; Option to overwrite the restart file being used at the time interval specified in ''Write restart dt''. On by default.<br />
**''Write check files'' &ndash; Option to create a number of check files that can be used to verify model inputs.<br />
***''Check files directory'' &ndash;<br />
**''Write empty GIS files'' &ndash; Option to automatically create GIS template files in .mid/.mif or .shp format with recommended GIS naming conventions that "contain the correct GIS attributes".<br />
***''Template files directory'' &ndash; Sets the location in which the empty GIS files will be written.<br />
<br />
<br />
<br />
{| class="wikitable"<br />
!Category<br />
! scope="col" style="width: 250px;" | Output Block Options<br />
!Output blocks that use this option<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="8"|General<br />
|-<br />
|''Output points feature coverage''<br />
|Points<br />
|-<br />
|''Define interval''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport <br />
|-<br />
|''Define start time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define final time''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Define compression''<br />
|XMDF, NetCDF<br />
|-<br />
|''Define statistics''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|''Filename suffix''<br />
|DATV, XMDF, NetCDF, Flux, Mass, Points, Transport<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="20"|Datasets<br />
|''Water depth''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Water surface elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Surface shear stress''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity vector and magnitude''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Velocity magnitude only''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Bed elevation''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Turbulent viscosity''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Evaporation rate''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category based on the Australian NSW Flood plain management Manual (NSWG, 2005)''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Flood hazard category as outlined by Australian Emergency Management Institute in 2014'' <br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Hazard categories for the Queensland Reconstruction Authority''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Mean sea level pressure''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Downward short-wave radiation flux''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Temperatre''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''10 m wind speed vector''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave height'' &ndash; typically significant wave height<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave period'' &ndash; typically peak wave period<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave direction''<br />
|DATV, XMDF, NetCDF, Points<br />
|-<br />
|''Wave stress vector''<br />
|DATV, XMDF, NetCDF, Points<br />
<br />
|}<br />
<br />
<br />
====Materials====<br />
[[File:TUFLOWFV MC Material.png|thumb|300 px|The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Materials'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define default material (set mat)'' &ndash; ((??Sets the material settings for every cell in the model domain. This material and its attributes will be the assumed material for each cell ((unless a material block defines them otherwise??))<br />
**''Override Bottom Roughness'' &ndash; Select to allow for editing bottom roughness of this material.<br />
**''Bottom Roughness'' &ndash; Sets the default bottom roughness for the entire model. Will be factored in according to the bottom drag model selected on the ''Global parameters'' tab. <br />
**''Advanced Options'' &ndash; Select '''Advanced...''' to open the ''Materials (advanced) - Default material (set mat)'' dialog.<br />
=====Materials (advanced) - Default material (set mat)=====<br />
*''Define horizontal eddy viscosity'' &ndash; Option to adjust the horizontal eddy viscosity settings for this material. The input asked for here varies depending on the horizontal mixing model selected on the ''Global Parameters'' tab.<br />
**''Horizontal eddy viscosity'' &ndash; Sets the horizontal eddy viscosity for this material. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to "None" or "Constant".<br />
**''Horizontal eddy viscosity coefficient'' &ndash; Sets the coefficient for either the "Wu" or "Smagorinsky" mixing models, depending on the model selected on the ''Global Parameters'' tab. Only available when ''Horizontal mixing model'' under ''Global Parameters'' is set to ''Smagorinsky'' or ''Wu''.<br />
*''Define bed elevations limits'' &ndash; Option to set limits for the bed elevation of cells defined by this material.<br />
**''Minimum bed elevation'' &ndash; Sets minimum bed elevation.<br />
**''Maximum bed elevation'' &ndash; Sets maximum bed elevation.<br />
*''Spatial reconstruction'' &ndash; Option to limit spatial reconstruction (??for cells that are defined by the default material). This reverts the calculations for this area to first-order calculations in a model that is second-order. This has no effect if the model is already first order as defined in the ''General'' tab under ''Define spatial order''.<br />
[[File:TUFLOWFV MC Materials Advanced DM Set Mat.png|left|380px|The ''Materials (advanced) - Default material (set mat)'' dialog which opens when '''Advanced...''' is selected on the ''Materials'' tab.]]<br />
{{-}}<br />
<br />
====Boundary Conditions====<br />
[[File:TUFLOWFV MC Boundary Conditions.png|thumb|450px|The ''Boundary Conditions'' tab on the ''TUFLOWFV Model Control'' dialog.]]<br />
The ''Boundary conditions'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*''Define BC default update dt'' &ndash; Option to set the time step for all boundary conditions to update. If unspecified, TUFLOW FV will interpolate values to each time step. If specified, TUFLOW FV will keep all values after one update but before the next update at a constant value.<br />
**''BC default update dt'' &ndash; ((sets the time value of the time steps that TUFLOW FV will interpolate to??))<br />
*''Run in transport mode'' &ndash; Option to run a simulation that includes a transport boundary condition. This option can be useful for later models that use many of the same conditions but require different inputs.<br />
**''Transport BC file'' &ndash; Click '''Select...''' to set which transport file will be used in this simulation.<br />
*''Global boundaries'' &ndash; ((Boundary condition blocks that can be used to apply conditions to every cell in the model domain. For example, it can be used to account for inflow from rain or evaporation.<br />
**[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a boundary condition block that specifies conditions over the entire model domain.<br />
**[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the active global boundary condition block.<br />
**''Type'' &ndash; Shows the type of boundary condition assigned to this boundary condition block.<br />
**''Attributes''<br />
***'''Assign BC''' &ndash; Opens the ''Assign Global Boundary Condition'' dialog.<br />
*''Gridded boundaries'' &ndash; So are we applying multiple boundary conditions to the one grid? That's what's happening here??<br />
** [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a Gridded BC row to the ''Gridded boundaries'' table. Opens the ''Define BC Grid'' dialog.<br />
** [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes a Gridded BC row from the ''Gridded boundaries'' table.<br />
**''Grid Definition''<br />
***'''Define Grid...''' &ndash; Opens ''Define BC Grid'' dialog for selecting the grid and associated settings for selected grid definition block.<br />
**''Boundaries''<br />
***'''Define BCs...''' &ndash; Opens ''Add Gridded BCs'' dialog.<br />
*''Global wave options'' &ndash: Options for use if a linked Boundary Conditions coverage with a wave boundary type and/or a gridded wave boundary defined.<br />
**''Include wave stress'' &ndash;<br />
**''Include Stokes drift'' &ndash; Option to include Stokes drift in calculations ((Interpolates mass transport for cells between the deepwater and surfzone depth??))<br />
<br />
======Assign Global Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Global BC.png|thumb|450px|The ''Assign Global Boundary Condition'' dialog which opens when '''Assign BC''' is selected on the ''Boundary conditions'' tab.]]<br />
*''Options'' &ndash; <br />
**''Type'' &ndash; Sets which type of boundary condition to set globally for the model. The one option is "QG (Global Cell Inflow)".<br />
***"QG (Global Cell Inflow)" &ndash; Sets boundary condition as flow into every cell in model domain. Useful to account for effects of rain or evaporation.<br />
**''Subtype'' &ndash; Option to adjust how a boundary type functions numerically in the model.<br />
***"Sub-type 1" &ndash; The interior model concentration will be used to determine the scalar flux.<br />
***"Sub-type 2" &ndash; The value specified in the BC file will determine the scalar flux.<br />
**'''Define Curve...''' &ndash; Opens "BC Curve Editor" dialog.<br />
<br />
**''Define default'' &ndash; Defines default value for a given variable when TUFLOW FV gets a null-value from a boundary condition input.<br />
***''Q/A default'' &ndash;<br />
**''Define offset'' &ndash; Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale<br />
***''Q/A offset'' &ndash;<br />
**''Define scale'' &ndash; Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
***''Q/A scale'' &ndash;<br />
**''Define update increment'' &ndash; Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
***''Time'' &ndash; The value of the update intervals of time steps.<br />
**''Includes mean sea level pressure'' &ndash; Option to specify if an inverse barometer offset is already included in a water level boundary condition. By default, it is on to indicate there is an inverse barometer offset included. If turned off, the difference between the local MSLP and the reference MSLP will be applied at the boundary.<br />
<br />
======BC Curve Editor======<br />
<!--This is the only dialog that RC didn't upload an image for--><br />
*''Define reference time'' &ndash; <br />
**''Use ISODate'' &ndash;<br />
**''Reference time'' &ndash;<br />
*''Number of rows''<br />
*''Time Units''<br />
*'''Import...'''<br />
*''Time''<br />
*''Q/A''<br />
*[[File:Pan Tool.svg|16px]]'''Pan''' &ndash;<br />
<br />
=====Define BC Grid=====<br />
[[File:TUFLOWFV MC BC Define BC Grid.png|thumb|350px|The ''Define BC Grid'' dialog, which opens when '''Define Grid''' is selected in ''Boundary conditions'' tab.]]<br />
*''Grid Definition'' &ndash; Space for defining the location, filename, and settings for a NetCDF file that will be used to map input files to the model mesh.<br />
**''File'' &ndash; Click '''Select...''' to set the NetCDF file that contains the coordinates that define a grid. The gridded boundary conditions will be applied to this grid.<br />
**''Name'' &ndash; Name applied to the grid. Name might be used later to refer to this grid by other boundary conditions in this model.<br />
**''NetCDF variables'' &ndash; Sets the variables from the NetCDF file that the program should use to create the grid map.<br />
***''X-Variable'' &ndash; <br />
***''Y-Variable'' &ndash;<br />
***''Z-Variable'' &ndash;<br />
**''Define vertical coordinate type'' &ndash; Option to specify the vertical coordinate convention. The different convention names correspond to distinct kinds of depth averaging. <br />
***"Elevation" &ndash; [https://fvwiki.tuflow.com/index.php?title=Depth_Averaging_Results]. Here is the information. Not sure how to interpret it yet.<br />
***"Depth" &ndash;<br />
***"Sigma" &ndash;<br />
***"Height" &ndash;<br />
**''Cell gridmap'' &ndash; When turned off, (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Boundary gridmap'' &ndash; If on, calculates (I have found info for this, but do not yet know how to rephrase it.)<br />
**''Suppress coverage warnings'' &ndash; Will suppress warnings that indicate the grid does not cover the entire domain.<br />
<br />
=====Add Gridded BCs=====<br />
[[File:TUFLOWFV MC BC Add Gridded BC.png|thumb|300px|The ''Add Gridded BCs'' dialog which opens when '''Define BCs...''' is selected on the ''Boundary Conditions'' tab.]]<br />
This dialog allows for assigning ((??multiple boundary)) conditions to the one grid in the selected row??.<br />
* [[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Adds a gridded boundary condition block ((to the grid associated with the active grid block??))<br />
* [[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Deletes the selected gridded boundary condition block.<br />
*''Type'' &ndash; Shows the type of boundary condition grid assigned to this boundary condition block.<br />
*''Attributes'' &ndash; <br />
**'''Assign BC...''' &ndash; Opens ''Assign Gridded Boundary Condition'' dialog.<br />
<br />
<br />
======Assign Gridded Boundary Condition======<br />
[[File:TUFLOWFV MC BC Assign Gridded BC.png|thumb|300px|''Assign Gridded Boundary Condition'' dialog which opens when '''Assign BC...''' is selected in the ''Add Gridded BCs'' dialog.]]<br />
*''Options'' &ndash; TUFLOW Manual 15.4.4 BC Scale and BC Offset<br />
**''Type'' &ndash; Sets type of boundary condition to be used.<br />
***"MSLP_Grid" &ndash; Sets boundary condition type to mean sea level pressure field (grid??).<br />
***"W10_Grid" &ndash; Sets boundary condition type to wind velocity at 10m (grid??)) .<br />
***"Wave" &ndash; <br />
**''Dataset file'' &ndash; Opens dialog to select NetCDF file to define the data for the boundary condition.<br />
**'''Define Variables''' &ndash; Opens ''Select NetCDF Gridded BC Variable Names'' dialog.<br />
**For ''Define default'', ''Define offset'', ''Define scale'', ''Define reference time'', ''Define time units'', and ''Define update increment'', see table below.<br />
<br />
{| class="wikitable"<br />
!Grid Type<br />
!Option or Variable<br />
! scope="col" style="width: 550px;" | Definition<br />
|-<br />
|colspan="15"|<br />
----<br />
|-<br />
!rowspan="6" | All Grids<br />
|''Define default''<br />
|Defines default value for a given variable when a boundary condition input gives TUFLOW FV a null-value. <br />
|-<br />
|''Define offset''<br />
|Sets the offset that TUFLOW FV will add to each variable of raw boundary condition data as it is read into TUFLOW FV. Offset will be added to each variable after it is multiplied by the set scale.<br />
|-<br />
|''Define scale''<br />
|Sets the scale by which TUFLOW FV will multiply each variable of raw boundary condition data as it is read into TUFLOW FV. The data will be multiplied by the scale before the offset value for each variable is added.<br />
|-<br />
|''Define reference time''<br />
|Sets reference time for the boundary condition. When not set, the reference time will be the same as the simulation time. Option set reference time in hours, which is the default. Turn on ''Use ISODate'' to use that format if desired.<br />
|-<br />
|''Define time units''<br />
|Sets time units to be used for the boundary condition. The options are: <br />
*"Days"<br />
*"Hours"<br />
*"Minutes"<br />
*"Seconds"<br />
*"Isotime"<br />
|-<br />
|''Define update increment''<br />
|Sets update intervals of time steps for boundary conditions. When not set, TUFLOW FV will update the boundary condition at every simulation time step.<br />
|-<br />
!rowspan="1" | MSLP_Grid<br />
|''MSLP''<br />
|Mean sea level pressure<br />
|-<br />
!rowspan="2" | W10_Grid<br />
|''W10_X''<br />
|"10 m wind speed vector"<br />
|-<br />
|''W10_Y''<br />
|"10 m wind speed vector"<br />
|-<br />
!rowspan="8" | Wave<br />
|''HSIGN''<br />
|Significant wave height?? (In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)<br />
|-<br />
|''TPS''<br />
|Smoothed peak wave period<br />
|-<br />
|''DIR''<br />
|Mean wave direction. This is direction to which waves are heading when the <br />
|-<br />
|''UBOT''<br />
|The rms-value (root mean square value?) of the maxima of the orbital velocity near the bottom. If it is left undefined, TUFLOW FV will calculate it using linear wave theory.<br />
|-<br />
|''TMBOT''<br />
|The bottom wave period<br />
|-<br />
|''FORCE_X''<br />
|X wave induced force vector component (In TUFLOW FV documentation, it's usually called WFORCE_X except for in Table 15-3<br />
|-<br />
|''FORCE_Y''<br />
|Y wave induced force vector component (In TUFLOW FV documentation, it's usually called HSIG except for in Table 15-3.)<br />
|-<br />
|''DEPTH''<br />
|Wave model water depth<br />
|}<br />
<br />
======Select NetCDF Gridded BC Variable Names======<br />
[[File:TUFLOWFV MC BC Select NetCDF Gridded Variable Names.png|thumb|200px|The ''Select NetCDF Gridded BC Variable Names'' dialog which opens when '''Define Variables...''' is selected under the ''Assign Gridded Boundary Condition'' dialog. This dialog is for a "Waves" boundary condition type as selected on the ''Assign Gridded Boundary Condition'' dialog.]]<br />
*''Variable names'' &ndash; The variables that appear (other than TIME, which appears no matter which grid type is selected) will be exactly the same as the variables that appear in the ''Assign Gridded Boundary Condition'' dialog under ''Define default'', ''Define offset'', and ''Define scale''. It varies depending on the grid type selected.<br />
**''TIME variable name'' &ndash; (??Advanced option to select a ??header in the selected file for the TIME variable. Does this vary depending on what file you have selected? <!--Jeff, there's not much information, but it's on page 335 in Appendix F of TUFLOW FV manual--><br />
**Grid Specific variables<br />
***MSLP_GRID variables:<br />
****''MSLP variable name'' &ndash; Advanced option to select a header in the selected file for the MSLP variable.<br />
***W10_GRID variables:<br />
****''W10_X variable name'' &ndash; Advanced option to select a header in the selected file for the W10_X variable.<br />
****''W10_Y variable name'' &ndash; Advanced option to select a header in the selected file for the W10_Y variable.<br />
***Wave variables:<br />
****''HSIGN variable name'' &ndash; Advanced option to select a header in the selected file for the HSIGN variable.<br />
****''TPS variable name'' &ndash; Advanced option to select a header in the selected file for the TPS variable.<br />
****''DIR variable name'' &ndash; Advanced option to select a header in the selected file for the DIR variable.<br />
****''UBOT variable name'' &ndash; Advanced option to select a header in the selected file for the UBOT variable.<br />
****''TMBOT variable name'' &ndash; Advanced option to select a header in the selected file for the TMBOT variable.<br />
****''FORCE_X variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_X variable.<br />
****''FORCE_Y variable name'' &ndash; Advanced option to select a header in the selected file for the FORCE_Y variable.<br />
****''DEPTH variable name'' &ndash; Advanced option to select a header in the selected file for the DEPTH variable.<br />
<br />
====Simulation links====<br />
[[File:TUFLOWFV MC Simulationlinks.png|thumb|300 px|The ''Simulation Links'' tab of the ''TUFLOW FV Model Control'' dialog]]<br />
The ''Simulation links'' tab of the ''TUFLOW FV Model Control'' dialog contains the following options:<br />
*[[File:Row-add.svg|pi|16 px]]'''Add row''' &ndash; Brings up the ''Select Child TUFLOW FV Simulation'' dialog. In this dialog another TUFLOW FV simulation can be select to link as a child simulation to the current simulation.<br />
*[[File:Row-delete.svg|pi|16 px]]'''Delete row''' &ndash; Unlinks the selected simulation.<br />
{{-}}<br />
<br />
====Advanced====<br />
The ''Advanced'' tab of the ''TUFLOW FV Model Control'' dialog contains the option to include advanced options These options can be added in the text editor located in this tab. The text will be appended to the FVC file with the simulation is exported.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
<!--Obsolete<br />
== TUFLOW FV ENGINE ==<br />
The TUFLOW computational engine computes 2D hydraulic solutions. The engine uses a macro style text-file input which allows the user to flexibly and efficiently control model configurations and simulations.<br />
<br />
For more information see the [http://www.tuflow.com/Tuflow%20FV.aspx TUFLOW FV webpage].<br />
<br />
== SMS Interface ==<br />
The TUFLOW FV engine is interfaced in SMS through the [[SMS:Generic Model Graphical Interface|generic model interface]].<br />
<br />
===TUFLOW FV Menu===<br />
If the TUFLOW FV model paremeters have been correctly loaded into SMS, the ''TUFLOW FV'' menu is available when the Mesh module is active. The menu has the following commands:<br />
*'''Check Mesh''' &ndash; Performs a general model check and will bring up the [[SMS:Model Checker|''Model Checker'']] dialog if errors are found.<br />
*'''Define Model''' &ndash; Opens the model definitions. This is only accessible to the TUFLOW FV model developers.<br />
*'''Global Parameters''' &ndash; Brings up the ''TUFLOW FV Global Parameters'' dialog where parameters for the model run are specified.<br />
*'''Assign BC''' &ndash; Brings up the ''TUFLOW FV Nodestring Boundary Conditions'' dialog. Available when a boundary nodestring is selected.<br />
*'''Material Properties''' &ndash; Brings up the ''TUFLOW FV Material Properties'' dialog.<br />
*'''Run TUFLOW FV''' &ndash; Launches the TUFLOW FV model run.<br />
<br />
==Using the Model / Practical Notes==<br />
A TUFLOW licence is not required to run a TUFLOW FV model.<br />
--><br />
==External Links==<br />
*[http://www.tuflow.com/Download/TUFLOW_FV/Manual/FV-UserManual-2014.01.pdf TUFLOW FV Manual]<br />
*[http://fvwiki.tuflow.com/index.php?title=Main_Page TUFLOW FV Wiki]<br />
<br />
<br />
{{Template:Navbox SMS}}<br />
<br />
[[Category:SMS 2D Mesh|TUFLOW]]<br />
[[Category:TUFLOW|FV]]<br />
[[Category:Generic Interface]]<br />
[[Category:External Links]]<br />
[[Category:Needs Update]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Thalweg_dialog.png&diff=157001File:WMS GSSHA Thalweg dialog.png2022-11-03T18:33:31Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Thalweg dialog.png</p>
<hr />
<div>''GSSHA Thalweg'' dialog in WMS.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:Smooth_GSSHA_Streams_dialog.png&diff=157000File:Smooth GSSHA Streams dialog.png2022-11-03T18:24:06Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:Smooth GSSHA Streams dialog.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
The smooth GSSHA streams dialog</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:GSSHA_Solution_Data.jpg&diff=156999File:GSSHA Solution Data.jpg2022-11-03T18:19:35Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:GSSHA Solution Data.jpg</p>
<hr />
<div>[[Category:GSDA]]<br />
[[Category:GSSHA]]<br />
[[Category:Plots]]<br />
<br />
GSSHA Solution Data dialog</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Solution_Analysis_dialog.png&diff=156998File:WMS GSSHA Solution Analysis dialog.png2022-11-03T16:00:53Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Solution Analysis dialog.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
GSSHA Solution Analysis dialog.</div>Rcorriganhttps://www.xmswiki.com/index.php?title=Template:Advective_Time_Step&diff=156993Template:Advective Time Step2022-11-01T18:09:16Z<p>Rcorrigan: </p>
<hr />
<div>__NOINDEX__<br />
__NOTOC__<br />
===Advective Time Step===<br />
<!--====Tool description====--><br />
The time step tool is intended to assist in the selection of a time step for a numerical simulation that is based on the Courant number calculation.<br />
This tool can be thought of as the inverse of the Advective Courant Number tool. Refer to that documentation of the Adventive Courant Number tool for clarification.<br />
The objective of this tool is to compute the time step that would result in the specified Courant number for the given mesh and velocity field. The user would then select a time step for analysis that is at least as large as the maximum value in the resulting times step dataset.<br />
The tool computes the time step at each node in the selected geometry <br />
<br />
:<math>{\displaystyle TimeStep =CourantNumber*NodalSpacing/Velocity}</math><br />
<br />
If the input velocity dataset is transient, the time step tool will create a transient dataset.<br />
<br />
Typically, the Courant number specified for this computation is <= 1.0 for Courant limited solvers. Some solvers maintain stability for Courant numbers up to 2 or some solver specific threshold.<br />
Specifying a Courant number below the maximum threshold can increase stability since the computation is approximate.<br />
<br />
====Input Parameters====<br />
*''Input dataset'' &ndash; Specify which velocity dataset will be used to represent particle velocity magnitude.<br />
*''Use courant number'' &ndash; Enter the threshold Courant value (or a number lower than the threshold for additional stability).<br />
<br />
====Output Parameters====<br />
*''Advective time step dataset'' &ndash; Enter the name for the new dataset which will represent the maximum time step. (Suggestion: specify a name that references the input. Typically this would include the Courant number used in the calculation. The velocity dataset used could be referenced. The geometry is not necessary because the dataset resides on that geometry.)<br />
<br />
====Current Location in Toolbox==== <br />
Datasets/Advective Time Step<br />
<br />
====Related Tools====<br />
* [[Advective Courant Number Tool|Advective Courant Number]]<br />
* [[Gravity Waves Time Step Tool|Gravity Waves Time Step]]<br />
<br />
<noinclude>[[Category:Tools]]</noinclude></div>Rcorriganhttps://www.xmswiki.com/index.php?title=Template:Gravity_Waves_Courant_Number&diff=156992Template:Gravity Waves Courant Number2022-11-01T18:08:06Z<p>Rcorrigan: </p>
<hr />
<div>__NOINDEX__<br />
__NOTOC__<br />
===Gravity Waves Courant Number===<br />
The Courant number is a spatially varied (dataset) dimensionless value representing the time a particle stays in a cell of a mesh/grid. This is based on the size of the element and the speed of that particle.<br />
A Courant number of 1.0 implies that a particle(parcel or drop of water) would take one time step to flow through the element. Since cells/elements are not guaranteed to align with the flow field, this number is an approximation. This dataset is computed at nodes so it is uses the average size of the cells/elements attached to the node. Since the typical Courant number calculation requires as an input a velocity as shown in the equation below:<br />
<!--<br />
The toolbox includes a tool for calculating the Courant number given the time step.<br />
:Note: the variable here is depth, not elevation. For applications relative to mean sea level, using the negative of the elevation relative to a datum is acceptable, but if the water level will vary, the depth is actually the water level minus the ground elevation.--><br />
:<math>{\displaystyle CourantNumber=TimeStep*(Gravity*Depth)^{0.5}/NodalSpacing}</math><br />
:*Time Step: a user specified constant<br />
:*NodalSpacing: dependent on the computational grid/mesh<br />
:*Velocity: typically computed by hydrodynamic simulation<br />
<br />
As noted above, the velocity is typically output from a simulation, so this tool approximates velocity based on the speed of a gravity wave through the water column.<br />
<br />
The speed of wave propagation is dependent on the depth of the water column. For purposes of this tool, the speed is assumed to be:<br />
:<math>Velocity = TimeStep*(Gravity*Depth)^{0.5}</math><br />
<br />
:Note: the variable in the equation above is "Depth", not "Elevation".<br />
Depth is also typically output from a hydrodynamic simulation. For this tool it can be approximated as:<br />
:<math>Depth = Max(WaterLevel - GroundElevation, Minimum Depth)</math><br />
For coastal applications the water level can be assumed as 0.0 (Mean Sea Level) or a constant offset from MSL.<br />
<br />
For riverine applications the water level is more difficult to approximate. It may require computing a sloped plane. In this case, negative values should be filtered out.<br />
<br />
In all cases, the depth should be truncated to a minimum value. Velocity only exists in a water column with positive depth.<br />
<br />
The tool computes the Courant number at each node in the selected geometry based on the specified time step.<br />
<br />
If the input velocity magnitude dataset is transient, the resulting CourantNumber dataset will also be transient.<br />
<br />
For numerical solvers that are Courant limited/controlled, any violation of the Courant condition, where the Courant number exceeds the allowable threshold could result in instability.<br />
Therefore, the maximum of the Courant number dataset gives an indication of the stability of this mesh for the specified time step parameter.<br />
<br />
This tool is intended to assist with numerical engine stability, and possibly the selection of an appropriate time step size.<br />
<br />
The ''Gravity Waves Courant Number'' tool dialog has the following options:<br />
====Input Paramters====<br />
*''Input dataset'' &ndash; This is a required input parameter. Specify which velocity dataset will be used to represent particle velocity magnitude.<br />
*''Gravity'' &ndash; Enter the gravity value. <br />
*''Use time step'' &ndash; Enter the computational time step value.<br />
====Output Parameters====<br />
*''Gravity waves time step dataset'' &ndash; Enter the name for the new gravity wave Courant number dataset. It is recommended to specify a name that references the input. Typically this would include the time step used in the calculation. The velocity dataset used could be referenced. The geometry is not necessary because the dataset resides on that geometry.<br />
<br />
====Related Topics====<br />
* [[Advective Courant Number Tool|Advective Courant Number]]<br />
<br />
<noinclude>[[Category:Tools]]</noinclude></div>Rcorriganhttps://www.xmswiki.com/index.php?title=Template:Advective_Courant_Number&diff=156991Template:Advective Courant Number2022-11-01T18:06:31Z<p>Rcorrigan: </p>
<hr />
<div>__NOINDEX__<br />
__NOTOC__<br />
===Advective Courant Number===<br />
<!--====Tool Description====--><br />
The Courant number is a spatially varied (dataset) dimensionless value representing the time a particle stays in a cell of a mesh/grid. This is based on the size of the element and the speed of that particle.<br />
A Courant number of 1.0 implies that a particle(parcel or drop of water) would take one time step to flow through the element.<br />
Since cells/elements are not guaranteed to align with the flow field, this number is an approximation.<br />
This dataset is computed at nodes so it is uses the average size of the cells/elements attached to the node. (If the future we could have a cell based tool that computes the Courant number for the cell, but this is still an approximate number based on the direction.)<br />
<br />
The advective courant number makes use of a velocity dataset that represents the velocity magnitude field on the desired geometry.<br />
The tool computes the Courant number at each node in the selected geometry based on the specified time step.<br />
:<math>{\displaystyle CourantNumber=TimeStep*Velocity/NodalSpacing}</math><br />
<br />
If the input velocity magnitude dataset is transient, the resulting <math>{\displaystyle CourantNumber}</math> dataset will also be transient.<br />
<br />
For numerical solvers that are Courant limited/controlled, any violation of the Courant condition, where the Courant number exceeds the allowable threshold could result in instability.<br />
Therefore, the maximum of the Courant number dataset gives an indication of the stability of this mesh for the specified time step parameter.<br />
<br />
This tool is intended to assist with numerical engine stability, and possibly the selection of an appropriate time step size.<br />
<br />
====Input Parameters====<br />
*''Input dataset'' &ndash; Specify which velocity dataset will be used to represent particle velocity magnitude.<br />
*''Use timestep'' &ndash; Enter the computational time step value.<br />
<br />
====Output Parameters====<br />
*''Advective courant number dataset'' &ndash; Enter the name for the new dataset which will represent the Courant number. (Suggestion: specify a name that references the input. Typically this would include the time step used in the calculation. The velocity dataset used could be referenced. The geometry is not necessary because the dataset resides on that geometry.)<br />
<br />
====Current Location in Toolbox==== <br />
Datasets/Advective Courant Number<br />
<br />
====Related Tools====<br />
* [[Advective Time Step Tool|Advective Time Step]]<br />
* [[Gravity Waves Courant Number Tool|Gravity Waves Courant Number]]<br />
<br />
<noinclude>[[Category:Tools]]</noinclude></div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Observations_dialog.png&diff=156983File:WMS GSSHA Observations dialog.png2022-10-31T22:39:49Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Observations dialog.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
[[Category:Observations]]<br />
<br />
GSSHA Observations dialog.</div>Rcorriganhttps://www.xmswiki.com/index.php?title=Template:Gravity_Waves_Courant_Number&diff=156982Template:Gravity Waves Courant Number2022-10-31T22:08:09Z<p>Rcorrigan: </p>
<hr />
<div>__NOINDEX__<br />
__NOTOC__<br />
===Gravity Waves Courant Number===<br />
The Courant number is a spatially varied (dataset) dimensionless value representing the time a particle stays in a cell of a mesh/grid. This is based on the size of the element and the speed of that particle.<br />
A Courant number of 1.0 implies that a particle(parcel or drop of water) would take one time step to flow through the element. Since cells/elements are not guaranteed to align with the flow field, this number is an approximation. This dataset is computed at nodes so it is uses the average size of the cells/elements attached to the node. Since the typical Courant number calculation requires as an input a velocity as shown in the equation below:<br />
<!--<br />
The toolbox includes a tool for calculating the Courant number given the time step.<br />
:Note: the variable here is depth, not elevation. For applications relative to mean sea level, using the negative of the elevation relative to a datum is acceptable, but if the water level will vary, the depth is actually the water level minus the ground elevation.--><br />
:<math>{\displaystyle CourantNumber=TimeStep*(Gravity*Depth)^{0.5}/NodalSpacing}</math><br />
:*Time Step: a user specified constant<br />
:*NodalSpacing: dependent on the computational grid/mesh<br />
:*Velocity: typically computed by hydrodynamic simulation<br />
<br />
As noted above, the velocity is typically output from a simulation, so this tool approximates velocity based on the speed of a gravity wave through the water column.<br />
<br />
The speed of wave propagation is dependent on the depth of the water column. For purposes of this tool, the speed is assumed to be:<br />
:<math>Velocity = TimeStep*(Gravity*Depth)^{0.5}</math><br />
<br />
:Note: the variable in the equation above is "Depth", not "Elevation".<br />
Depth is also typically output from a hydrodynamic simulation. For this tool it can be approximated as:<br />
:<math>Depth = Max(WaterLevel - GroundElevation, Minimum Depth)</math><br />
For coastal applications the water level can be assumed as 0.0 (Mean Sea Level) or a constant offset from MSL.<br />
<br />
For riverine applications the water level is more difficult to approximate. It may require computing a sloped plane. In this case, negative values should be filtered out.<br />
<br />
In all cases, the depth should be truncated to a minimum value. Velocity only exists in a water column with positive depth.<br />
<br />
The tool computes the Courant number at each node in the selected geometry based on the specified time step.<br />
<br />
If the input velocity magnitude dataset is transient, the resulting CourantNumber dataset will also be transient.<br />
<br />
For numerical solvers that are Courant limited/controlled, any violation of the Courant condition, where the Courant number exceeds the allowable threshold could result in instability.<br />
Therefore, the maximum of the Courant number dataset gives an indication of the stability of this mesh for the specified time step parameter.<br />
<br />
This tool is intended to assist with numerical engine stability, and possibly the selection of an appropriate time step size.<br />
<br />
The ''Gravity Waves Courant Number'' tool dialog has the following options:<br />
====Input Paramters====<br />
*''Input dataset'' &ndash; This is a required input parameter. Specify which velocity dataset will be used to represent particle velocity magnitude.<br />
*''Gravity'' &ndash; Enter the gravity value. <br />
*''Use time step'' &ndash; Enter the computational time step value.<br />
====Output Parameters====<br />
*''Gravity waves time step dataset'' &ndash; Enter the name for the new gravity wave Courant number dataset. It is recommended to specify a name that references the input. Typically this would include the time step used in the calculation. The velocity dataset used could be referenced. The geometry is not necessary because the dataset resides on that geometry.<br />
<br />
====Related Topics====<br />
* [[Template:Advective Courant Number|Advective Courant Number]]<br />
<br />
<noinclude>[[Category:Tools]]</noinclude></div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:Dialog_GSSHA_Overland_Soil_Erosion.png&diff=156979File:Dialog GSSHA Overland Soil Erosion.png2022-10-25T22:52:55Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:Dialog GSSHA Overland Soil Erosion.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
GSSHA Overland Soil Erosion dialog</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_Define_GSSHA_Observation_dialog.png&diff=156978File:WMS Define GSSHA Observation dialog.png2022-10-25T22:46:56Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS Define GSSHA Observation dialog.png</p>
<hr />
<div>Define GSSHA Observation dialog.<br />
<br />
[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
[[Category:Observations]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:MappingCalibParams.jpg&diff=156977File:MappingCalibParams.jpg2022-10-25T22:26:50Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:MappingCalibParams.jpg</p>
<hr />
<div>[[Category:Calibration]]<br />
[[Category:GSSHA]]<br />
<br />
''GSHHA Map Table Editor''.<br />
<br />
[[Category:GSSHA Dialogs]]<br />
[[Category:Calibration Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:ParameterKeyValues.png&diff=156976File:ParameterKeyValues.png2022-10-25T22:22:55Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:ParameterKeyValues.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
''Paramters'' dialog for key values.</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Nutrients_dialog_Uniform_Properties_tab.png&diff=156975File:WMS GSSHA Nutrients dialog Uniform Properties tab.png2022-10-25T22:13:53Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Nutrients dialog Uniform Properties tab.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
Nutrients dialog showing the Uniform Properties tab.</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Nutrients_dialog_Other_tab.png&diff=156974File:WMS GSSHA Nutrients dialog Other tab.png2022-10-25T22:13:05Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Nutrients dialog Other tab.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
Nutrients dialog showing the Other tab.</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:GSSHA_Nutrients_dialog_Non-Point_Sources_tab.png&diff=156973File:GSSHA Nutrients dialog Non-Point Sources tab.png2022-10-25T22:10:44Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:GSSHA Nutrients dialog Non-Point Sources tab.png</p>
<hr />
<div>GSSHA ''Nutrients'' dialog showing the ''Non-Point Sources'' tab.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:GSSHA_Nutrients_dialog_Point_Sources_tab.png&diff=156972File:GSSHA Nutrients dialog Point Sources tab.png2022-10-25T22:09:19Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:GSSHA Nutrients dialog Point Sources tab.png</p>
<hr />
<div>GSSHA ''Nutrients'' dialog showing the ''Point Sources'' tab.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_Project_Explorer_with_two_GSSHA_simulations.png&diff=156971File:WMS Project Explorer with two GSSHA simulations.png2022-10-25T19:52:22Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS Project Explorer with two GSSHA simulations.png</p>
<hr />
<div>[[Category:GSDA]]<br />
[[Category:Project Explorer Images]]<br />
[[Category:Changing Icons]]<br />
<br />
GSSHA in the project explorer in WMS</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_Save_and_Run_GSSHA_Group_dialog.png&diff=156970File:WMS Save and Run GSSHA Group dialog.png2022-10-25T19:49:41Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS Save and Run GSSHA Group dialog.png</p>
<hr />
<div>''Save and Run GSSHA Group'' dialog in WMS.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_Save_GSSHA_Group_dialog.png&diff=156969File:WMS Save GSSHA Group dialog.png2022-10-25T19:47:45Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS Save GSSHA Group dialog.png</p>
<hr />
<div>''Save GSSHA Group'' dialog in WMS.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Select_File_Format_dialog.png&diff=156964File:WMS GSSHA Select File Format dialog.png2022-10-25T19:03:58Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Select File Format dialog.png</p>
<hr />
<div>GSSHA ''Select File Format'' dialog in WMS.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Import_Index_Map_dialog.png&diff=156963File:WMS GSSHA Import Index Map dialog.png2022-10-25T19:02:23Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Import Index Map dialog.png</p>
<hr />
<div>GSSHA ''Import Index Map'' dialog in WMS.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_index_map_file_export_File_Formats_dialog.png&diff=156962File:WMS GSSHA index map file export File Formats dialog.png2022-10-25T19:01:22Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA index map file export File Formats dialog.png</p>
<hr />
<div>GSSHA index map file export ''File Formats'' dialog in WMS.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_Reclassify_Index_Map_Dialog.png&diff=156961File:WMS Reclassify Index Map Dialog.png2022-10-25T18:59:19Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS Reclassify Index Map Dialog.png</p>
<hr />
<div>''Reclassify Index Map'' dialog in WMS.<br />
<br />
[[Category:GSSHA Dialogs]]</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Maps_dialog_Continuous_Grid_tab.png&diff=156960File:WMS GSSHA Maps dialog Continuous Grid tab.png2022-10-25T18:58:12Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Maps dialog Continuous Grid tab.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
GSSHA Maps dialog showing the Continuous – Grid tab</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Maps_dialog_Index_Stream_tab.png&diff=156958File:WMS GSSHA Maps dialog Index Stream tab.png2022-10-25T18:57:36Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Maps dialog Index Stream tab.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
GSSHA Maps dialog showing the Index – Stream tab</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:WMS_GSSHA_Maps_dialog_Index_Grid_tab.png&diff=156956File:WMS GSSHA Maps dialog Index Grid tab.png2022-10-25T18:57:03Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:WMS GSSHA Maps dialog Index Grid tab.png</p>
<hr />
<div>[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]<br />
<br />
GSSHA Maps dialog showing the Index – Grid tab</div>Rcorriganhttps://www.xmswiki.com/index.php?title=File:GSSHA_Map_Table_Editor_dialog_Groundwater_tab.png&diff=156953File:GSSHA Map Table Editor dialog Groundwater tab.png2022-10-25T18:52:36Z<p>Rcorrigan: Rcorrigan uploaded a new version of File:GSSHA Map Table Editor dialog Groundwater tab.png</p>
<hr />
<div>''GSSHA Map Table Editor'' dialog showing the ''Groundwater'' tab.<br />
<br />
[[Category:GSSHA]]<br />
[[Category:GSSHA Dialogs]]</div>Rcorrigan