SMS:TUFLOW Project Workflow

This is a top level workflow. This workflow includes all of the specific workflows needed in creating a general 2D TUFLOW project. Newer and infrequent SMS users should start here.

To build a TUFLOW model in SMS, use the following steps:

1. Start SMS.
1. Start SMS, or clear existing projects in SMS. If SMS is already running, select File | Delete All. A new project can also be started by using CTRL + N. 2. Set the display projection. Select the Display | Projection... command. Set the horizontal and vertical projection using the Display Projection dialog.

2. Import data.

1. Gather and open image files. Images are imported into the GIS module in SMS. 1. Open local images. Load images from local computer files using the File | Open... command. Alternatively, drag and drop the file into the Graphics Window in SMS. 2. Import images from the web. 1. Import static images. Use the File | Import from Web command. Select a location in the Virtual Map Locator. Set a projection for the project using the Display Projections dialog. Use the Data Service Options dialog to select a web service or catalog. Use the Advanced options if needing to access a unique or unavailable data source. Save the data file and import the data into SMS. 2. Import dynamic images. Use the File | Add Online Maps command. Select a location in the Virtual Map Locator. Set a projection for the project using the Display Projections dialog. Use the Data Service Options dialog to select a web service or catalog. Save the data file and import the data into SMS. 2. Gather and open geometric data files. 1. Import map data. Use the File | Open... command to import map data such as Map files, boundary ID files, or boundary XY files. Alternately, drag and drop the file into the Graphics Window in SMS. 2. Import GIS data. Use the File | Open... command to import GIS data files such as Shapefiles, MIF/MID files, Lidar files, or raster files. Alternatively, drag and drop the file into the Graphics Window in SMS. 3. Import scatter data. Use File | Open... to open files with scatter data such as scatter point files, ASCII dataset files, binary dataset files, tabular data files, or XYZ files. Alternatively, drag and drop the file into the Graphics Window in SMS. Use the File Import Wizard to specify how to import the data. 4. Import CAD data. Verify the CAD file type is readable by SMS before importing it. SMS can import DXF and DWG files. Use the File | Open... command to launch the Open dialog (or drag and drop) to import the CAD files. The data should load in layers into the Project Explorer. 5. Review and set object projections. Right-click on an object in the Project Explorer and select the Projection command. Set the horizontal and vertical projection using the Object Projection dialog. To set a global projection, use the Horizontal Projection dialog.

3. Review and edit elevation data.

1. Review elevation data for errors. 1. Use the Dataset Info dialog. Find the "Z", "elevation" or "depth" datasets on the geometric object (mesh, TIN, grid, raster) that is being reviewed Right-click on elevation data and select Info. Review information in the Dataset Info dialog to see that the range of values are as expected. 2. Use contour display options. Turn off Points and Triangles, then turn on Contours in the Scatter tab of the Display Options dialog. Set contour options in the Contours tab. The "Color Fill" option is recommended for this. Look for inconsistent points (points with values much higher/lower than their neighbors or regions where no data points exist). Verify that the region being modeled is covered by the elevation/depth data and there are no holes. 3. Rotate the elevation data. Use the Rotate tool to examine the elevation data from different angles. 2. Remove erroneous points and triangles. After reviewing the imported data, points or triangles covering regions where there are no data points should be deleted. This could include outlier points or thin triangles. 1. Use the Scatter Options dialog. Open the Scatter Options dialog. Select or delete duplicate points. Select or delete long triangles. Select thin triangles. Use a triangulation optimization option. 2. Manually remove points. Use Select Scatter Point tool to select erroneous points in the scatter set. Review and edit point data in the Edit Window. Delete erroneous points. 3. Add breaklines. Select the Create Breakline tool. Click along points of a common elevation, such as at a bank toe or levee crest, to connect these points in the surface. Use the Backspace key to back up if an erroneous selection is made. Double-click or press Enter key to complete the breakline. 4. Merge elevation datasets. Select the Scatter | Merge Sets command. Use the Merge Scatter Sets dialog to select elevation data to be merged.

4. Define model limits (domain).

1. Generate a TUFLOW 2D Grid Extents coverage in the map module. Create a new coverage with the TUFLOW "2D Grid Extrents" type. 1. Create new coverage from scratch. Select Map Data in the Project Explorer and use the New Coverage right-click command. Use the New Coverage dialog to create a new coverage by selecting the desired coverage type, and naming the coverage. 2. Create new coverage from an existing coverage. Use the Duplicate command on an existing coverage. This will copy any feature objects on the coverage. Use the Rename command to give the coverage a new name. Change the coverage type. 2. Create arcs to define grid limits and notable features (banklines, structures, piers, road embankments, etc.). 1. Create feature arcs, nodes and vertices. In the Map module, create feature objects in the active coverage. Use the Create Feature Arc tool to create arcs in the map coverage. Begin creating a new arc by clicking in the Graphics Window at either arc end. If clicking on an existing feature node, vertex or arc, the new arc will snap to that object. Double-click or press the Enter key to terminate the arc. Use the Create Feature Node tool to create additional nodes alone or to split arcs. 2. Modify arcs. Feature arcs often need to be edited after initial creation. 1. Create additional vertices on arcs. Use the Create Feature Vertex tool to add vertices along arcs. 2. Refine the arc shape. Use the Select Feature Vertex tool and the Select Feature Node tool to move/edit existing arcs and refine the shape by dragging the nodes/vertices. Use the Select Feature Arc tool to move entire arcs . 3. Split arcs. An existing arc can be split by: 1. Converting a vertex to a node. Use the Select Feature Vertex tool and right-click on a vertex along an arc. Select the Convert to Node command to split the arc into two arcs. 2. Add a node the arc. Use the Create Feature Node tool to add a node on an arc in order to split it into two arcs. 3. Add a new connecting arc. Use the Create Feature Arc tool to start or end a new arc on an existing arc to split the existing arc into two arcs. 4. Use the Split Arcs Tool. Right-click on an arc using the Select Feature Arc tool and select the Split Arc(s)... command. Use the Split Arcs Tool to divide arcs. 5. Split overlapping arcs using the Clean Options dialog. Select overlapping arcs using the Select Feature Arc tool. Use the Feature Objects | Clean command to bring up the Clean Options dialog. Select the Intersect selected arcs option (for selected arcs) or Intersect arcs option (for all overlapping arcs) to split the arcs. 4. Merge arcs. Two arcs that share an end node can be merged together. Select the shared node using the Select Feature Node tool. Right-click on the node and select the Convert to Vertex command to merge the arcs. If desired, the Select Feature Vertex tool can be used to select and delete the new vertex. 5. Smooth arcs. The variability or roughness of an arc can be reduced. Right-click on an arc using the Select Feature Arc tool and select the Smooth Arc(s)... command. Use the Smooth Arcs Tool to reduce the variability of the arc. 6. Prune arcs. Concave sections of the arc can be removed. Right-click on an arc using the Select Feature Arc tool and select the Prune Arc(s)... command. Use the Prune Arcs dialog to remove concave sections. 7. Extend/trim arcs. Extend or shorten an arc to match an existing arc's length. Using the Select Feature Arc tool, select two intersecting arcs. Right-click on an arc using the Select Feature Arc tool and select the Extend/Trim Arc... command. Use the Trim/Extend Arc dialog to select the target arc and source arc. 3. Build polygons for enclosed arcs. Polygons are not created automatically when arcs are enclosed. To create polygons: Use the Feature Objects | Build Polygons command.

5. Generate grid.

1. Create grid frame. With the TUFLOW 2D Grid Extents coverage active, do the following: Use the Create 2D Grid Frame tool to define a the grid frame. Using the Select 2D Grid Frame tool, double-click on the grid frame. In the Grid Frame Properties dialog, edit the grid frame properties and assign elevation data. 2. Convert coverage to 2D Grid. Right-click on the TUFLOW Grid Extants coverage and select the Convert | Map → 2D Grid command. In the Grid Frame Properties dialog, review the grid frame properties and assigned elevation data.

6. Set up boundary conditions.

1. Create a TUFLOW 1D/2D BCs and Links coverage. Create a new map coverage with the TUFLOW "1D/2D BCs and Links" type. 1. Create new coverage from scratch. Select Map Data in the Project Explorer and use the New Coverage right-click command. Use the New Coverage dialog to create a new coverage by selecting the desired coverage type, and naming the coverage. 2. Create new coverage from an existing coverage. Use the Duplicate command on an existing coverage. This will copy any feature objects on the coverage. Use the Rename command to give the coverage a new name. Change the coverage type. 2. Create boundary condition feature objects. Create arcs, nodes, and polygons for use in defining boundary conditions. 1. Create feature arcs, nodes and vertices. In the Map module, create feature objects in the active coverage. Use the Create Feature Arc tool to create arcs in the map coverage. Begin creating a new arc by clicking in the Graphics Window at either arc end. If clicking on an existing feature node, vertex or arc, the new arc will snap to that object. Double-click or press the Enter key to terminate the arc. Use the Create Feature Node tool to create additional nodes alone or to split arcs. 2. Modify arcs. Feature arcs often need to be edited after initial creation. 1. Create additional vertices on arcs. Use the Create Feature Vertex tool to add vertices along arcs. 2. Refine the arc shape. Use the Select Feature Vertex tool and the Select Feature Node tool to move/edit existing arcs and refine the shape by dragging the nodes/vertices. Use the Select Feature Arc tool to move entire arcs . 3. Split arcs. An existing arc can be split by: 1. Converting a vertex to a node. Use the Select Feature Vertex tool and right-click on a vertex along an arc. Select the Convert to Node command to split the arc into two arcs. 2. Add a node the arc. Use the Create Feature Node tool to add a node on an arc in order to split it into two arcs. 3. Add a new connecting arc. Use the Create Feature Arc tool to start or end a new arc on an existing arc to split the existing arc into two arcs. 4. Use the Split Arcs Tool. Right-click on an arc using the Select Feature Arc tool and select the Split Arc(s)... command. Use the Split Arcs Tool to divide arcs. 5. Split overlapping arcs using the Clean Options dialog. Select overlapping arcs using the Select Feature Arc tool. Use the Feature Objects | Clean command to bring up the Clean Options dialog. Select the Intersect selected arcs option (for selected arcs) or Intersect arcs option (for all overlapping arcs) to split the arcs. 4. Merge arcs. Two arcs that share an end node can be merged together. Select the shared node using the Select Feature Node tool. Right-click on the node and select the Convert to Vertex command to merge the arcs. If desired, the Select Feature Vertex tool can be used to select and delete the new vertex. 5. Smooth arcs. The variability or roughness of an arc can be reduced. Right-click on an arc using the Select Feature Arc tool and select the Smooth Arc(s)... command. Use the Smooth Arcs Tool to reduce the variability of the arc. 6. Prune arcs. Concave sections of the arc can be removed. Right-click on an arc using the Select Feature Arc tool and select the Prune Arc(s)... command. Use the Prune Arcs dialog to remove concave sections. 7. Extend/trim arcs. Extend or shorten an arc to match an existing arc's length. Using the Select Feature Arc tool, select two intersecting arcs. Right-click on an arc using the Select Feature Arc tool and select the Extend/Trim Arc... command. Use the Trim/Extend Arc dialog to select the target arc and source arc. 3. Assign boundary conditions to feature objects. 1. Assign boundary conditions to feature arcs. Using the Select Feature Arc tool, double-click on boundary arcs. In the Boundary Conditions dialog, define the boundary condition parameters for the arc. 2. Assign boundary conditions to feature points. Using the Select Feature Point or Node tool, double-click on boundary point. In the Boundary Conditions dialog, define the boundary condition parameters for the point. 3. Assign boundary conditions to feature polygons. Be certain polygons have been built using the Build Polygons command before proceeding. Using the Select Feature Polygon tool, double-click on boundary polygon. In the Boundary Conditions dialog, define the boundary condition parameters for the polygon.

7. Define general material properties.
TUFLOW requires both general material data propertiess and TUFLOW specific materials. Select the Edit | Materials Data command. Define material types in the Materials Data dialog.

8. Set up the TUFLOW simulation.

1. Create a TUFLOW simulation. Right-click on an empty section of the Project Explorer and select the New Simulation | TUFLOW command. 2. Add components to the TUFLOW simulation. 1. Add geometry components to the simulation. Right-click on the "Components" folder under the simulation and select the New 2D Geometry Components command. Link geometry components to the simulation by clicking and dragging the component under the "Components" simulation folder. 2. Add TUFLOW coverages to the simulation. Link coverages to the simulation by clicking and dragging the coverage under the "Sim" simulation folder.

9. Define TUFLOW material sets.
1. Create a new material set Right-click on the "Material Set" folder under the simulation and select the New Material Set command. 2. Define TUFLOW material properties. Right-click on the "Material Set" simulation item and select the Properties command. In the TUFLOW Material Properties dialog, define each material's roughness, hydrologic losses, storage reduction, etc...

10. Define TUFLOW model properties.

Bring up the TUFLOW Model Control dialog and define parameters as needed for: Time including time steps, start and end times. Output including map outputs, dataset outputs, and log outputs. Wetting and drying settings. Restart files options. Initial water levels. Eddy viscosity formulation. Boundary condition events. Constituent properties. Material set management. Miscellaneous options. 1D general controls. 1D network controls. 1D automatic manholes.

11. Run TUFLOW.
Check model simulation. Run TUFLOW.

12. Review results.

1. Load solution files. The solution file should load after running the model assuming the Load Solution option was checked in the model wrapper before exiting the model run. If loading the solution file separately from the model run, do the following: Open the output files generated from the model run. 2. Review results datasets and data visualization. 1. Manually review dataset solutions. In the Project Explorer, click on solution dataset created from the simulation run and view results in the Graphics Window. Click through the time steps for each dataset to see changes over time in the Graphics Window. 2. Adjust the display options. 1. Set display options. Open the Display Options dialog. Set the general display options. Set general lighting options. Set display options for each module that is being used. Set contour options. Set vector options. 2. View display. Use the Rotate , Pan , and Zoom tools. Use the View menu commands found in the Display menu. Use the Frame command to center and resize the display as needed. 3. Adjust display. Display may need to be adjusted during the remainder of the project. Use the Display Options dialog and viewing tools as needed. Use the Frame command to center and resize the display as needed. 3. Create a film loop visualization. Select a solution dataset and use the Data | Film Loop menu command. Use the Film Loop Setup wizard to specify the animation parameters. Save and view the animation file. 4. Create a plot. 1. Load solution files if not already in the project. The solution should load automatically assuming the Load Solution option was checked in the model wrapper before exiting the model run. If loading the solution separately from the model run, open the solution file generated from model run. 2. Create an observation coverage. Create a new coverage with the "Observation" type. Select Map Data in the Project Explorer and use the New Coverage right-click command. Use the New Coverage dialog to create a new coverage by selecting the desired coverage type, and naming the coverage. 3. Create observation points in the observation coverage. 1. Create feature arcs, nodes and vertices. In the Map module, create feature objects in the active coverage. Use the Create Feature Arc tool to create arcs in the map coverage. Begin creating a new arc by clicking in the Graphics Window at either arc end. If clicking on an existing feature node, vertex or arc, the new arc will snap to that object. Double-click or press the Enter key to terminate the arc. Use the Create Feature Node tool to create additional nodes alone or to split arcs. 2. Modify arcs. Feature arcs often need to be edited after initial creation. 1. Create additional vertices on arcs. Use the Create Feature Vertex tool to add vertices along arcs. 2. Refine the arc shape. Use the Select Feature Vertex tool and the Select Feature Node tool to move/edit existing arcs and refine the shape by dragging the nodes/vertices. Use the Select Feature Arc tool to move entire arcs . 3. Split arcs. An existing arc can be split by: 1. Converting a vertex to a node. Use the Select Feature Vertex tool and right-click on a vertex along an arc. Select the Convert to Node command to split the arc into two arcs. 2. Add a node the arc. Use the Create Feature Node tool to add a node on an arc in order to split it into two arcs. 3. Add a new connecting arc. Use the Create Feature Arc tool to start or end a new arc on an existing arc to split the existing arc into two arcs. 4. Use the Split Arcs Tool. Right-click on an arc using the Select Feature Arc tool and select the Split Arc(s)... command. Use the Split Arcs Tool to divide arcs. 5. Split overlapping arcs using the Clean Options dialog. Select overlapping arcs using the Select Feature Arc tool. Use the Feature Objects | Clean command to bring up the Clean Options dialog. Select the Intersect selected arcs option (for selected arcs) or Intersect arcs option (for all overlapping arcs) to split the arcs. 4. Merge arcs. Two arcs that share an end node can be merged together. Select the shared node using the Select Feature Node tool. Right-click on the node and select the Convert to Vertex command to merge the arcs. If desired, the Select Feature Vertex tool can be used to select and delete the new vertex. 5. Smooth arcs. The variability or roughness of an arc can be reduced. Right-click on an arc using the Select Feature Arc tool and select the Smooth Arc(s)... command. Use the Smooth Arcs Tool to reduce the variability of the arc. 6. Prune arcs. Concave sections of the arc can be removed. Right-click on an arc using the Select Feature Arc tool and select the Prune Arc(s)... command. Use the Prune Arcs dialog to remove concave sections. 7. Extend/trim arcs. Extend or shorten an arc to match an existing arc's length. Using the Select Feature Arc tool, select two intersecting arcs. Right-click on an arc using the Select Feature Arc tool and select the Extend/Trim Arc... command. Use the Trim/Extend Arc dialog to select the target arc and source arc. 4. Add observation point attributes. With the Select Feature Point tool, right-click on the observation point and select the Node Attributes command. Set the observation attributes in the Observation Coverage dialog. 5. Use the Plot Wizard to generate plot type. The Plot Wizard can generate any of the following plot types: 1. Computed vs. Observed Data plot. Select Display | Plot Wizard to start the Plot Wizard. Select the "Computed vs. Observed Data" option on the left and click Next. Review measurements to be plotted in step 2 of the Plot Wizard then click Finish. Review plot window. 2. Residual vs. Observed Data plot. Select Display | Plot Wizard to start the Plot Wizard. Select the "Residual vs. Observed Data" option on the left and click Next. Review measurements to be plotted in step 2 of the Plot Wizard then click Finish. Review plot window. 3. Error vs. Simulation plot. Select Display | Plot Wizard to start the Plot Wizard. Select the "Error vs. Simulation" option on the left and click Next. Specify plot options in step 2 of the Plot Wizard then click Finish. Review plot window. 4. Error vs. Time Step plot. Select Display | Plot Wizard to start the Plot Wizard. Select the "Error vs. Time Step" option on the left and click Next. Specify plot options in step 2 of the Plot Wizard then click Finish. Review plot window. 5. Error Summary plot. Select Display | Plot Wizard to start the Plot Wizard. Select the "Error Summary" option on the left and click Next. Specify measurements to be plotted in step 2 of the Plot Wizard then click Finish. Review plot window. 6. Time Series plot. Select Display | Plot Wizard to start the Plot Wizard. Select the "Time Series" option on the left and click Next. Specify plot options in step 2 of the Plot Wizard then click Finish. Review plot window. 3. Use an observation profile plot. 1. Create an observation coverage. Create a new coverage with the "Observation" type. Select Map Data in the Project Explorer and use the New Coverage right-click command. Use the New Coverage dialog to create a new coverage by selecting the desired coverage type, and naming the coverage. 2. Create observation arcs in the observation coverage. 1. Create feature arcs, nodes and vertices. In the Map module, create feature objects in the active coverage. Use the Create Feature Arc tool to create arcs in the map coverage. Begin creating a new arc by clicking in the Graphics Window at either arc end. If clicking on an existing feature node, vertex or arc, the new arc will snap to that object. Double-click or press the Enter key to terminate the arc. Use the Create Feature Node tool to create additional nodes alone or to split arcs. 2. Modify arcs. Feature arcs often need to be edited after initial creation. 1. Create additional vertices on arcs. Use the Create Feature Vertex tool to add vertices along arcs. 2. Refine the arc shape. Use the Select Feature Vertex tool and the Select Feature Node tool to move/edit existing arcs and refine the shape by dragging the nodes/vertices. Use the Select Feature Arc tool to move entire arcs . 3. Split arcs. An existing arc can be split by: 1. Converting a vertex to a node. Use the Select Feature Vertex tool and right-click on a vertex along an arc. Select the Convert to Node command to split the arc into two arcs. 2. Add a node the arc. Use the Create Feature Node tool to add a node on an arc in order to split it into two arcs. 3. Add a new connecting arc. Use the Create Feature Arc tool to start or end a new arc on an existing arc to split the existing arc into two arcs. 4. Use the Split Arcs Tool. Right-click on an arc using the Select Feature Arc tool and select the Split Arc(s)... command. Use the Split Arcs Tool to divide arcs. 5. Split overlapping arcs using the Clean Options dialog. Select overlapping arcs using the Select Feature Arc tool. Use the Feature Objects | Clean command to bring up the Clean Options dialog. Select the Intersect selected arcs option (for selected arcs) or Intersect arcs option (for all overlapping arcs) to split the arcs. 4. Merge arcs. Two arcs that share an end node can be merged together. Select the shared node using the Select Feature Node tool. Right-click on the node and select the Convert to Vertex command to merge the arcs. If desired, the Select Feature Vertex tool can be used to select and delete the new vertex. 5. Smooth arcs. The variability or roughness of an arc can be reduced. Right-click on an arc using the Select Feature Arc tool and select the Smooth Arc(s)... command. Use the Smooth Arcs Tool to reduce the variability of the arc. 6. Prune arcs. Concave sections of the arc can be removed. Right-click on an arc using the Select Feature Arc tool and select the Prune Arc(s)... command. Use the Prune Arcs dialog to remove concave sections. 7. Extend/trim arcs. Extend or shorten an arc to match an existing arc's length. Using the Select Feature Arc tool, select two intersecting arcs. Right-click on an arc using the Select Feature Arc tool and select the Extend/Trim Arc... command. Use the Trim/Extend Arc dialog to select the target arc and source arc. 3. Create an observation plot. Select Display | Plot Wizard to start the Plot Wizard. Select the "Observation Profile" option on the left and click Next. Select arcs, datasets, and time steps to be plotted. Review plot window. 4. Create and compare datasets. Select the Data | Dataset Toolbox menu command. In the Dataset Toolbox, compare datasets by subtracting the alternate dataset from the base dataset. New dataset can be generated in the Dataset Toolbox using the Data Calculator.