Call Us: (866)-473-0453

Introduction to VO-SWMM

This guide explores DataCurrent and its features

USER'S MANUAL

This manual provides introductions on VO-SWMM and the use of its basic functions and advanced tools.

Vision

Is it possible to develop a simple, yet powerful storm and sanitary drainage information management system that integrates asset information, topography, land use, climate, and drainage analysis tools into a simple system to identify system performance for use in new growth and intensification planning and for system operation and maintenance improvements?

Municipal and watershed drainage system management in the past relied on rough topographic mapping, approximated asset information, lumped models, and minimal use of cross-department information. This approach was used to assess the condition and performance of existing drainage systems and to make decisions for system improvements through infrastructure maintenance, repairs, or expansion. The documents prepared as part of the Master Planning process are typically passive tools used once for planning growth and asset planning. More detailed, site-specific studies where often required to refine the studies to pinpoint local impacts and for design purposes.

With the advent of Geographic Information Systems (GIS), powerful computers, public-domain computational engines, rapid and accurate survey methods, inexpensive flow and environmental monitoring and new methods that integrate these, the possibility of developing ‘live’, detailed systems that manage the information through constantly updated data flows, dash-boards, and accessible systems may now be possible. The key is whether it is possible to establish as a management system that integrates various data sources such as drainage asset data (GIS data containing sewers, catchbasins, manholes, leads, SWM, etc.), drainage condition assessment data (surveys, DEM, design, CCTV), flow monitoring data (flow, rain, etc.), previous reported flooding locations, etc. for improving system operation and maintenance and managing growth.

The key to improvement is leveraging powerful new tools and methods into simple systems that integrate detailed and accurate data for analysis to best inform managers and users on system performance identifying operational needs and raise level of services and service new growth in greenfield and/or development intensification areas. New innovative techniques and powerful systems can integrate and manage data from various sources prior to detailed analysis to produce city-wide or watershed-wide information to help managers know and improve drainage systems. Detailed and rapidly collected data can be leveraged using simple and powerful methods to produce accurate information regarding system capacity, capacity constraints, and asset conditions to plan system improvements.

We are aiming at creating a new software package that has following features.

  1. The software system would integrate current geographic and asset information, reports, drawings, real-time and historic monitored flow data, climate data, GIS, asset management information, and drainage analysis tools to develop a municipal-wide drainage management system to help city managers, technical managers, and operations staff drainage patterns, evaluate system capacity, capacity constraint locations
  1. Automated methods for creating drainage system models (Micro Drainage)
  1. Surface flow analysis:
    1. Flow path
    2. Street sags
    3. Diversions
  1. Sewer/culvert asset integration
  1. New uses for rain data for drainage analysis
  1. Corrections to digital elevation model data using low-cost, rapid, land-based, LiDAR surveys for surface drainage analysis.

Welcome

Welcome to VO Storm Water Management Model (VO-SWMM), the hydrologic & hydraulic model simulation software package. It is an effective hydrologic management software that has been developed for various analyses including Watershed Studies, Sub-watershed Studies, Master Drainage Plans, Site Plans, and Stormwater Management Pond Design.

INSTALLING VO-SWMM

Follow the requirements and steps to install VO on your computer.

Hardware and Software Requirements
Licensing System
Installing VO
Running VO
Uninstalling VO

A. Hardware and Software Requirements

Before you install VO, make sure that your computer meets the minimum requirements listed below. The minimum system requirements for all versions of the program are given in Table 1.

TABLE 1: SYSTEM REQUIREMENTS

Minimum Requirements: 
Operating system:Microsoft Windows XP SP3/ Vista / 7 (32 or 64-bit)
Processor:Intel Pentium 4 1.5 GHz
RAM:1.0 GB
Hard disk space:500 MB
Recommended Requirements: 
Operating system:Microsoft 7/10 (32 or 64-bit)
Processor:Intel Core i7 2.0 GHz
RAM:1.5 GB
Hard disk space:1.0 GB

B. Licensing System

VO has a simple yet effective cloud-based licensing protection system to ensure that users comply with the terms of their license agreement. As set out in the license agreement, VO may be installed in multiple computers, but only the computer securing a license from cloud will be able to run the application.

A customer portal is provided to track the usage of all licenses. For more information, please refer to Customer Portal for Cloud-based Licensing document.

C. Installing VO-SWMM

Before installing VO-SWMM, make sure that you have closed all other programs and that any virus protection software is disabled. To install VO-SWMM on your computer, please follow the directions below.

Step 1: Download the installation file from VO-SWMM Download page. The download link is updated once a new version is available.

Step 2: Download your license file. We now utilize a cloud-based licensing system.

Step 3: Double click on the installation file to open the installation wizard. Read and accept the License Agreement

Step 4: By default, VO6 is installed on C:\Program Files (x86)\Visual OTTHYMO 6.2

Step 5: Choose to Create a desktop shortcut and UNCHECK USB Key License Driver.

Step 6: Review your setup and click Install

Step 7: To complete the installation, you need to restart your computer.

Step 8: Activate VO-SWMM

  1. Double click your installed VO-SWMM icon on your desktop. License Manager will appear
  1. Click Add Cloud License File. In the pop-up window, navigate to and double-click your license file to add it to License Manager. The following window will appear after loading the license file. For the License Type as Cloud, the Status should display OK. Depended on your license file, your Expired Date and Details columns could be different from the figure below.
  1. Close License Manager and re-open VO-SWMM.

D. Running VO-SWMM

To start VO-SWMM, simply double-click on the VO desktop icon  or find the VO item from your Start menu. Once VO-SWMM starts, you will first see the splash screen as below

Then, you will see the main window. You may see the main window as below, which is used for the Visual Otthymo project.

Switch to the main window for VO-SWMM. Navigate to File -> New Project -> New SWMM Project.

Your main window will change to the interface for VO-SWMM project. Click on the Map tab to see the Map view, which by default displays the map of Toronto, Canada.

E. Uninstall VO-SWMM

You may be required to uninstall VO-SWMM in the future. The following procedure should be followed to uninstall VO-SWMM from your system:

  • -Launch Control Panel and double-click Add/Remove Programs.
  • -Scroll down the list until you find VO.
  • -Select item and click OK button.
  • -Re-boot computer.

Software License Agreement

Visual OTTHYMO is a complex computational software program (Visual OTTHYMO Software Program) for stormwater management owned by Smart City Water Inc.

Although the Visual OTTHYMO Software Program has been thoroughly tested by Smart City Water Inc. and has endeavoured to make this program error free, this program is not and cannot be warranted as infallible and there remains the possibility of program errors. Further, the Visual OTTHYMO Software Program is complex requiring professional engineering expertise and professional engineering judgment to input information and to interpret the information generated by the program. Therefore, Smart City Water Inc. can make no warranty either implicit or explicit as to the correct performance or accuracy of the Visual OTTHYMO Software Program to process or implement the information supplied.

As a result, Smart City Water Inc. disclaims all liability including, without limitation, special, collateral, incidental or consequential damages in connection with or arising out of the purchase and use of the Visual OTTHYMO Software Program.

Smart City Water Inc. reserves the right, from time to time, to revise and improve its documentation, program and software as they may deem necessary. The information in this program describes the state of the software at the time of its publication. It may not, however, accurately reflect the state of future revisions to the software.

You should read carefully the following terms and conditions before continuing with the installation and use of the Visual OTTHYMO software for stormwater management (the “software”). By installing the software, you are agreeing to be bound by the terms and conditions of this license. If you do not agree to the terms of this license, please permanently remove all copies of the installation (with all the original contents) to the place of purchase for a full refund within 10 days of purchase.

The software and the related documentation are licensed to you by Smart City Water Inc. (“LICENSOR”) as owner and also as distributor (“DISTRIBUTOR”). You will own the media on which the Software is stored and provided to you herewith, but LICENSOR retains all rights, including the copyright, in the Software and the related documentation. You may install and maintain the Software (the “Installed Copy”) on either a: (i) single computer for use by one person at a time (without sharing); or (ii) network server for use on an internal network, provided that the number of users concurrently using or sharing the Software does not exceed the number of valid licenses of the Software you have purchased from the LICENSOR. You may not assign or otherwise transfer any of your rights under this License to any third party. YOU AGREE TO ENSURE THAT ANYONE WHO USES THE SOFTWARE DOES SO ONLY FOR YOUR AUTHORIZED USE AND COMPLIES WITH THE TERMS OF THIS AGREEMENT.

2. RESTRICTIONS:
The Software contains copyrighted material, trade secrets and other proprietary material. Accordingly, YOU MUST NOT TRANSLATEDECOMPILEREVERSE ENGINEERDISASSEMBLEMODIFYENHANCEUPDATE, OR CREATE DERIVATIVE WORKS BASED UPON OR INCORPORATINGTHE SOFTWARE, IN WHOLE OR IN PARTUNLESS AUTHORIZED IN WRITING BY LICENSOROTHER THAN AS EXPRESSLY PERMITTED HEREINYOU MUST NOT USE OR COPY THE SOFTWARE OR RELATED DOCUMENTATIONYOU MUST NOT NETWORKRENTLEASELOAN, OR DISTRIBUTETHE SOFTWARE, IN WHOLE OR IN PART.

3. TERM:
This License is effective until terminated. You may terminate this License at any time by destroying all copies (in any format and including the Installed Copy) of the Software and related documentation. This License will terminate immediately, without notice from LICENSOR, if you fail to comply with any provision of this License. Upon termination, you must destroy all copies (in any format and including the Installed Copy) of the Software and related documentation, and you must notify LICENSOR in writing that all such copies have been destroyed.

4. MEDIA WARRANTY:
LICENSOR warrants that the disk(s) or compact disc(s) provided to you by LICENSOR on which the Software is stored, shall be free from defects in materials and workmanship under normal use for ninety (90) days from the date of delivery to you.

5. DISCLAIMER OF WARRANTY:
You expressly acknowledge and agree that use of the Software is at your sole risk. Although the SOFTWARE has been thoroughly tested and LICENSOR has endeavored to make this program error free, the SOFTWARE is not and can not be warranted as infallible, and there remains the possibility of program errors. Further, the SOFTWARE is complex, requiring professional engineering expertise and professional engineering judgment to input information into the SOFTWARE and to interpret the information generated thereby. Therefore, LICENSOR and DISTRIBUTOR can make no warranty either implicit or explicit as to the correct performance or accuracy of the SOFTWARE to process or implement the information required. THE SOFTWARE AND RELATED DOCUMENTATION ARE PROVIDED “AS IS” AND WITHOUT WARRANTY OF ANY KINDEXPRESSED OR IMPLIEDINCLUDINGBUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSELICENSOR AND DISTRIBUTOR DO NOT WARRANT THAT THE SOFTWARE WILL MEET YOUR REQUIREMENTS, OR THAT THE OPERATION OF THE SOFTWARE WILL BE INTERRUPTED OR ERRORFREE, OR THAT DEFECTS IN THE SOFTWARE WILL BE CORRECTED. Furthermore, LICENSOR and DISTRIBUTOR do not warrant or make any representations regarding the use or the results of the use of the Software or related materials in terms of their correctness, accuracy, reliability or otherwise.

No oral or written information or advice given by LICENSOR or DISTRIBUTOR shall create a warranty or in any way increase the scope of the warranty contained in this License

6. MANDATORY MAINTENANCE:
Upon the expiration of the initial one-year maintenance period, the Licensee agrees to be charged for maintenance support in the amount of the LICENSOR’s regular list price for maintenance and support for the SOFTWARE as published from time to time by LICENSOR. Licensee shall notify LICENSOR in writing if it decides to decline mandatory maintenance. If Licensee fails to renew maintenance and later elects to receive it, LICENSOR reserves the right to charge Licensee its maintenance fees for the period(s) of the lapsed maintenance. Should the Licensee allow a lapse in maintenance, the Licensee forfeits access to technical support, updates and upgrades that may be available for the SOFTWARELICENSOR may elect to discontinue maintenance at any time upon written notice to Licensee.

7. LIMITATION OF LIABILITY:
UNDER NO CIRCUMSTANCESINCLUDING NEGLIGENCESHALL LICENSOR OR DISTRIBUTOR BE LIABLE TO YOU OR ANY OTHER PARTY FOR ANY INCIDENTALSPECIAL OR CONSEQUENTIAL DAMAGES THAT RESULT FROM THE USE OR INABILITY TO USE THE SOFTWARE OR RELATED DOCUMENTATIONEVEN IF LICENSOR OR DISTRIBUTOR HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL LICENSOR’S OR DISTRIBUTOR’S TOTAL LIABILITY TO YOU FOR ALL DAMAGESLOSSESAND CAUSES OF ACTION (WHETHER IN CONTRACTTORT (INCLUDING NEGLIGENCE) OR OTHERWISEEXCEED THE AMOUNT PAID TO LICENSOR OR DISTRIBUTOR TO LICENSE THE SOFTWARE HEREUNDER.

8. CONTROLLING LAW AND SEVERABILITY:
This License shall be governed by and construed in accordance with the laws of the province of Ontario and adjudicated in a court of that province. If, for any reason, a court of competent jurisdiction finds any provision of the License, or portion thereof, to be unenforceable, that provision of the License shall be enforced to the maximum extent permissible in order to effect the intention of the parties, and the remainder of this License shall continue in full force and effect.

9. COMPLETE AGREEMENT:
This License constitutes the entire agreement between the parties with respect to the use of the Software and related materials, and supersedes all prior or contemporaneous understandings or agreements, written or oral, regarding such subject matter.

10. THIRD PARTY SOFTWARE:
Visual OTTHYMO Software may include software under license from third parties (“Third Party Software” and “Third Party License”). Any Third Party Software is licensed to you is subject to the terms and conditions of the corresponding Third Party License. The Third Party License(s) is located in the license.txt file. Please contact Visual OTTHYMO support if you cannot find a Third Party License.

11. COUNTRY UNIQUE CODES AND LICENSE SHARING
Purchase of Visual OTTHYMO Software program is country specific. License sharing is permissible within the country of purchase and not internationally. Separate licenses specific to the country will be required for the use of the program in multiple countries.

VO-SWMM SUPPORT

VO-SWMM has a comprehensive Help System and supporting documentation that will assist both beginners and advanced users. The primary goal in designing this Help System was to empower users with the tools and information so that almost every question can be answered in a timely manner, without having to call technical support. Should a question arise that is not addressed in the user manual, please contact technical support at support@smartcitywater.ca.

A. Seminars and Workshops

Smart Water City Inc. hosts seminars and workshops that allow users the opportunity to learn the basics of VO-SWMM and use all its features to their full potential. Seminars and workshops are organized by need. You can find more information from our website.

B. Customer Support

Users requiring support should first consult the User’s Manual and Reference Manual to answer their question. Should a question not be addressed, or further assistance is required, users should contact Smart City Water’s VO Technical Support support@smartcitywater.ca or +1 (905) 417-9792. Live technical support is also available for all registered users regarding program installation and troubleshooting. A nominal fee will be charged to users requiring technical support pertaining to the use of the model in an engineering application.

FEATURES

VO-SWMM not only utilizes Microsoft’s latest .Net Framework, 4.0 but also uses WPF (Windows Presentation Foundation) to enhance user experience through the graphical user interface. VH SWMM has new features that improve the efficiency of creating and simulating models, as well as the preciseness of the estimations obtained.

The main features include and are not limited to

  • -GIS (Geographical Information System)
  • -DRMT (Distributed Rainfall Modeling Technique)
  • -Radar
  • -Capture Curves
  • -Micro Drainage

VOSWMM Main Interface

After installation, the initial interface is in VO. To switch to VOSWMM, click File drop-down list. In the New Project, select New SWMM Project.

The VOSWMM main interface will show.

FILE MENU

IconCommandDescription
New ProjectCreate a new project
Open ProjectOpens an existing project. VO-SWMM allows to open a VO-SWMM project (.voprj) or a INP file (.inp)
Save ProjectSave the current project
Save Project AsSaves the current project under a different name
ImportImport Scenarios
ExportExport the current scenairo
Copy to ClipboardCopy select objects to clip-board
PrintPrint the canvas

Import 

  • Detail explanation available here
IconCommandDescription
Import VH ScenarioImport existing VH
Import SWMMImport .inp format

Export 

  • Detail explanation available here
IconCommandDescription
Export to SWMM INP FileExport current scenario to SWMM INP file
Export to InfoWorks CSExport newtwork in current scenairo to Infoworks CS CSV file
Export to InfoWorks ICMExport newtwork in current scenairo to Infoworks ICM CSV file

Import and Export VOSWMM Models

INP files can be Imported into VO-SWMM and can also be Exported.

Import INP Format

Select File from main menu window -> Import -> Import SWMM

  • Input File: File path of INP file to be imported into VO-SWMM
  • Generate Layout for Schematic: Checking this will generate objects layout in Schematic View. If you want to see the Schematic layout, please make sure the Schematic View is selected as Yes in the Home Options.

Import scenarios from another VOSWMM model

Select File from main menu window -> Import -> Import VH Scenario. In the pop-up window, navigate to the VOSWMM model to be imported. Double-click the model to open.

In the Import Scenarios window, check on Include to select the scenarios to be imported.

Export INP Format

Select File from main menu window -> Export -> Export to SWMM INP File

  • Output Folder: File path to save INP format file with selected Runs
  • Check Include to select the Runs to be exported
  • Double click on Name of the run to edit the run name

Export to Infoworks

VOSWMM model can be exported to Infoworks CSV files in two formats: Infoworks CS and Infoworks ICM.

Select File from main menu window -> Export -> Export to Infoworks CS or Export to Infoworks ICM. In the pop-up, select the file path and file name to be saved.

Home

The Home tab includes the basic functions to create new project, open existing projects, set default project options, and perform basic editing and searching to the project.

Home Tab

IconCommandDescriptionIconCommandDescription
New ProjectCreate a new projectDeleteDeletes selections
Open ProjectOpens an existing projectUndoRemoves the last action
Save ProjectSave the current projectRedoRepeats the last action
Save Project AsSaves the current project under a different nameEdit HistoryDisplays list of actions performed by the modeler(s)
CopyCopies the selection to the clip-boardFindLocates a specific object by ID or name
CutExtracts the selection to the clipboardWindowsProvided dropdown for selection of windows to be displayed
PastePastes copied or cut hydrologic objectsOptionsAccess window to define general settings details such as Unit and Precision

In the Windows drop-down list, you can manage the window and panels that you want to display or hide from the main interface.

Click the Options button. In the pop-up window, use General and GIS tab to set defaults for GIS system, unit, and auto-save.

Options 

General tabDescription
Project TypeThe default project type when creating a new project.
Schematic ViewSelect Yes, the tab of Schematic View will show when creating or opening a project. Select No, the tab of Schematic View will not show when creating or opening a project.
UnitThe default unit system type when creating a new project. VO-SWMM supports all six unit systems the same as EPA SWMM5: CFSGPMMGDCMSLPS and MLD. User can still change the unit system type at the scenario level.
Result Displaying DecimalsSet result displaying decimal for each type of variables for subcatchments, links and nodes.
AutosaveCheck on Autosave Enabled to allow project autosaving and the project will be saved automatically by the autosaving interval.
SWMM5Choose SWMM5 Engine to run the model.

GIS tabDescription
GIS TypeChoose None to turn off Map View. Choose TatukGIS to use Tatuk Map. Choose ArcGIS to use ArcGIS map. Please note ArcGIS license is required to use ArcGIS, but no such requirement for using TatukGIS.
Default Coordinate SystemThe default coordinate system when creating a new project. Please note that VO-SWMM can detect the coordinate system from the prj file that comes with the shp file.
Action when two polygon-commands overlapChoose Clip to clip the new polygon when it is overlapped with others. Choose Reject to not allow adding a polygon that is overlapped with others.
Synchronize the glyphs shown in map and schematic viewCheck on this box to synchronize schematic view from map. Please note to select Yes in the Schematic View field in the General tab of Home Options, if you want to see the glyphs on the schematic view. Please also note that it is feasible to synchronize the objects from map to schematic view but not vice versa, because the model on the map view requires more information than on the schematic view.

SIMULATION

The Simulation tab includes tools mainly for setting up and running simulations, viewing and analyzing results, and managing database that will be used in the model.

Simmulation Tab

IconCommandDescriptionIconCommandDescription
RunRun SimulationDefault ValuesDefault values for newly added hydrologic objects
Engine OptionsEngine OptionsElevation ProfileDisplays the elevation output for selected objects
Scenario ComparisonComparing objects from different scenariosPlot CalibrationCalibration viewer
Plot ResultsView Plot Results for selected objectInput ParametersInput parameter format
Output ResultsOutput results selected runResult TableResults Table for selected object
Surcharge AnalysisUpdate Model ResultsFlood Plain AnalysisAnalysis on flood depth on each major node
Resource LibraryOpen Resource LibraryTransectsSetup Transect
CurvesSetup CurvesClimatologySetup Climatology settings

SIMULATION - RUN AND OPTIONS

The Simulation group in Simulation tab has items to perform simulation run, setting default values to commands and initial engine settings.

IconCommand
Run
Default Values
Engine Options

Run

Batch Run 

Click the Run button to open the Batch Run window, where you can set several runs for the active scenario. In the Name column, click on each field and then click again to change the name for each Run. In the Rain Group column, select the rain from the drop-down list. Click Clear All Results button to clear all the results. Click Run button to run all the runs that are checked on.

Click the Settings button next to each Run to set the date and time for the Run. When clicking Get Storm Dates button, it will obtain the first date and time and the last date and time based on all the rain data included in the chosen Run Group and use those dates and time as the starting and ending date and time for the Run. Click OK to save the changes.

Default Values

Default Values 

Click the Default Values button. In the pop-up window, set up default values that will be used in the model. Use the Import  or Export  button to import or save the current default settings.

In the Id Labels tab, give the prefix that you want to use for the NHYD of different objects. If leaving empty, the new objects NHYD will only include numbers.

In the Subcatchments tab, set up the default parameters to be used for subcatchments.

In the Nodes/Links tab, set up the default parameters to be used for nodes and links.

Engine Options

Engine Options 

Click the Engine Options button. In the pop-up window, set parameters used by the SWMM5 engine.

SIMULATION - OUTPUT

VOSWMM generates both time-series results and summary results.

The Time-Series Results in VOSWMM include following variables:

  • -Catchment: Rainfall, Snow Depth, Evaporation, Infiltration, Runoff, Groundwater flow, Groundwater elevation, Soil moisture and Pollutant concentrations
  • -Link: Flow, Depth, Velocity, Volume, Capacity and Pollutant concentration
  • -Node: Depth, Head, Volume, Lateral inflow, Total inflow, Flooding flow and Pollutant concentrations

The Summary Result in VOSWMM includes statistic results as in EPA SWMM5 engine.

 

Plot Results

Select objects on the map whose time-series results to be plotted. Multiple objects can be selected by holding Ctrl key. Then, click the button Plot Results to view the time-series results. Click Export on the Plot Results window to export the results in CSV files.

You can view different variables for all the selected objects even though those objects are in different types. Use the checkbox on the left-side panel to show or hide the plotting.

Right click on the variable level to open the context menu to Select All or Deselect All.

The Deselect All is also available at the object level.

Result Table

Select objects on the map whose time-series results to be plotted. Multiple objects can be selected by holding Ctrl key. Then, click the button Results Table to view the time-series results. The table can be copy and paste by clipboard.

You can view the table of all the selected objects by click on the table tab of each object.

Elevation Profile

Elevation profile is a tool used to visually plot geo graph of selected Links and Nodes along with their values, such as LengthMax DepthDepth, and Flow.

There are three ways to plot Elevation Profile.

  1. Select links on the map and then click the Elevation Profile button. For multiple selection, hold Ctrl key.
  2. Select the starting node first, select the ending node by holding Ctrl key and then click the Elevation Profile button. With selecting two nodes, VOSWMM will retrieve all the links from the starting node to the ending node.
  3. Use dedicated selection buttons in the GIS Tools toolbar or selection menu in the context menu on the map to select upstreamselect downstream or select long section to select nodes and (or) nodes. For multiple selection, hold Ctrl key. Then, click the Elevation Profile button.

With selection on Elevation Profile, a new tab will show up with dedicated plots for each links/nodes along with their summary tables showing basic data.

Please note that for the link whose type is pump, orifice, weir and outlet, they will not be shown on the graph and table, because their length is 0.

The following options are available to interact with the graph and summary table:

Checkbox Options

  • Lock Selection – unchecked by default. If is unchecked, the profile plotting will be updated with the selections on the map. If you do not update the plotting of elevation profile, check the Lock Selection box.
  • Show Map Labels – checked by default. If is unchecked, the NHYD label on the graph will be hidden.
  • Show Max Water Depth – checked by default. If is unchecked, the Depth and Flow of Link table and Max Water Depth plot (blue color) will be hidden.
  • Show Hydraulic Grade Line – checked by default. If is unchecked, the Hydraulic Grade Line (red color) will be hidden.
  • Rotate Label – unchecked by default. If is unchecked, the label will be in horizontal position. If is checked, the label will be in vertical position.

Graph Operations

  • Zoom in/out – scroll mouse middle wheel to zoom into the graph with mouse focus area
  • Zoom by area – press and hold mouse middle wheel and draw a rectangle on the graph area to zoom
  • Reset zooms – double click on mouse middle wheel to reset all zooms
  • Show tracker point – press and hold left mouse button along the graph to see the tracker/data point
  • Copy to Clipboard – click on graph and press Ctrl + C to copy the graph to Clipboard

Graph Context Menu

Right click on the graph to open the context menu:

  • Undo All Zoom/Pan – undo all zoom and pan and reset the graph and table as the initial display
  • Save Image As – save image as supported photo format
  • Print – print graph
  • Copy (Ctrl + C) – copy the graph to Clipboard

Summary Tables

  • Below the graph are summary tables for the links and nodes that are plotted on the profile graph. The columns of the tables are aligned with the positions of links and nodes on the elevation profile graph. The following parameters and variables are shown for node and link tables:
    • Link table
      • Link – the NHYD of the link
      • Length – the length of the link (i.e., conduit)
      • Full Depth – the full depth of the link
      • Depth – the max water depth from the time-series simulation
      • Flow – the max flow from the time-series simulation
    • Node table
      • Node – the NHYD of the node
      • Depth – the max water depth from the time-series simulation
  • Select Link / Node by their NYHD to zoom/highlight corresponding plot on the graph. The selected Link / Node will show on Properties window, and the changes made to those values showing on summary table via the window will be updated on the graph and summary tables as well.

Save Elevation Profile into Project Manager

  • Click Save Current Profile button, and then enter a unique name to save the profile into Project Manager. The saved profile will be showing up under the Elevation Profiles group of Project Manager window. Double-click on the saved profile in the Project Manager will open the saved elevation profile with graph and summary tables.

Scenario Comparison

Scenario Comparison compares the simulation result at one object in different scenarios. Select the object to be compared on one scenario and click Scenario Comparison button. Click Save on the Scenario Comparison window to save the compared Graph and Statistics table to Project Manager under the Scenario Comparison group. Double click the saved scenario comparison to view the comparison.

To compare other storms, objects and variables, choose in the drop-down list of Design StormTypeCommand Names and Variables.

Click Save button. The scenario comparison will be saved to Project Manager under the Scenario Comparison group. Double-click the saved scenario comparison in the Project Manager will open the scenario comparison graph and table.

Plot Calibration

In case you want to compare the simulation result with the measurement data, use the Plot Calibration tool.

The format of the measured data file is as below. The first column is date and time in a format of Month/Day/Year Hour:Minute:Second. The second column is the value.

Click the Plot Calibration button. In the pop-up window, click Add button and choose the CSV file of the measurement data. Once the Measured Data is added, drag and drop the added data from Measured Data panel to the right-side window. Set up the columns properly.

Click the View button to see the comparison.

Input Parameters

Once a run is created and added under the Runs group in the Project Manager, click the Input Parameters button to open a new tab and view the model input file in a text-file format.

Context Menu for Input Parameters

Right click on the opened Input Parameters tab to open context menu

  • -Save as – pop up a Save As window where users can save the tab page as a Text File
  • -Copy – copy the selected content from the tab page to clipboard. Please note that before using this function first use mouse to drag and select desired content.
  • -Select all Ctrl + A – select all the content on the tab page. Please note that using Ctrl + A can also select all the content.

Search in Content

  • -Click on the page of Input Parameters tab, and then press Ctrl + F to open the search window. Press Ctrl + F again to close the search window.
  • -In the search window, type the keyword that you are looking for. Click the Find Previous  and Find Next  buttons to search the keyword.
  • Next to the Find Next button  click the dropdown button  to open a dropdown window to set the searching criteria:

Output Results

If a run is completed successfully, click the Output Results button to open a new tab and view the model output result file in a text-file format.

If a run has errors, the errors of the model will be listed to the Output Results

Context Menu for Output Results

Right click on the opened Output Results tab to open context menu

  • -Save as – pop up a Save As window where users can save the tab page as a Text File
  • -Copy – copy the selected content from the tab page to clipboard. Please note that before using this function first use mouse to drag and select desired content.
  • -Select all Ctrl + A – select all the content on the tab page. Please note that using Ctrl + A can also select all the content.

Search in Content

  • -Click on the page of Output Results tab, and then press Ctrl + F to open the search window. Press Ctrl + F again to close the search window.
  • -In the search window, type the keyword that you are looking for. Click the Find Previous  and Find Next  buttons to search the keyword.
  • Next to the Find Next button  click the dropdown button  to open a dropdown window to set the searching criteria

Simulation - Analysis

In this section, user can do analysis based on the simulation results.

Surcharge Analysis 

Click the Surcharge Analysis button. In the pop-up window, in the drop-down list of Run select the run whose simulation results are to be analysis, and type in critical depth for the surcharge analysis. Click Run button to run surcharge analysis. The field Freeboard Level 1 is the distance from the Freeboard 1 to the ground and the field Freeboard Level 2 is the distance from the Freeboard 2 to the ground. When users do not want to differentiate two levels of freeboards, type the same number in the two fields.

For the minor system, there are four levels from the surcharge analysis result:

  • No surcharge: the node is not surcharged. By default, the symbol is green circle dot.
  • Surcharge Below Freeboard 2: the node is surcharged, and the water level is below Freeboard 2. By default, the symbol is yellow circle dot.
  • Surcharge Between: the node is surcharged, and the water level is between the Freeboard 2 and Freeboard 1. By default, the symbol is orange circle dot.
  • Surcharge Above Freeboard 1: the node is surcharged, and the water level is above the Freeboard Level 1. By default, the symbol is red circle dot.

For the major system without reverse driveway, there are two levels from the surcharge analysis result:

  • No surcharge: the node is not surcharged. By default, the symbol is green circle dot.
  • Surcharge: the node is surcharge and the water depth is above the value given in the field Surcharge Level under the Major Node section. By default, the symbol is red circle dot.

Flood Plain Analysis 

Click the Flood Plain Analysis button. In the pop-up window, choose the ground elevation raster from the drop-down list of Raster Layer, and choose the run to be analyzed in the drop-down list of Run. In the Output File Path, give the folder and file name for the flood plain raster to be generated. Click OK to generate the flood plain raster.

The generated flood plain raster will be added to the map and the layer table of the map.

SIMULATION - DATA

In this section, users can define, import or export data that are used to run the simulation based on SWMM5 engine. It includes rain rain data, climatology data, irregular transects, and hydraulic curves like rating curves, storage curves, pump curves etc..

RESOURCE LIBRARY

To open Resource Library, use the Resource Library button  .

The Resource Library has three (3) components: ToolbarLibrary Explorer and Main View. The Toolbar is on the top where buttons are placed in different groups. The Library Explorer, a tree view of all items in the library, is located on the left. Each item has a unique icon and context menu. The Main View displays the information of selected item and it changes depending on the type of the items.

New Group

There are two group types. The top group is the group located at the top level and the sub-group is the group located in another group.

To add a top group, click the Top Group button  in Toolbar.

To add a sub-group in an existing group, select the parent group first in the Library Explorer and then click the Sub Group button  in the toolbar or choose Add New SubGroup in the context menu.

NEW IDF

Chicago, SCS Type II and AES design storms can be created using the IDF data. Users can add or create IDF Group and IDF Curve.

IDF Group

To add a new IDF group, select the IDF Group button and choose the IDF Definition. Click OK to add the new IDF Group.

IDF Curve

It is necessary to add a new IDF curve if the desired return period doesn’t present in the IDF group. It can be added by clicking the IDF curve button in the Toolbar or choosing the Add New IDF Curve menu in the IDF Group context menu. The return period of the new IDF curve is 0 and needs to be edited later.

Create Design Storm from IDF Group

Right-click the IDF Group from which you want to create design storm. In the context menu, select the design storm to be created. In VOSWMM, there are three types of design storm can be created from IDF data: ChicagoSCS Type II and AES design storms

  1. After selecting the type of design storms to be created, the parameter window will appear as shown in the figure below. The available parameters are different depending on the type of the design storms.
  2. Once the parameter is entered, click the OK button to create the design storms. A new folder is created with all new design storms as shown in the figure below. The folder is named with the name of the IDF Group and the type of the design storm. And the new design storms are named with return period, duration, time step and type of design storm. 

Assigning IDF to Chicago Design Storm

The Chicago design storm can use the information of any IDF curve in the library. There are two ways to assign the IDF curve information to a Chicago design storm:

  1. Copy and paste from the IDF curve;
  2. Drag and drop the IDF curve to the Chicago design storm in Library Explorer.

Copying and Pasting A, B, C

To copy and paste A, B, C from an IDF curve to a Chicago design storm:

  1. Select the desired IDF curve in Library Explorer.
  2. In the Main View, click the Copy A,B,C button to copy the A, B, C values. Note that if the fitted A, B, C is invalid, the values can’t be copied.
  3. Select the desired Chicago design storm in Library Explorer and click Paste A,B,C but-ton in the A,B,C section. The A, B, C values are overwritten by values from the copied IDF curve. Upon the change, the time series data table and graph are automatically updated to use the new values. Note that the Paste A,B,C button is not available if no IDF curve is copied.

Dragging and Dropping IDF Curve to Chicago Design Storm

To use drag-and-drop to assign the IDF curve information to a Chicago design storm:

  1. Select the desired IDF curve in Library Explorer.
  2. Keep the left mouse button pressed and drag it over the Chicago design storm in Library Explorer. Notice that the mouse cursor changes to the one shown below, which indicates the IDF curve information will be copied to the Chicago design storm.
  3. Release the mouse button to assign A, B, C values to the Chicago design storm. Notice the A, B, C values change, and the time series are updated automatically.

NEW DESIGN STORM

There are several ways to create a design storm in Resource Library which are corresponding to different scenarios.

  1. Manual Input is used for the case where the design storm will be created from scratch. It gives the flexibility to add, insert, modify, and delete the time series data directly. Although it also supports copy-and-paste from other sources, it is not recommended to use manual in-put for that case. Read-in should be used instead.
  2. Read-in is designed for an existing design storm, which may be exported from another design storm tool or modelling software. Two file formats are supported which are stm and csv.
  3. Chicago is used to create a Chicago design storm based on given parameters including IDF curve. It is often used for cases where model needs to run on Chicago design storms from IDF curves with different return period. It is recommended to add the IDF information into the library first and then create the design storm.
  4. Mass is used when a mass curve file and total precipitation is available. Examples are SCS Type II and AES design storms.
    1. SCS Type II is used to create a 6-hr, 12-hr or 24-hr SCS Type II design storm.
    2. AES is used to create a 1-hr AES design storm.

To create these design storms, click the corresponding button in toolbar or choose the corresponding menu in the context menu as shown in the figure below.

New Manual Input and Chicago design storms will be added immediately and set as the active item. A window will appear for Read-in and MASS design storm for user to preview the data be-fore its added into the library.

ChicagoSCS Type II and AES design storms can also be created based-on IDF Group as introduced at the Create Design Storm from IDF Group

New Manual Input Design Storm

To create a design storm manually, click the Manual Input button. In the Basic Information section, type Name and choose the Unit. In the Time Series table, type in the time and data.

New Read-In Design Storm

The window for new read-in storm is shown in the figure below. It allows users to create a name and browse the data file for preview.

Click the Browse … button in the window to browse the data file to display it in the Data Preview area at the bottom as shown below. It supports the STM file and CSV file.

If Use File Name is checked, the file name will be set as the name of the new read-in design storm. If you are satisfied with the data, click OK button to create the design storm in the library.

Multiple read-in design storms can be created from multiple storm files. It is available from the Group context menu as shown in section 7.5.4. The new design storms will be added to the select-ed Group without preview. It is convenient when there are a few storm files.

New Chicago Design Storm

To add a new Chicago design storm, click the Chicago button. A default Chicago design storm will be added and shown in the main view with its Basic Information, parameters of A, B, C, and Time Series table and graph.

The parameters of A, B, C can also be copied from IDF curve as introduced at Assign IDF to Chicago Design Storm

New MASS Design Storm

The window for new MASS design storm is shown in the figure below. The window is similar as the one for read-in design storm. The mass curve file SMT file is supported and the total precipitation can be entered.

New Measured

For continuous simulation, the time series data usually comes from monitoring gauges. It is necessary to have the gauge information (e.g. ID and location) included in the Resource Library to enable connect to monitoring database and apply distributed rainfall models. Each gauge may have more than one time-series data which may have different time step or cover different time range.

There are two main steps to add new measurement data: first add a Rain Gauge, and then add Read-In data file to the rain gauge.

To add a new Rain Gauge, first select the parent group in the Library Explorer and then click the Rain Gauge button in the Toolbar.

After the rain gauge is added, add the monitoring precipitation to corresponding gauges from a data file. To do this:

  1. Select the gauge first and then click the Read-in button in New Measured section in the Toolbar.
  2. In the New Monitored Storm – From File window, click the Browse … button in the window to browse the data file to display it in the Data Preview area at the bottom. If Use File Name is checked, the file name will be set as the name of the data item.

The data file should be in a simple CSV file with first column as the time and the second column as the data value. The first row is treated as the column name and will be ignored. The dataset can have any time step, but the time step should be consistent for the entire dataset.

Click OK button on the New Monitored Storm – From File window to add the data to the library. Choose proper Unit and Rain Format for the added rainfall data. The Unit has two options: Metric and Imperial. For VO-SWMM project, all the three types of Rain Format from EPA SWMM5 are supported: INTENSITYVOLUME and CUMULATIVE, but for OTTHYMO project, only VOLUME is supported.

Add Rain Data to Model

Resource Library acts as the sole source of climate data for model. The climate data can be added to the working model by 1) using the Add to model button/menu, 2) using Add All Design Storms to Project menu or 3) drag-and-drop.

To use the Add to model button/menu

  1. Select the climate data in the Library Explorer;
  2. Click the Add to Model button  in the toolbar or choose the Add to model … menu in the context menu;
  3. The Add Storm(s) to Rain Group window will appear. The first one allows to choose one of the existing rain groups to add the design storm. The second one would create a new rain group with the given name.
  4. Click OK to add the design storm to the model. The new rain group will appear in Project Manager.

To use Add All Design Storms to Project Menu

Design storms in a group can be added to a model at once. To do this, select the group in the Library Explorer and choose the Add All Design Storm to Project from the context menu as shown below. All the design storms will be added to the model and the run group is also created for each design storm.

To use the drag-and-drop

  1. Make sure the Project Manager is visible and not covered by Resource Library window.
  2. Select the desired climate data in the Library Explorer
  3. To create a new climate data group, drag it to the corresponding section in Project Manager:
  •  for design storm and long-term precipitation
  • To add the climate data to an existing climate data group, drag it to existing rain group  in Project Manager;
  • The cursor would change to indicate climate data can be added to current location.
  • Release mouse to finish the operation. The climate data will be added to the current location and appears in Project Manager.

SHARING

Resource Library sharing is necessary to:

  • -Make sure the required IDF, design storm and time series data are used;
  • -Save time to prepare and import the data file.
  •  

Resource Library can share any part of the library. An item and its child items will be exported to a separated database, which can be merged to other database with the structure unchanged. Single items (e.g. design storm) can also be exported to data files.

Exporting

To export a branch or an item, use the Export function:

  1. Select it in Library Explorer and click the Export button  in the toolbar or choose the Export menu in the context menu.
  2. In the Save As window, change the default name and file format and then click Save. The default output format is SQLite database.

To export the whole database, click the Save As button  in the toolbar and follow the same procedure.

Importing

To import data from an exported database, click the Import button  in the Toolbar. Browse the right file in the Open window and click OK.

Importing merges the two databases together by only adding different items. Not all the data will be imported into the local library. If the same structure with the same name already exists in the same level, the existing item will be kept. For example, if a top group named Toronto exists in both local library and the imported database, no new group is created and the existing one will be used. These processes will be applied to all items in the imported library.

The process is demonstrated in the figure below. A merged library is generated based on the local library and the imported library. In this case, Group 1 and IDF Group 1 exists in both libraries. The one in the local library will be kept without any change even the one in imported database is different. Sub-group 2 and Design Storm 3 doesn’t exist in local library and is added into the final merged library.

SWMM5 DATA

In the Data section of the Simulation tab, all data types like transect, curves and climatology etc are defined in the same way as SWMM5.

IconCommandIconCommand
TransectsCurves
ClimatologySnow packs
AquifersLID controls
Time PatternsTime Series
Control RulesPollutant
Land UseUnit Hydrographs

Climatology Editor

Click the Climatology button to open Climatology Editor. It consists of different settings.

Temperature

Evaporation

Wind Speed

Snow Melt

Areal Depletion

Transects

Click the Transects button to open the Transects window.

ButtonDescription
Add one transect
Delete selected transects. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of transects
Export all the transects

To add a group of transects, click the Import button . In the pop-up window, change the file type to csv. Navigate to and add the csv file.

VOSWMM allows users to define the csv file of conduit transects in either of the following two formats.

  • Format 1: this format applies to the situation when all the transects share the same stage. The first column is the stage and the following columns are elevations for each transect. The header is the first row. The first cell of the header is the column name of the first column, i.e. stage. The following cells of the header are the NHYD of conduits whose transects are to be assigned.

Download the sample csv file of transects in format 1

  • Format 2: this format applies to the situation when each transect has different stage from others. Each transect defines its own stage and its elevation in two separate columns. The header of each elevation column is the NHYD of the conduit.

Download the sample csv file of transects in format 2

After importing the transect curves, the left and right Bank Station will be automatically calculated based on the csv file. The imported transects will be assigned to the conduits based on the elevation headers.

Curves

Click the Curves button to open the Edit Curves window. Click on the tab of desired curve to edit/add/delete curves

ButtonDescription
Add one curve
Delete selected curves. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of curves
Export all the curves under the selected curve type

Import a Group of Rating Curves

Navigate to Rating curves, and click the Import button . In the pop-up window, select the file type. There are three types of files supported for Rating Curve group importing:

  • File extension as RatingCurve: this type of file is like a xml file. Normally it will be used when the users export the curves into a xml file by using the Export function and send the xml file to other users, so the other users can directly import the xml file.
  • CSV file based on ToNode NHYD: the file is organized in a way, so that the curve will be assigned to outlet links based their ToNode NHYD. More details will be explained below about the csv file format.
  • CSV file based on Outlet Link NHYD: the file is organized in a way, so that the curve will be assigned to outlet links based their own NHYD. More details will be explained below about the csv file format.

CSV File Format of Rating curves

  • Format 1: this format applies to the situation when all the rating curves share the same discharge flow. The first column is the discharge outflow of outlet links. The following columns are the head or depth of the inlet node of the outlet links. The headers of those following columns are the rating curve names. The name of curve will also be taken as the NHYD of either the To Node of the outlet links or the Outlet link themselves, depending on the selection of file types as stated above.

Download the sample csv file of rating curves in Format 1 with headers named as ToNode NHYD

Download the sample csv file of rating curves in Format 1 with headers named as Outlet Link NHYD

  • Format 2: this format applies to the situation when the rating curves have different discharge flow. Each curve defines its own discharge flow and head or depth in two separate columns. The header of every second column is the name of the curve. The name of curve will also be taken as the NHYD of either the To Node of the outlet links or the Outlet link themselves, depending on the selection of file types as stated above.

Download the sample csv file of rating curves in Format 2 with headers named as ToNode NHYD

Download the sample csv file of rating curves in Format 2 with headers named as Outlet Link NHYD

Importing a Group of Curves (Control, Division, Pump, Shape, Storage, Tidal and Weir)

This part will explain the group importing and file formats for curves other than rating curves, including ControlDivisionPumpShapeStorageTidal and Weir. In general, there are two types of files supported for the group importing of those curves:

  • xml file: this type of file has an extension similar to the curve type name, for example, *.StorageCurves. Normally it will be used when the users export the curves into a xml file by using the Export function and send the xml file to other users, so the other users can directly import the xml file.
  • CSV file: the file is organized in a way, so that the curve can be assigned to objects based their own NHYD, except for Control Curves that cannot be assigned automatically. More details will be explained below about the csv file format.

CSV File Format of Curves (Control, Division, Pump, Shape, Storage, Tidal and Weir)

The CSV files define the X and Y values for each type of curve. The X variable is the first variable in the curve editor table. Please use the following table to look up for the X and Y variables for each type of curve.

Curve TypeX VariableY Variable
ControlControl ValueControl Setting
DivisionInflowOutflow
PumpDepthFlow
ShapeDepth/Full DepthWidth/Full Depth
StorageDepthArea
TidalHour of DayStage
WeirHeadCoefficient
  • Format 1: this format applies to the situation when all the curves share the same X value. The first column is the X and the following columns are Y for each curve. The header is the first row. The first cell of the header is the column name of the first column, i.e. the name of X variable. The following cells of the header are the name of curve. As long as the curve type is not Control, the name of curve will also be taken as the NHYD of the object, so the curve can be assigned to corresponding object.

Download the sample csv file of curves in format 1

  • Format 2: this format applies to the situation when each curve has different X from others. Each curve defines its own X and Y in two separate columns. The header of every second column is the name of the curve. As long as the curve type is not Control, the name of curve will also be taken as the NHYD of the object, so the curve can be assigned to corresponding object.

Download the sample csv file of curves in format 2

Snow Packs

Click the Snow Packs button to open the Snow Pack Editor window.

ButtonDescription
Add one snow pack
Delete selected snow pack. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of snow packs
Export all the snow packs

Snow Pack Parameters can be open by clicking the button  next to the Parameters field in the Snow Pack Editor.

Aquifers

Click the Aquifers button to open the Aquifer Editor window.

ButtonDescription
Add one aquifer
Delete selected aquifers. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of aquifers
Export all the aquifers

LID Controls

Click the LID Controls button to open the LID Control Editor window.

ButtonDescription
Add one LID
Delete selected LIDs. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of LIDs
Export all the LIDs

Time Patterns

Click the Time Patterns button to open the Time Patterns Editor window.

ButtonDescription
Add one pattern
Delete selected patterns. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of patterns
Export all the patterns

To view or edit the time pattern data, click the button  next to the Multipliers field in the Time Pattern Editor.

In VO-SWMM, five types of patterns are supported:

  • Monthly: the pattern is defined for the whole year, i.e., Jan, Feb, … Dec
  • Daily: the pattern is defined for the whole week, i.e., Mon, Tue, … Sun
  • Hourly: the pattern is defined for everyday with a time step of 1 hour, i.e. 12 am, 1 am, …, 11 pm (Note: if a Weekend pattern is used, the pattern on the weekend days will follow the Weekend pattern instead of Hourly pattern)
  • Weekend: the pattern is defined for weekend days with a time step of 1 hour, i.e. 12 am, 1 am, …, 11 pm
  • Minute5: the pattern is defined for everyday with a time step of 5 min, i.e. 12 am, 12:05 am, …, 11:55 pm (Note: the 5 min pattern cannot be used in a combination with other patterns. If one 5 min pattern is used in the Inflow Editor at a node, other pattern fields should be kept empty in the Inflow Editor)

Time Series

Click the Time Series button to open the Time Series Editor window.

ButtonDescription
Add one time-series dataset
Delete selected time-series dataset. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of time-series datasets
Export all the time-series datasets

To view or edit time-series data, click the button  next to the Time Series Data field in the Time Series Editor.

Control Rules

Click the Control button to open the Control Rules window. Type in the window the control rules in the same way as in SWMM5 format.

Pollutants

Click the Pollutants button to open the Pollutant Editor window.

ButtonDescription
Add one pollutant
Delete selected pollutants. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of pollutants
Export all the pollutants

Land Use

Click the Land Use button to open the Land Use Editor window.

ButtonDescription
Add one land use
Delete selected land use. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of land use
Export all the land use

Unit Hydrographs

Click the Unit Hydrograph button to open the Unit Hydrograph Editor.

ButtonDescription
Add one unit hydrograph
Delete selected unit hydrographs. Please note to use Ctrl and Shift keys for multiple selection.
Import a group of unit hydrographs
Export all the unit hydrographs

In the field Storm Index type the index of storm in the rain group.

To view or edit the RTK table, click the button  next to the Unit Hydrograph field in the Unit Hydrograph Editor.

To view or edit the Initial Abstraction Depth table, click the button  next to the Initial Abstraction Depth field in the Unit Hydrograph Editor.

GIS TOOLS

With VOSWMM, we are introducing TatukGIS that will be built into the program. No additional GIS license is required to use Tatuk Map. Users can now choose an ArcGIS or TatukGIS map from Home Tab Options. Note that an ArcGIS license is required to use the ArcGIS map.

GIS - Navigation

  • Pan  : move the map
  • Zoom in/out  : zooms into/out from the selected area
  • Full Extent  : show the entire model on the map
  • Zoom Pan  : zoom in/out depending on panning up or down
  • Last Extent  : bring the user back to the last extent view
  • Next Extent  : bring back to current extent if the Last Extent was used to view previous extent
  • Fixed Zoom In  : zooms in on the map at a preset scale, usually into the center of the map
  • Fixed Zoom Out  : zooms out on the map at a preset scale usually from the center of the map

GIS - Edit

Edit 

  • Use Edit tool to change the vertices of polygon.

Move Node 

  • Use Move Node tool to move a node. Click Move Node button. Then, click the node to be moved. Move your mouse to the new location where you want to place the node and click.

Layers Properties 

Layer Properties can be opened from GIS Tools Tab or by Layer context menu. To open from main window click Layer Properties button to open the Layer Properties window.

  • Users can define Symbology and Label for each layer of the map
  • Check on Show Flow Direction box to show arrows for all links
  • Use Reset to Default to reset symbology based on System Type

GIS - Select

Select 

  • To select features, click the Select button  and click the object on the map that you want to select. The selected objects will be highlighted in red.
  • To do multiple selection, hold the Ctrl key and click on the objects or drag and draw a box to select objects.

Select All 

  • Click this button to select all the objects on the active scenario

Invert Selection 

  • Click this button to select all unselected objects on the map

Select Upstream 

  • Click this button and then click a node or link on the map to select all the upstream links and nodes

Select Upstream 

  • Click this button and then click a node or link on the map to select all the donwstream links and nodes

Select Long Section 

  • Click this button and then click a node or link on the map to select all the links and nodes between the intersections.

Refine Selection 

  • Click this button to open a Refine Selection window. Click on the option to select nodes/links/subcatchments according to the option’s conditions.

GIS - Snapping

VO-SWMM provides following snapping tools.

Icon CommandIcon CommandIcon CommandIcon Command
Point
Allows to snap to a point.
EndPoint
Allows to snap to the end point of polyline or polygon. (Available only in ArcGIS)
Vertex
Allows to snap to the vertex.
MidPoint
Allows to snap to the middle point of a polyline
Edge
Allows to snap along the edge of polyline or polygon.
Intersection
Allows to snap to intersection of two geometries

GIS - Map

Add Layers

  • Click Add Layer button  to add GIS layer. In the pop-up window, navigate to and select the GIS files to be added to the map. The layer to be added can be a vector GIS file or a raster file like Digital Elevation Model (DEM).

Query

  • Use the Query tool  to search objects based on user-defined conditions.

Attribute Table

  • Click Attribute Table  to open the attributes table of selected layer.

GIS - System Type Filter

  • Toggle on or off to display or hide certain types of systems.
  • User can define five system types: OverlandStormSanitaryCombined, and Other, in Properties Tab.

MICRO-DRAINAGE TOOLS

Micro Drainage is a modeling methodology for analyzing surface and sewer drainage system performance using the best-available information. Micro Drainage analysis models the precipitation flowing from overland system into the minor system through catch basins acting as outlets from major to minor system. This technique models everything from overland cross sections, culverts, inlet / onsite controls, to inlet blockages, and more. Thus, by modeling to such “micro” level, the accuracy of the model will greatly increase, hence producing much more accurate current and post-development conditions.

Micro Drainage is basically a set of tools that aids the user in modeling a dual drainage analysis in SWMM to extreme level of detail. Data accuracy and preparation is extremely important for the model, all the data being fed to the system should be as clean as possible. The software allows for some GIS editing, including internal shape and attribute editing, added external layers (such as aerial photo, roof layer, etc.) that are not mandatory to create the model are not editable.

Modelling Procedure

There are in general five major steps to create a dual-drainage model by using VOSWMM. In each step, there are tools to facilitate the model setup and tuning process.

DEM Processing

The tools in DEM Processing are used to process the DEM file. The processing results are the basis to create overland system. In general there are five steps in DEM processing: Fill SinksBuild WallsGenerate Flow PathCreate Sag Layer and Assign Layers. User can either use those tools individually or directly use the Run DEM to set up all the steps and run processing. If users want to use the tools individually to go through the whole procedure of DEM processing, it is recommended to run those tools one by one in a sequence as shown below.

Fill Sinks

Fill Sinks is used to remove small imperfections in a surface raster. There are cases where one of the cells is surrounded by cells that have higher elevations. In that case the flow would be stuck at that cell. Fill Sinks will raise the elevation of that cell so the flow could continue onwards. The processed result will be added to the map.

Build Walls

The purpose of using Build Walls tool is to prevent flow from flowing through buildings. Users can give an unreasonably high value in the field of Inner Wall Elevation and the elevation of buildings will be raised to that level in the DEM. The processed result will be added to the map.

Flow Path

Generates the Flow Path layer using the DEMFlow Direction and Flow Accumulation are created through intermediate steps. The detail of the flow path can be adjusted with parameters. In the drop-down list of Burn-in Stream Layer, choose the stream or river to be burned in; otherwise leave this field empty. There are two ways to define discretization level: 1) area 2) # of Cells. They defines the area or the number of cells can be accumulated before it is branched. The less the value is, the more defined the flow path will be. The processed results of Flow PathFlow Accumulation and Flow Slope will be added to the map.

Sag Layer

Use the DEM to determine the locations which are considered sags. This is required to model any sag areas as storage units, or to model any ponds (if pond data was not given). Open the Sag Layer tool. The minimum size of the sag can be set using the Minimum Sag Area parameter.

Assign Layers

Open the Assign Layers tool. Assign the layers from the drop-down list of each field.

To un-assign a layer, choose the empty item in the drop-down list.

Run DEM

This tool is to run all the tools above in one click. The procedure will follow the sequence and recommendations as described above.

Import/Export GIS

This section includes the following tools.

Import Layers

This tool will import GIS shape files and match the attributes of the GIS shape files to the properties used in the VOSWMM model.

Click the Import Layers button. In the pop-up window, the Layer field from the drop-down list chooses the object type to the imported.

Click the button next to the Input Source field to open the import window. Select and add the data source.

The matching between the attributes of the GIS shape files and the properties used in the VOSWMM model can be done either manually selecting in the drop-down list of Mapped Property or loading the mapping file by click the Load button. User can Save the mapping to a mapping file.

The Auto Mapping button will try to match the properties based on the name, but it is at user’s responsibility to check whether the matching is correct or not.

Check the box Show Required Properties Only to show a short list of properties that must be used for the simulation.

In the mapping, the Enumeration Mapping window may also pop up, which asks users to match the categories in a property with the VOSWMM model.

Export Layers

Users can export a layer to a shape file by using the Shape File tool or to a csv file by using the CSV tool in the Import/Export GIS section.

To export the layer, first select the layer to be exported. Then, click the Shape File button or the CSV button.

Nodes and Links

This section includes the following tools.

Add Node/Link

Click the Add Node/Link button to open the window where users can add different types of objects.

Merge Overland Nodes

Select two adjacent Overland Nodes by holding Ctrl and clicking the two nodes on the map. Then, click Merge Overland Nodes button to merge the two nodes.

Create Delineation

The Delineation Node is used to separate catchments and combine several flow paths. A Delineation Node is always connected to a Major Node. To add a delineation node, click the Create Delineation button. A window will pop up. Select the Major Node. The selected Major Node will be shown in the Selected Major Node field on the pop-up window of Create Delineation.

Then click on the flow path to add a delineation node. User can add several delineation nodes to one major node by continuously clicking on the flow path. If users want to add delineation nodes to another major node, click the another Major Node, check the Selected Major Node field is updated and then click on the flow path.

Create Sag Node

Sag area is modelled as a Storage Unit. The Storage Curve is automatically measured from the DEM. To add a Sag Node, click the Create Sag Node button. In the pop-up window, choose the sag layer in the drop-down list of Sag Intersection Layer. If users want to add conduit links between major node and sag node, check on the box Enable Auto Connection. If users only want to add a sag node and make connections later, uncheck the box.

Sag area can be modelled as a Storage UnitVOSWMM can measure the Storage Curve from the DEM.

Click the Start button on the Create Sag Node window. Hover your mouse cursor to the map and the mouse cursor changes to the Edit mode. Click anywhere on the Sag Area. The place where you click will show a red dot.

Move your mouse to the flow path where you want to place the Storage Unit in the sag area. Snap on the flow path. The snapped Vertex is in a red box.

Click to add a Storage Unit node on the flow path. The Storage Curve is automatically obtained and shown in the table of Create Sag Node window,

OVERLAND SYSTEM

This section will include the tools of Assign Catch BasinAuto-ConnectionGenerate Capture Curves, and Generate Catchments

Assign Catch Basin

Click the Assign Catch Basin button to open the Assign Catch Basin window.

Drag and draw a rectangular to select the overland node and the nearby catch basin. The selected objects will be highlighted in red. The number of selected catch basins will be shown in the field Catch Basins. The selected overland node will flash quickly. If several Major Nodes are selected, choose in the drop-down list of Major Node to select the one that the catch basins are assigned to. Selected Major Node will flash quickly on the map.

Then, click Assign on the Assign Catch Basin window. To see the connection line, navigate to the CatchBasinLine layer under the Support group in the layer table of the map and check on the box to turn on the layer.

Auto-Connection

Auto-Connection is a tool used to automatically search and connect catch basin to major nodes based on the selection of criterium.

Generate Capture Curves

Click the Generate Capture Curves button. In the pop-up window, it shows default catch basin types defined by VOSWMM. The Regular tab is the list of rating curves for Regular catch basins and the Sag tab is the list of rating curves for catch basins in Sag.

To add a user-defined catch basin, click the Add button  . Give the TypeMultiplierSlope and Collection. The Name of the new catch basin should be defined as Type – Multiplier – Slope. Then click Save to save the changes. The new catch basin will be added to the data base and can be used for any model.

Each outlet link connecting major node with minor node will have its own Rating Curve, which models the flow rate which the flow will flow from the overland system into the minor system. The rating curve is created based on the type, multiplier, slope of channel, rating curve of each catch basin and the number of catch basins assigned to the major node. Click Generate button. In the pop-up message box, select which outlet links and rating curves to be updated.

The capture curves will be generated as following rules:

a. Determine if the major node is a sag; if its sag, use the sag pre-defined capture curve list. If the major node is a storage unit (sag node), then skip to step 3;

b. Base on the slope of the major channel the major node lies on, get the appropriate curve list, if slope does not match, then use math interpolation to generate a matching curve list;

c. Sum up all the capture curves for each catch basin and assign it to the link.

Generate Subcatchments

Subcatchments will be generated based on major node, delineation node and DEM. Click the Generate Subcatchments button. If there are subcatchments existing in the model, the following message box will show up.

The slopes of generated subcatchments are calculated automatically from the Flow Slope layer assigned in the Assign Layers.

Curves/Transects

This section includes the following tools.

DEM Transect

User can directly obtain the transect of the road from the DEM and assign that to a major system conduit. To do that, first select a conduit on the map. Then, click the DEM Transect button. When the mouse cursor changes to the Edit mode. Click on the one side of the road and the click on the other side of the road. The Assign Channel Cross Section window will pop up with the measured transect table and curve shown in the window.

Cross Section

This tool allows users to obtain the transect of the road by combing the DEM and field survey data. Click the Cross Section button to open the Cross Section window. From the drop-down list, select DEM layer, Survey Point layer and Elevation Field name used by the survey layer. Click on the Map at the desired location where to read the data. If users click on the survey data point, the survey data will be used and written in the transect table on the left of the Cross Section window and plotted on the graph; otherwise, the DEM data will be used. Users can draw a box on the Map to select all the desired survey points.

Users can delete the points from the transect table by selecting the row to be deleted and press the Delete key on the keyboard.

The Left Bank and Right Bank locations will be automatically identified from the transect table and shown as red dots on the graph. Users can also assign Left Bank location to different points by right-clicking on the transect table and select Set as Left Bank Station in the opened context menu. The same procedure is applied for Right Bank location.

Click Edit Parameter button to show the parameter table of the transect and allow users to edit parameters.

Click Assign to Overland Link button and then select overland links on the Map to assign transect curves. For multiple selection, simply hold the Ctrl key while selecting.

Click Save button to save the transect table into Curves database.

Click Restart to clear the selection and transect table.

Fix Irregular Transect

This tool is used to fix the irregular transect to prevent the depth of the irregular transect from being too shallow. Click the button Fix Irregular Transect. In the pop-up window, type the minimum depth requirement for the irregular transects.

Click OK in the Fix Irregular Transect window. The following message box will show up. Users can choose whether to update all the transect curves in the database or just the ones that are used in the model.

The transects will be updated by the following rule. If the depth of existing transects is higher than the minimum depth requirement, then no update will occur. Otherwise, increase the elevation on each side of the transect to meet the minimum depth requirement.

Quick Access Toolbar

To facilitate the use of different tools in VOSWMM, users can add frequently used tools from the Tool Bar ribbon to Quick Access Toolbar and adjust its location either above or below the ribbons. By using the Quick Access Toolbar, users can avoid switching between different tabs in the Tool Bar.

By default, the Quick Access Toolbar is located on the top of ribbon. To move to below the ribbon, open the menu as show in the figure below and click Show Below the Ribbon.

To add a tool from Tool Bar ribbon to Quick Access Toolbar. Navigate to the tool button. Right-click on the button to open the context menu and select Add to Quick Access Toolbar.

Tool Box

By default, all available hydrologic objects are list in Tool Box on the left of VO-SWMM main interface.

Adding objects on to Schematic View

To add one hydrologic object on canvas in Schematic View, drag and drop it on canvas. Then it can be moved to any location.

Adding objects on to Map View

  • Click on Subcatchment to know how to draw Subcatchment on Map
  • Click on Node to know how to draw Node on Map
  • Click on Link to know how to draw Link on Map

SCHEMATIC AND MAP VIEW

  • Turn on/off Schematic VIew: The Schematic View in VO-SWMM project can be turned on/off in the Options of Home. Please follow the descriptions of Home for more details. To see the effect of Schematic View on/off selection, create a new or open a saved project, and the Schematic tab will appear or hide next to the Map tab.

  • Schematic Layout: turn on Schematic view will allow showing the Schematic tab, but it may not give a good layout of objects on the Schematic View. The object commands may overlap with each other on the Schematic View. To arrange commands on Schematic View into a good layout, follow the steps as below
    • INP File Importing: check on the box Generate Layout for Schematic when importing the INP file. Please follow Import and Export VOSWMM Models for more details.
    • New or Existing VOPRJ Projects: on the Map view, right click to open context menu and select Update Schematic Position.

Schematic View

Schematic View is a model focused on the logic relationship of hydraulic objects, not their physical locations or appearance. It will demonstrate in a straightforward way about how those objects are connected with each other. Because of this unique characteristic, it is highly recommended for small modelling practice and quickly trying out of an idea, when GIS location or shapefiles is missing or is not study interest.

Schematic View is widely used in the OTTHYMO projects. Right click on the Schematic View to open the context menu. The functionalities and tools in the context menu operates in a similar way for OTTHYMO and VO-SWMM projects. Follow the link from Visual Otthymo VO – Working with Canvas for more details about how to use the Schematic View.

Map View

Map View has two sections
1. Treeview of Layers and are arranged into Group
2. Content Viewer where user interacts with map

Layer Context Menu

Context menus are available for each layer in Table of Content. These menus are described in the table below. The availability of the menus is depending on type and status of the layer.

MenuCommand
Attribute TableOpen the attribute table of the layer
Remove LayerRemove the layer from map. Not available for hydrologic object layers and support layers.
Move Layer UpMove the layer up one level
Move Layer DownMove the layer down one level
Layer SelectableMake the features selectable. Not available if it’s already selectable.
Layer UnselectableMake the features selectable. Not available if it’s already un-selectable.
Zoom to LayerChange the map extent to show all features in the layer.
Deselect all but thisTurn off all other layers but turn on current layer.
Select all but thisTurn on all other layers but turn off current layer.
Show/Hide ArrowsShow or hide arrows for polyline layer.
Layer Export ShapefileExport current layer to shapefile
Layer Export CSVExport the attribute table to CSV file
File SourceDisplay the file source.
Layer PropertiesOpen the Layer Properties window.
Select All ShapesSelect all shapes in current layer

Map Context Menu

MenuCommand
PanMove map from one side to another side
AddAdd objects on to map SubcatchmentNodeLink
Convert To…Converts object to another object within same Group
Reverse Flow DirectionReverse the direction of Polyline
SelectionSelection of objects
Edit ToolEdit vertices of Polygon Shape
CutCut Polygon shape with a polyline/Arc
DeleteDelete selected object
Update Geometry ParametersUpdate any parameters associcated with Shape Geometry i.e Area of Polygon, Length of Polyline
Update Schematic PositionDraws Layout of objects in Schematic View

Project Manager

The Project Manager is to manage the scenarios, climate data, runs and result plotting in the project. By default, it’s located on the right-hand side besides the Properties tab on the VO-SWMM main interface.

Toolbar

On the top of Project Manager is the tool bar. The buttons are described in the table below.

IconCommandDescription
AddAdd new selected item
DeleteDelete selected item
DuplicateDuplicate selected item
Resource LibraryOpen Resource Library

Tree View

Below the toolbar is a tree view of scenarios and climate data. Items are represented with icons described in Table below. Some of the sections would open the detail information window by double-click, which is also described in table below. For example, the Rain Group Viewer will be opened by double-clicking on Rain Group section.

Items

IconItemIconItemDescription
Scenario SectionScenarioOpen Scenario
Rain Data SectionRain GroupOpen Rain Group Viewer
Run Data Section RunsOpen Run Group Window
Elavation Profiles SectionElevation Profile GroupOpen Saved Elevation Profles
Scenario Comparison SectionScenario Comparison GroupOpen saved scenario comparisons

Context Menu
Context menus are also available in the tree view as shown in Figure below. If one menu item is not applied to current item, it will be greyed out. For example, the Set as Default Scenario menu is only applied to scenario. All the menus are described in Table below.

MenuCommandApplicable Items
Set as Default ScenarioSet selected scenario as default scenario
Add…Add Scenario or Open Resource Library
Edit…Open Scenario or Data Viewer
Rename…Rename the selected item
Delete…Delete Selected Item
Duplicate…Duplicate Selected Item

OBJECT PARAMETERS

Users can view/edit parameters by two ways:

  • Properties tab: By default, Properties tab is place on the right of VOSWMM main interface next to the Project Manager tab.
  • Parameter tables. By default, Parameter Tables are placed at the bottom of VOSWMM main interface.

PROPERTIES TAB

Properties window shows all properties of selected hydrologic object(s) or current scenario. To use Properties window:

  • -Select single hydrologic object in Map View or Schematic View to view and edit all properties of the object
  • -Select multiple hydrologic objects in Map View or Schematic Viewto view and edit common properties;
  • -Deselect all hydrologic objects to view and edit scenario properties.

Categories

  • -Properties are usually grouped in different categories to be easily located.

Tooltip

  • -Tooltip is given for each property to give more detailed information. This is useful for users that are not familiar with OTTHYMO model.

Search

  • -The search bar is located at the top. It will filter properties to only display those with given string.

Editing Property Value

  • -The property value could be edited using the Field BoxDropdown List or Collection Data Table.
  • -The property types can be grouped as: Simple Properties and Collection Data Table
    • Editing Simple Property: simple properties are the properties that are defined by one value or string, for example, pipe length. They can be edited by Field Box and Dropdown List
    • Editing Collection Data Table: prosperities with collection data table are the properties that are defined by a table, for example, rating curves. They can be edited by using Collection Data Table
    • Editing a group of objects: edit the common properties of selected objects

Editing Simple Properties

Simple properties are the properties that are defined by one value or string.

For simple properties, users can edit them by a Field Box or select from a Dropdown List.

  • -When a Field Box is given, users can click in the field box and enter a new value. The change will take effect by using ENTER key or switching to other field.
  • -Dropdown List is available for properties with limited options, e.g. System Type of Subcatchment as shown in the figure below. The property value could be changed by choosing a different option from the list. In some cases other property values may also be affected by the change.

Editing Collection Data Table

Some properties are a collection of data values, e.g. Initial Buildup and Snow Pack of Subcatchment as shown in Figure below. A field box and a button is usually given to this type of property. The field box shows the number of rows or name of assigned (in case of snow pack) in the collection data and is read-only. To change the collection data, click the button  on the right to open the corresponding editor window.

Some collection editor window (for example, Transect Viewer) has a data table and a graph. The data table is usually on the left of the editor window and it lists all the data records. The graph is usually on the right and it plots the data from the table into a chart. Data could be edited directly in the table or pasted from a spreadsheet software. Context menus are provided to help basic edit operations. Data copy and paste could also be done by using CTRL+C and CTRL+V key. The data plot window will update automatically once the data value is changed in the table.

Editing a Group of Objects

There are several ways to select multiple objects:

The common fields of those selected objects will be listed in Properties tab. On the top of Properties tab shows the number of selected objects. Edit the parameters by:

Parameter tables

Parameter Tables window provides a spreadsheet environment for parameter editing. By default, it’s located at the bottom of the main interface.

  • -Table Structure
    Parameters of each type of hydrologic object is displayed in the same table. These tables are arranged in different tabs. The name of the tab is the hydrologic object name and the number of the hydrologic object in current scenario. To view the data table of another type of hydrologic object, click on the corresponding tab.
  • -Select in the Table
    The data record in the data table is connected to the hydrologic object.
    • -Mouse Single-click will highlight corresponding hydrologic object on Schematic View or Map View. Hold CTRL or SHIFT key for Multiple selection. The selected objects will be highlighted on Schematic View or Map View.
    • -Double-click one row in the table would flash and zoom to the hydrologic object on Schematic View or Map View.
    • -Select objects on the Schematic or Map view will also highlight the selected objects in the table.
  • -Sort the Table
    • -Sort by column header: click on the table header to sort the table by that column. Click the header once to sort the table by that column in an ascending way; click again to sort in a descending way. The table could be sorted by any data column. It’s useful to find abnormal values for some parameters, e.g. slope and Invert El.
    • -Sort Selected: click the Sort Selected button to sort the selected objects on the top of the table. First, select objects on the Map or Schematic View, and then, click the Sort Selected button.
  • -Edit in the Table
    Use the table to edit a single object or a group of objects in the same type.
    • -Edit a single object. The value of simple parameters could be edited directly in the table. For parameters that are collection data tables, it’s greyed out and needs to be edited in the Properties window. To edit the parameter in the Parameter Tables, click on that cell and then click once more. When the cell is changed to an editable model, edit the value of that cell.
    • -Copy and Paste. The data in the data table could be copied using CTRL+C or Copy menu in context menu. Data from other sources could also be pasted using CTRL+V or Paste menu in context menu. When a data table is pasted, the first data value will be pasted to current cell and other data values will be pasted to cells after the current cells in horizontal and vertical direction. It’s important to make sure the parameter values in the source is same as the one in the data table before paste.
    • -Batch Editing is possible when the same type of objects are selected on Map/Scehmatic/Parmeters table.
      The parameter values could also be changed by using the Field Calculator opening by choosing the Calculate Field… from the context menu. It’s used to change the parameter value by percentage or fixed value (replace). In Field Calculator window, all available parameters are giving on the left and the formula for property change is on the right. By default, the parameter (data column) highlighted in the data table is added to the formula. It could be changed to implement the changes as shown in Figure below. Click OK button to make the change.

Result Summary Tables

Result Summary Tables window provides a spreadsheet environment for showing/editing SWMM simulation result. By default, it’s located at the bottom of the main interface. It can be toggled on/off via Tool Bar > Home > Windows.

Result Summary Tables will be reset and updated every time a simulation run has been executed. Please refer to Simulation – Run and Options for instruction on how to executing a simulation run.

  • -Table Structure
    • The summary results are grouped by types of hydrologic objects and grouped by Runs of current scenario. These tables are arranged in different tabs by the type of objects. The name of the tab is the hydrologic object type and the number of that type of hydrologic objects in current scenario.
    • Select the Run from the drop-down list of Run to show the summary results of that run. Click on Show All Runs to show results from all runs in the table.
  • -Select in the Table
    The data record in the data table is connected to the hydrologic object.
    • -Mouse Single-click will highlight corresponding hydrologic object on Schematic View or Map View. Hold CTRL or SHIFT key for Multiple selection. The selected objects will be highlighted on Schematic View or Map View.
    • -Double-click one row in the table would flash and zoom to the hydrologic object on Schematic View or Map View.
    • -Select objects on the Schematic or Map view will also highlight the selected objects in the table.
  • -Sort the Table
    • -Sort by column header: click on the table header to sort the table by that column. Click the header once to sort the table by that column in an ascending way; click again to sort in a descending way. The table could be sorted by any data column. It’s useful to find abnormal values for some parameters, e.g. Max Flow.
    • -Sort Selected: click the Sort Selected button to sort the selected objects on the top of the table. First, select objects on the Map or Schematic View, and then, click the Sort Selected button.
  • -Edit in the Table
    Please note that it is not recommended to change simulation results directly in the Results Summary Tables, though some of them can be changed in the Result Summary Tables.
    To change the results of variables select the cell by clicking on it and then clicking once more. None editable values is greyed out in the table.

Error List

The Error List window shows the errors and warnings in the model. By default, it’s located at the bottom of the main interface.

Certain rules apply to an VO-SWMM model. If these rules are not met, a warning or an error will show in the Error List window. The error and warning information is shown in a data table with the error type, hydrologic object NHYD and name, hydrologic object type and error message. An error will be shown as  error and a warning will be  .

Same as Parameter Tables window and Result Summary Tables window, the hydrologic object could be zoomed to by double-clicking on the data record in the table. Note that, when Schematic view is used, a red outline is added to the object icon if an error is found. For example, a Conduit without source node will be shown as  in Schematic view.

The data table could be filtered to only show errors or warnings. Click on the three buttons on the top: Scenario ErrorsCommand Errors and Command Warnings, to switch each message on and off. By default, all errors and warning are shown in the table.

TUTORIALS

The following tutorials will help you get familiarized with VOSWMM about its basic functions and some advanced tools. In each tutorial, there is a step-by-step instruction and a attachment folder that contains models and data to be used.

QUICK START TUTORIAL

This tutorial will introduce basic functions and tools of VOSWMM. You will learn how to create the model structure in map view, set up the simulation and check results.

Click here to download the data package for this tutorial

Step 1: Set up VOSWMM Configuration

Click Options button  in the Home tab.

Set the General page as below.

Click the GIS and set as below

Close VOSWMM and re-start the program.

Step 2: Create a New VOSWMM Project

Navigate to Home tab. Select New SWMM Project from the drop-down list of New Project button

Turn off BaseMap by unchecking the box in the map layer table.

Click the Properties tab in Project Manager which by default is on the right side of the VOSWMM main interface. Make sure the Unit is set as CMS and LinkOffset as Depth.

Step 3: Add Subcatchment

On the left side of the VOSWMM interface, there is a Tool Box which lists all the commands that can be placed on the canvas.

Hover your mouse to the Subcatchment icon in the toolbox. Click the icon and hold the left button of your mouse to drag and drop to your canvas. You will see your mouse cursor change to the Edit mode.

Click on the canvas to draw a polygon. In this example a rectangle

To finish the drawing, mouse Right click will popup Menu, select “Finish Sketch” and the Subcatchment will be added to the canvas.

Use the same way to add the second Subcatchment.

Step 4: Add Junctions and Conduits

Drag and drop the Junction icon to the canvas and your mouse cursor will be changed to the Edit mode.

Click on the canvas where you want to place the Junction node

Hold Ctrl key to add the second node and a Conduit link will be automatically added. Use the same method to add the third Junction node.

Step 5: Add Outfall Node

Drag and drop the Outfall icon to the canvas.

When your mouse cursor changes to the Edit mode, click on the canvas where you want to place the Outfall node.

Step 6: Add Conduit to Outfall Node

Drag and drop the Conduit icon to the canvas.

When your mouse cursor changes to the Edit mode, first select the node where the conduit start, i.e. the From Node. The selected node will be highlighted in red.

Then, select the node where the conduit ends, i.e. the To Node. A conduit link will be added.

Step 7: Add Labels by Layer Properties

Open Layer Properties from the GIS Tools tab

In the Layer Properties window, click Junction under the Node group in the layer table and select the Label tab

Check on Display Label. In the drop-down list of Attribute, select NHYD. Then, click Apply.

Keep the Layer Properties window open. Following the same way as junction label, add NHYD label to SubcatchmentConduit and Outfall. Close the Layer Properties window once finished. The map will display like this:

Step 8: Edit Subcatchment Properties

In order to connect subcatchment to a node, select Subcatchment NHYD 4. In the Properties tab, navigate to Outlet field and type the NHYD of the Node that the subcatchment is connected to. In this case, type 6.

Following the same way, make Subcatchment NHYD 5 connected to the Junction NHYD 9.

To view the catchment connection, navigate to the layer table of the map and check on the layer CatchmentLine under the Support.

Hold Ctrl key to select the two catchments. In the Properties tab, change the System Type to Blank.

Step 9: Edit Node Properties

The following table gives the properties of nodes:

NHYDInvert [m]Max Depth [m]Average Dry Weather Flow [cms]
620030.5
71803.5NO
91502.80.1
11110NANA

Select Junction NHYD 6. In the Properties tab, in the Invert El. type 200 and in the Max. Depth type 3.

Open the Inflow Editor by clicking the button  next to the Inflows field.

In pop-up Inflow Editor window, navigate to the Dry Weather Flow section and type 0.5 as the Average Value.

Open the Time Pattern Editor by clicking the button  next to the field Time Pattern 1

Click the button  to add a time pattern. In the drop-down list of the Type, choose Hourly.

Click the button  next to Multipliers field in the Time Pattern Editor. In the opened table, click the first cell of Multiplier column.

Copy-paste the following time pattern into the table

TimeMultiplierTimeMultiplier
12 AM0.67512 PM1.375
1 AM0.631 PM1.039
2 AM0.5762 PM0.974
3 AM0.5043 PM1.247
4 AM0.5154 PM1.07
5 AM1.0315 PM0.923
6 AM1.0866 PM0.835
7 AM1.1137 PM1.1
8 AM1.4248 PM1
9 AM1.4369 PM0.907
10 AM1.68910 PM0.9
11 AM1.69411 PM0.758

The Time Pattern table will be updated as below. To save the change, click OK of the Time Pattern table, then the OK of the Time Pattern Editor and the OK of the Inflows Editor.

Following the same method to edit Invert El and Max. Depth for other nodes.

For the Inflows of Junction NHYD 9, open the Inflow Editor, type 0.1 as the Average Value in the Dry Weather Flow section. In the drop-down of Time Pattern 1, select “TimePattern 1*.

Step 10: Edit Conduit Properties

Hold Ctrl key to do multiple selection of the three conduits on the canvas. The selected items are highlighted in red.

In the Properties tab, click the button  next to the Shape field to open the Shape Editor. Change the Full Depth to 1.5 m.

Keep the three conduits selected. In the Properties tab, change the System Type to Blank.

Step 11: Add Storm Data to Model

Navigate to Simulation tab and click the Resource Library button.

In the pop-up Resource Library window, navigate to and select “2 Year 6 Hour AES (Bloor, TRCA)”. Then, click the Add to Model button. A dialog window will pop up. Choose the first option “Create rain group and simulation run fro selected storms”

Click OK. A message box will show.

Close the message box by clicking OK and close the Resource Library. Check the Project Manager. The storm has been added to the Rain Data group and a run is created under the Run group.

Step 12: Set Run Options and Run the Simulation

Double click “Scenario 1 – 2 Year 6 Hour AES (Bloor, TRCA)” under the Runs group in the Project Manager.

The run setting page will pop up. Make sure the time and the date are set as below. Click the Run button to finish the simulation.

A successful run will give a message as below.

You can also find that the word “[Completed]” is added behind the run “Scenario 1 – 2 Year 6 Hour AES (Bloor, TRCA)” under the Runs group.

Step 13: View Simulation Summary Results

The Hydraulic Result Tables list the summary results of all the objects. Click the Hydraulic Result Tables tab and then click Conduit (3) tab. In the drop-down list of Run in the Hydraulic Result Tables to choose the simulation run.

  • Select one row in the table. The selected object will be highlighted on the canvas.
  • Double-click on the row to zoom into the selected object.
  • Click on the header of one column to sort the table by that column.

Navigate to the Simulation tab. In the drop-down list of the Output section, select the run. Click Output Results to view the summary results in a text file format.

Step 14: View Simulation Detail Results

Select objects on the map canvas, for example, the Conduit NHYD 8 and 12. Make sure you choose the simulation run in the drop-down list in the Output section under the Simulation tab. Then, click Plot Results under the Simulation tab.

The Plot Result window displays the Graph of time-series plotting of the selected objects. The Statistics table is shown below the Graph. Click the Export button to export time-series results in CSV files.

Note: the result shown below is for demonstration purpose. Your results can be slightly different from the figure below.

Close the Plot Result window. Click the Result Table under the Simulation tab.

The table of time-series results for selected objects will show. Sort the table by clicking the column header.

Step 15: View Elevation Profile

Select Junction NHYD 6 and 9 on the canvas. Then, click the Elevation Profile button in the Simulation tab.

The Elevation Profile will show in a new tab.

  • if Lock Selection box is unchecked, the profile plotting will be updated with the selection on the map. If you do not want to update the plotting of elevation profile, check the Lock Selection box.
  • scroll mouse middle wheel to zoom into the graph
  • click on the node/link column to zoom into that object on the graph and show the Properties tab of that object

Step 16: Save Project

Click the Save Project button in the Home tab.

In the pop-up window, navigate to the folder where you want to save your project and give a name in the File Name field. Click Save.

Step 17: Export INP File

Click the File button on the left upper corner. Navigate to the Export and choose Export to SWMM INP File. In the pop-up window, choose the location where to put the INP file.

DUAL-DRAINAGE MODEL

During raining event, the rain water will flow on the street and a part of them will entre sewer system, i.e. storm sewer and sanitary sewer. Therefore, it is important to model the flow on the street and combine the hydraulic simulation of overland system with the underground sewer systems, which is called “Dual-Drainage Model*. In this tutorial, we will practice how to create a dual-drainage model using VOSWMM.

To set up VOSWMM Configuration, follow the instruction as described in Quick Start TutorialSet Up VOSWMM Configuration

Click here to download model package for this tutorial

Step 1: Set up VOSWMM Configuration

In order to use the tools swiftly, users can add the frequently used tool to the Quick Access Toolbar, which can reduce the switching between different tabs. To add the tool to the Quick Access Toolbar, navigate to the tool in the tool bar, for example, the Select tool in the GIS tab. Right-click on the Select button to open the context menu. Click Add to Quick Access Toolbar.

Then, the Select tool will be added to the Quick Access Toolbar. Following the same way to add PanFull Extent and Add Layer to the Quick Access Toolbar. By default, the Quick Access Toolbar is on the top of the ribbon. To move it below the ribbon, open the drop-down list and click Show Below the Ribbon

The toolbar will look like this:

Step 2: Create a New VOSWMM Project

Navigate to Home tab. Select New SWMM Project from the drop-down list of New Project button

Click the Properties tab in Project Manager which by default is on the right side of the VOSWMM main interface. Change the Unit to CMS and the LinkOffset to Elevation.

Click the Save Project button in the Home tab. In the pop-up window, navigate to the folder where you want to save your project, for example, “…\model\practice” and give a name in the File Name field, for example “dual_drainage”. Click Save.

Step 3: Add DEM and Building Layer

To add the DEM file, click the Add Layer button either from the GIS tab or from the Quick Access Toolbar.

In the pop-up window, select the DEM file “…\Dual Draiange System\Data\DEM.tif” and click Open to add the DEM file to the map layer.

The DEM will be shown under the Imported group in the map layer table. Right-click on the layer “DEM” to open the context menu and click Zoom To Layer.

The map will display as below.

Uncheck the layer BaseMap to turn off the base map.

Following the same way, use the Add Layer tool to add the shapefile of the building layer “…\Dual Draiange System\Data\Buildings.shp”. In order to move the building layer above the DEM, right-click the layer “Buildings” and select Move Layer Up.

The map will display as below:

Step 4: Add DEM and Building Layer

The DEM processing will use the tools in the DEM Processing section in the Micro-Drainage tab. For more information, please refer to User’s Manual – DEM Processing

A. Fill Sinks

Navigate to the Micro-Drainage tab. Click the Fill Sinks button in the DEM Processing section. In the pop-up Fill Sinks window, in the DEM Layer field choose the imported DEM “w001001”. In the Output Folder field, choose the location where you want save your file, for example, “…\model\practice\FilledDEM”. Click OK.

After the processing, a new layer called “FilledDem” will be added to the map layer table under the Imported group.

B. Build Walls

Click the Build Walls button in the DEM Processing section in the Micro-Drainage tab.

In the Build Walls window, set the tool as below. The Output Folder is “…\model\practice\WalledDEM”. Click OK.

C. Flow Path

Open the Flow Path tool from the DEM Processing section in the Micro-Drainage tab. Set the tool parameters as below. The Output Folder is “…\model\practice\FlowPath”. Click OK.

A new layer group will be added to the map layer table.

D. Sag Layer Generation

Open the Sag Layer tool from the DEM Processing section in the Micro-Drainage tab. Set the tool parameters as below. The Output Folder is “…\model\practice\Sag”. Click OK.

Turn off raster layers and keep “SagIntersect” and “flowpath” layers and move the layer group “FlowPath” above the “imported” layer group. The map will display like this:

E. Assign Layers

Open the Assign Layers tool from the DEM Processing section in the Micro-Drainage tab. Assign the layers as below.

Step 5: Import Sewer Manholes

Click the Import Layers button from the Micro-Drainage tab.

In the pop-up window, the Layer field chooses Junction from the drop-down list.

Click the button next to the Input Source field to open the import window.

Select “…\Data\Manhole.shp” and click Open.

Then, click the Load button on the Import Required Layer window.

In the pop-up window, choose and Open the mapping file “…\Data\Junction.mapjunction”

The layer properties will be automatically mapped with the model properties. Click Import.

In the pop-up warning message window, click Overwrite.

In the Enumeration Mapping window, make sure mapping the categories as below and click OK. Then, the Junction layer will be successfully imported.

Step 6: Import Sewer Pipes

In the Import Required Layer window, select Conduit in the Layer drop-down list. In the Input Source field, choose the shapefile “…\Data\Sewers.shp”. Click Yes on the warning message to clear the current mapping.

Click the Load button on the Import Required Layer window. Choose and Open the mapping file “…\Data\conduit.mapconduit”. The Import Required Layer window will be updated as below:

Click the Import button on the Import Required Layer window. Choose Overwrite in the pop-up warning message.

In the Enumeration Mapping window, map the category property as below and click OK. Then, the sewer Conduit will be imported.

Step 7: Import Catch Basin

Following the same way as importing sewer manhole and pipe, import catch basin by setting the Import Required Layer window as below. The Input Source is “…\Data\Catch_Basins.shp” and the mapping file is “…\Data\CatchBasin.mapcatchbasin”.

Close the Import Required Layer window.

Step 8: View and Adjust Layer Properties on the Map

After importing the sewer manholes, sewer pipes and catch basins, the map will display as below:

  • To Zoom In and Zoom Out the map, scroll mouse wheel.
  • To move the map, there are two ways. The first way is to use the Pan tool  , which can be found from the GIS tab or the Quick Access Toolbar. The second way is to hold the mouse wheel to change the mouse cursor to the Pan mode .

Turn on the flow path direction

Navigate to the “flowpath” layer in the layer table of the map. Right-click the layer to open the context menu. Select Show/Hide Arrow.

Then flow path direction will be shown with arrows.

Step 9: Add Overland Nodes and Conduits

In VOSWMM, the overland flow is modelled by creating node and conduit on the ground. The hydraulics of those nodes and conduits are modelled by SWMM5 engine. In that way, the flow rate and depth can be obtained.

There are several rules recommended that users can follow when adding overland nodes and conduits.

  • It is recommended to place overland nodes on the flow path
  • It is recommended to make overland conduits match with flow path direction.

Regarding the locations of overland nodes, it is recommended to add overland nodes:

  • at the starting point of the flow path
  • when there is a catch basin / inlet along the flow path
  • when there is a sag / pond area
  • when there is a sewer manhole
  • on the crest of sag/pond area
  • at a junction point when two flow paths meet
  • when there is a change in cross sections
  • when there is a change in slope
  • when there is a change in roughness of the road / ground
  • at the outlet point

In this tutorial case, the overland flow path can be seen as three branches along with the minor system: the east branch, the south branch, and the north branch.

To add a major system, first change the default parameter of node and link. Click the Default Values button in the Simulation tab. In the pop-up window, navigate to the Nodes / Links tab and set the parameters as below.

Zoom into the upstream location, which is on the right bottom of the map, of the south branch. Drag and drop the Junction icon from the Tool Box to the Map canvas.

When the mouse cursor changes to the Edit mode, hover the mouse cursor to snap on the flow path. The snapped Vertex is shown in a red box.

Left click the mouse to place the first node on the main stream of the flow path and close to the manhole.

Move the map to down stream by holding and dragging the mouse middle wheel. Hold Ctrl key and place the second node on the main stream of the flow path and close to the catch basin. A conduit will be created automatically.

Following the same way to add the third major node on the sag area entrance, which also has two manholes nearby. A conduit will be created automatically by holding Ctrl key.

Following the same procedure to add nodes and links for the major system of the west and the north branches. The figure below highlights the major links in red.

Step 10: Add and Connect

Sag area can be modelled as a Storage UnitVOSWMM can measure the Storage Curve from the DEM.

A. Add storage unit

Zoom into the sag area at the downstream of the overland conduits, which is the location where all the three branches merge.

Click the button Create Sag Node in the Micro-Drainage tab.

In the Create Sag Node window, make sure that the box Enable Auto Connection is unchecked.

Move the Create Sag Node window aside the map to see the sag area. Click the Start button on the Create Sag Node window. Hover your mouse cursor to the map and the mouse cursor changes to the Edit mode. Click anywhere on the Sag Area. The place where you click will show a red dot.

Move your mouse to the flow path where you want to place the Storage Unit in the sag area. Snap on the flow path. The snapped Vertex is in a red box.

Click to add a Storage Unit node on the flow path. The Storage Curve is automatically obtained and shown in the table of Create Sag Node window,

B. Connect overland node and storage unit

The overland Junction and the Storage Unit are connected by a Conduit link. Drag and drop the Conduit icon from the Tool Box to the Map canvas. The mouse cursor will change to the Edit mode.

To add a Conduit, first select the node where the Conduit starts, i.e. the From Node and then select the node where the Conduit ends, i.e. the To Node. In this tutorial case, click the last overland Junction on the north branch.

Then, click the Storage Unit. A Conduit link will be added to the map.

Following the same procedure to add major conduits from the south branch downstream node to the storage unit and from the west branch downstream node to the storage unit.

Step 11: Add and Connect Outfall Node

Add a major system Junction node at the exit of the sag area.

Drag and drop Outfall node from the Tool Box to the Map canvas. The mouse cursor changes to the Edit mode.

Click after the exit of the sag area on the flow path to add a Outfall Node.

Drag and drop Conduit link from the Tool Box to the Map canvas. The mouse cursor changes to the Edit mode.

Add a Conduit link from Storage Unit node to major system Junction node at the sag exit and from the major system Junction node at the sag exit to the Outfall node.

Step 12: Adjust Properties of Overland Objects

Navigate to Parameter Tables below the VOSWMM main interface. Click the Junction tab. Sort the table by click the column header of System Type. You can adjust the window size to show more rows in the table. Select all the Junction in the table whose System Type is Overland. Select the first row whose System Type is Overland. Then, hold Shift key and select the last row whose System Type is Overland.

In the Properties panel on the right side of the VOSWMM main interface, check on the Delineate box in the Properties tab

For the overland Storage Unit, check on Delineation box and change the IsSag field in the Properties tab to 1.

From the Parameter Tables, sort the Conduit by System Type and select all the Conduit whose System Type is Overland.

In the Properties tab, click the button  next to the Shape to open the Shape Editor window.

Click the button  next to the Transect to open the Transect Editor. Select MinLocalStA-18.5m in the Name table on the left. Click OK to close the Transect Editor. Click OK to close the Shape Editor.

Step 13: Assign Catch Basin

Zoom in to the upstream part of the south branch. Click the Assign Catch Basin button in the Micro-Drainage tab.

The Assign Catch Basin window will pop up.

Drag and draw a rectangular to select the overland node and the nearby catch basin. The selected objects will be highlighted in red. The selected overland node will flash quickly.

Then, click Assign on the Assign Catch Basin window. To see the connection line, navigate to the CatchBasinLine layer under the Support group in the layer table of the map and check on the box to turn on the layer.

Following the same way to assign the catch basins for all the overland nodes including Junctions and Storage Unit. Hold the mouse middle wheel to move the map. For the Catch Basin within the sag area, assign them to the Storage Unit.

Step 14: Add Outlet Link

Use Outlet to model the flow entering from overland to sewer system. Add outlet links for all the sanitary manholes. For the storm manholes, when the major node has catch basin assigned, add outlet link from the major node to the storm manhole.

Zoom in the map to the upstream part of the south branch. Drag and drop the Outlet icon from the Tool Box to the Map.

The mouse cursor will change to the Edit mode. Select the overland junction, i.e. the From Node of the Outlet link, and then select the sanitary manhole, i.e. the To Node of the Outlet link. A Outlet link will be added to the map. Following the same method to add Outlet links for the storm manhole.

Finish adding Outlet links for all the overland nodes.

Step 15: Add Delineation Nodes

The delineation node is used to cut catchments into pieces and bring several branches into one subcatchment.

Delineation Node is always connected to a Major Node. To add a delineation node, click the Create Delineation button. Move and zoom in the map to the upstream of the south branch. Select the Major Node. The selected Major Node will be shown in the Selected Major Node field on the pop-up window of Create Delineation.

Then click on the flow path to add a delineation node. It is recommended to add the delineation node to be perpendicular as much as possible to the flow path. To see the connection line between the major node and the delineation node, check on the layer DelineationNodeLine under the Support layer.

Keep the window of Create Delineation open. Pan the map by holding the mouse middle wheel to next major Junction node and following the same way as above to add Delineation Nodes to all overland Junctions. When another Major Node is selected on the map, check the Selected Major Node field is updated in the window of Create Delineation and then click on the flow path to add a delineation node. Do not add delineation node to the storage unit and the overland junction at the sag exit.

Step 16: Generate and Import Capture Curve

Select all the Outlet links in the Parameter Tables and change the Rating Curve field in the Properties tab to TABULAR_DEPTH.

Generate Capture Curves

The capture curves can be calculated based on type, multiplier, slope and curves of catch basins. Therefore, they can be used for modelling the flow going into the storm sewer.

Click the Generate Capture Curves button in the Micro-Drainage tab.

Click Generate in the pop-up window. The Rating Curves of the Outlet links will be automatically calculated based on the Catch Basin properties and assigned to the Outlet links.

Import Capture Curves

The capture curves generated above can be used for the Outlet link connected to the Storm sewers, but for the Sanitary sewer to model the infiltration and inflow (I/I) we will use the specific rating curves by importing an csv file.

Click the Curves button in the Simulation tab. Click the Rating tab in the Edit Curves window.

Click the Import button . In the pop-up window, change the file type to CSV File. Navigate to the csv file “…\Data\capture_curve.csv”. Double click the file to import and assign the rating curves to the model.

Step 17: Generate Subcatchment

Click the Catchment Generation” button in the *Micro-Drainage tab.

In the pop-up message box asking about removing all existing catchment areas, click OK. The Subcatchment will be created and added to the map.

Step 18: Add Storm Data to Resource Library

Click the Resource Library button under the Simulation tab.

In the pop-up Resource Library window, click the Top Group button to add a new group.

In the Name field, give a new name to the group “practice”. Press Enter key to confirm the name.

Click the Read In button in the New Design Storm section to pop up the New Design Storm – From File window.

Click the Browse… button next to the File Path field. Change the data type of CSV file. Select the rain data at “…/Data/RainData.csv”. Click Open.

The data will loaded to the New Design Storm – From File window.

Click OK. The storm data is added to the Resource Library. Click the Save button  to save the Resource Library

Step 19: Add Rain Data to Model

Selected the storm data “RainData” that was added to the Resource Library in the previous step. Click the Add to Model button. In the pop-up window, select the first option and click OK.

A successful message will show. Click OK to close the message box. Close the Resource Library window. Check the rain data is added to the Rain Data group in the Project Manager and a run is created automatically under the Runs group.

Step 20: Debug Model Errors

Navigate to the Error List tab, which is located below the map. Command Errors and Scenario Errors in the Error List tab will prevent user from running the model, but user may still be able to run the model with Command Warnings.

Un-check the *Command Warnings” to see the errors.

These two errors are caused because these two nodes do not have a link out. To fix the bugs, double click on the row of the error (e.g. NM-N13-0266) to zoom into that node on the map. Add an Outfall node to the downstream of the error node, and then add a dummy sanitary Conduit from the error node to that outfall node.

Following the same way to debug the second error, which is related to the exit of storm system. Double click the error to zoom into the error location. Add an Outfall node and a storm Dummy Conduit. Copy the Invert El of the error storm Manhole “ST2359” to the Invert El of the Outfall node and the Inlet Elev and Outlet Elev of the storm Dummy Conduit.

Step 21: Run the Simulation

Double click the run “Scenario1 – RainData” under the Runs group in the Project Manager. In the pop-up window of run options, make sure the settings be the same as below. Click the Run button to run the model.

A successful message will show after the run is completed. Click OK to close the message. The run under the Runs group will also be denoted with [Completed] if the run is done successfully.

Step 22: View Simulation Results

Select one object on the map. Navigate to the Simulation tab. Click the Plot Results button. Select RunType and Variables in the drop-down lists of the Plot Results window. The Graph and the Statistics will be displayed accordingly. Click the Export button to save the result as a CSV file.

Note: the result shown below is the depth of the storage unit. The result is for demonstration purpose. Your results can be slightly different from the figure below.

For other result viewing functions, please refer to the sections in Quick Start Tutorials:

Step 23: Run Surcharge Analysis and Flood Plain Analysis

Surcharge Analysis

Click the Surcharge Analysis button. In the pop-up window, in the drop-down list of Run select the “RainData”. Click Run.

The Surcharge Analysis result will be updated to the nodes and links in the Parameter Tables and Properties tab.

For the minor system, there are four levels from the surcharge analysis result:

  • No surcharge: the node is not surcharged. By default, the symbol is green circle dot.
  • Surcharge Below Freeboard 2: the node is surcharged, and the water level is below Freeboard 2. By default, the symbol is yellow circle dot.
  • Surcharge Between: the node is surcharged, and the water level is between the Freeboard 2 and Freeboard 1. By default, the symbol is orange circle dot.
  • Surcharge Above Freeboard 1: the node is surcharged, and the water level is above the Freeboard Level 1. By default, the symbol is red circle dot.

For the major system without reverse driveway, there are two levels from the surcharge analysis result:

  • No surcharge: the node is not surcharged
  • Surcharge: the node is surcharge and the water depth is above the value given in the field Surcharge Level under the Major Node section

Flood Plain Analysis

Click the Flood Plain Analysis button in the Simulation tab. Set up the parameters as below and choose the file path and file name (“floodplain”) in the Output Filepath field to save the flood plain.

Click OK run the flood plain analysis. Once it is done, a flood plain raster in the name give in the Output Filepath, in this case “floodplain”, will be added to the layer table of the map. To see the generated Flood Plain, un-check the subcatchment layer, sag layer and other raster layers on the top of the flood plain raster, and hide flow path arrows.

Step 24: Add Satellite Photo

Click the Add Layer button either from the GIS tab or from the Quick Access Toolbar.

In the pop-up window, select the DEM file “…\Dual Draiange System\Data\satellite_photo.tif” and click Open to add the DEM file to the map layer.

The map will be displayed with satellite photo.

Step 25: Save Project and Export INP File

Click the Save Project button in the Home tab.

Click the File button on the left upper corner. Navigate to the Export and choose Export to SWMM INP File. In the pop-up window, choose the location where to put the INP file.

POST-DEVELOPMENT RUNOFF

This tutorial demonstrates how to construct a hydrologic model of an urban catchment and use it to compare stormwater runoff under both pre- and post-development conditions. Only catchment runoff will be considered. Models of this type are very common in practice. Many local stormwater ordinances and agencies require that new developments limit peak runoff flows relative to those under pre-development conditions.

Click here to download the data package for this tutorial

Pre-development

The figure below is a contour map of a 29-acre natural catchment area where a new residential development is planned. This undeveloped area is primarily pasture land that has a silt loam soil type.

 

Post-development

The following figure shows the proposed development for this site. With the exception of the depressions located in the parkland area, no major changes in topography are expected. This implies that future streets will, in general, follow the natural slope. However, the residential lots will be graded toward the street at a slope of 2% so they can drain easily. The developed site will drain to a stream through a culvert under the street located on the southeast side of the site, which is considered to be the outlet point of the catchment.

 

Step 1: Set up VOSWMM Configuration

Because this tutorial is only focused on the stormwater runoff at the catchment outlet, we will build the model on the Schematic view, instead of Map view. Users can use Schematic view if they are interested in the relationship and connection of objects, instead of their physicals locations on the map.

Please make sure the Configuration setting in the Home toolbar is set as below:

Step 2: Create a New VOSWMM Project

Navigate to Home tab. Select New SWMM Project from the drop-down list of New Project button

Right-click on the “Scenario1” under Drainage Network Scenarios in the Project Manager tab. In the context menu, choose Rename.

The name of “Scenario1” will become editable. Give a new name “undeveloped”.

Click the Properties tab in Project Manager which by default is on the right side of the VOSWMM main interface. Make sure that the Unit is set to CFS, the LinkOffset is Depth and the Show Background is checked on.

Step 3: Undeveloped Site - Add Background Image

To help facilitate the placement of drainage-system objects, SWMM can utilize an image as a backdrop behind a project’s study area map. This image is typically a site map of some kind with known dimensions. Any bitmap image file (BMP extension), JPEG image file (JPG or JPEG extension) can be used as a backdrop. These images would typically come from a CAD or GIS drawing of the site or perhaps from an electronically published or scanned topographic or street map.

To add the background image, right click on the empty space on the Schematic view to open context menu. Navigate to Background -> Change Background.

In the pop-up window, navigate to and double click on the background image for undeveloped site at “…\backgound\undeveloped site.jpg”. The background image will be added to the Schematic view. Scroll the mouse wheel to zoom in/out the image until it is properly displayed on the Schematic view.

Step 4: Undeveloped Site - Add Objects to Schematic View

According to the site’s contour map, its topography is fairly homogenous and no well-defined channels exist within the basin which means that mainly overland flow takes place. There are no roads or other local impervious areas and the type of soil is similar throughout the watershed (Sharpsburg silt loam). Therefore, no disaggregation is required based on the spatial distribution of catchment properties, and therefore, we will add one Subcatchment command for the undeveloped condition.

Then, we will add one Outfall node at the outlet of the Subcatchment. The Outfall node will be connected to the Subcatchment to receives runoff from the Subcatchment. The Outfall node can be considered as a monitoring node where later we will compare the runoff between pre- and post-development conditions.

Add a subcatchment

To add a Subcatchment, drag and drop the Subcatchment command from the Tool Box to the desired location on the Schematic view.

Add a outfall node

To add a Outfall node, drag and drop the Outfall node command from the Tool Box to the desired location on the Schematic view.

Connect subcatchment and outfall

To add a connection from the Subcatchment to the Outfall node, move the mouse on top of Subcatchment. When the mouse cursor changes to a cross, click and hold the mouse, and drag towards Outfall node. When moving the mouse cursor close to Outfall node, release the mouse to add a connection line.

Step 5: Undeveloped Site - Assign Object Properties

Outfall node properties

To view and edit the properties of the Outfall node, click on the Outfall on the Schematic view and then click on the Properties tab which is by default on the right of the VOSWMM main interface. Change the NHYD and the Name as “O2” and “Outfall – O2”. To edit the elevation of this Outfall node, type 4962 in the field Invert El.. Make sure the Properties of the Outfall node are the same as in the figure below.

Subcatchment Properties

The properties assigned to the Subcatchment S1 are summarized in Table 1-1. The Infitration method is HORTON.

 

To view and edit the properties of the Subcatchment, click on the Subcatchment on the Schematic view and then click on the Properties tab. Change the NHYD and the Name as “S1” and “Subcatchment – S1”. Edit Properties following the values given in the table above.

To edit the HORTON infiltration parameter, click the button next to the Infiltration field. In the pop-up window, set the parameters as below. Click OK to save changes and close the window.

Step 6: Add Rain Data

The datasets of design storms can be found in the folder “…\design storm” in the downloaded package of this tutorial.

Click Resource Library button  in the Simulation toolbar. Create a top group by clicking the Top Group button  in the toolbar of the Resource Library window and name the new group as “Post-development Runoff”

Right click on the group “Post-development Runoff”. In the opened context menu, select Add Design Storm – From Multiple Storm Files.

In the pop-up window, navigate to the folder that has the three design storms. Select all the three design storms and click Open.

A successful loading message will show up. Click OK to close that window. You can view the imported design storms in the Resource Library window.

To add the designs storms to the model, right click on the group Post-development Runoff. In the opened context menu, select Add All Design Storms to Project. Click OK in the successful message. Click Save in the toolbar of Resource Library window to save the Resource Library.

The design storms are added to the Project Manager tab under the Rain Data group, and three runs are automatically created under the Runs group.

Step 7: Undeveloped Site - Set up Analysis Option and Run Simulation

Table 1-3 (SWMM Application Manual, EPA, Sept. 2016) shows the analysis options used to run the model.

The Flow Unit was set in Step 2: Create a New VOSWMM Project. The other analysis options in the table above can be set in Run Options and SWMM Options windows.

SWMM Options

Click the Engine Options button in the Simulation toolbar. Set up parameters in the General tab as below.

Click the Time Step tab and set parameters as below.

Run Options and Batch Run

Click the Run button in the Simulation toolbar to open the Batch Run window.

Click the button  to open the Setting of “2-yr” run. In the pop-up window, set parameters as below. Click OK to save the settings and close the window. Follow the same way to set the run options for “100-yr” and “10-yr”.

To run the simulation for all design storms, click Run in the Batch Run window to run the batch simulation in the undeveloped scenario. Three runs will be made, one for each design storm event.

Step 8: Undeveloped Site - Model Results

To plot the hydrograph, select the Outfall node O2. Click the Plot Results button in the Simulation tab. In the pop-up window, select the rain event for which you want to view the results from the Run drop-down list. Change Variables to Total Inflow.

We can also view the results in the Result Summary Tables. Click the Result Summary Tables tab, which by default is located at the bottom of the VOSWMM main interface. Click Subcatchment tab and check on Show All Runs to list the summary results of all runs.

From the Result Summary Tables of the Subcatchment, we can see that the increasing rate of runoff volume Runoff Vol. from 2-year return period to 100-year return period is faster than that of rainfall volume Tot. Precip.. The reason could be that the soil is more saturated in larger event.

Step 9: Developed Site - Model Setup

Post-development condition usually means an increase of imperviousness and decrease of overland flow path. Those changes could increase the total runoff from the catchment and make sharply increased peak flow.

Create a New Scenario by Duplicating an Existing Scenario

Click the “undeveloped” scenario under the Drainage Network Scenarios in the Project Manager. Click the Duplicate button  at the top of the Project Manager. In the pop-up Duplicate Scenario window, change the Name to “developed” and make sure that all the checkboxes in the Include column are checked on. Click Duplicate. A duplicated scenario will be added to the Project Manager and open in the Schematic view. Scroll the mouse wheel to zoom in/out the Schematic view until the new scenario is properly displayed.

The duplicate scenario has the same Outfall node and Subcatchment as in the “undeveloped” scenario. It also has the same Background ImageRuns and analysis option.

Change Background Image

The background image was duplicated from the “undeveloped” scenario, so we should change it with the image for “developed” scenario. The background image of “developed” scenario can be found in the folder “…\background\developed site.jpg”.

To change the background image, right click on the empty space on the Schematic view to open the context menu. Select Background -> Change Background…. In the pop-up window, choose and add the image for “developed” scenario to the Schematic view. For more details, follow the instruction in Step 3: Undeveloped Site – Add Background Image

Add Objects to Schematic View

As explained in SWMM Application Manual (EPA, Sept. 2016), the studied site was discretized into seven Subcatchments (i.e., S1, S2, … S7) and the runoff of the seven subcatchments flow to an Outfall node. In this tutorial, we will only introduce how to create the model by using VOSWMM.

The Outfall node is already in the developed scenario, because it was duplicated in the Scenario Duplication. We only need to add more Subcatchments to the “developed” scenario. To add Subcatchments, there are two ways:

  • Copy and Paste the Subcatchment command on the Schematic view by using the tools  and  in the Home toolbar or using Ctrl+C and Ctrl+V.

Once the commands are added to the Schematic view, move the commands to proper locations and change the NYHD accordingly. The location of each subcatchment (i.e., S1, S2, … S7) is denoted on the background image. Zoom into the image to see the subcatchment denotation. For example, the zoomed image below show the locations of S1, S2, S3, S4 and S7.

Then, add connections from the Subcatchments to the Outfall node. The details can be found in Step 4: Undeveloped Site – Add Objects to Schematic View

The model created for the “developed” scenario will be looked like the figure below.

Assign Object Properties

The Outfall node was duplicated from the “undeveloped” scenario, so it has the same properties as in the “undeveloped” scenario. We only need to change the Properties of Subcatchments in the “developed” scenario.

To view and edit the properties of the Subcatchments node, click on the Parameter Tables tab, which by default is at the bottom of the VOSWMM main interface. Click the Subcatchment tab in the Parameter Tables.

The parameters of all the seven Subcatchemnts are listed in the table below. To edit the properties in the Parameter Table of Subcatchment, you can choose to either edit table cells one by one or copy the entire table below to the Parameter Table.

NHYDNAMESystem TypeArea [ac]Storm IndexOutletWidth [ft]Slope [%]% ImpervN-ImpervN-PervDstore-Imperv [in]Dstore-Perv [in]%Zero-ImpervSubarea RoutingPercent Routed
S1S1Blank4.551O21587256.80.0150.240.10.325OUTLET100
S2S2Blank4.741O216532630.0150.240.10.325OUTLET100
S3S3Blank3.741O214563.139.50.0150.240.10.325OUTLET100
S4S4Blank6.791O223313.149.90.0150.240.10.325OUTLET100
S5S5Blank4.791O21670287.70.0150.240.10.325OUTLET100
S6S6Blank1.981O26902950.0150.240.10.325OUTLET100
S7S7Blank2.351O29073.100.0150.240.10.325OUTLET100
  • To change the cell values one by one, click on that cell in the Parameter Table and then click again to change the cell to editable mode.
  • To copy the entire table to the Parameter Table of the Subcatchment, first copy the table above without the header row. Then, click on the header of NHYD to sort the Parameter Table by NHYD.ascendingly and right click on the first cell under the NHYD column in the Parameter Table of Subcatchments. In the opened context menu, select “Paste”.

Click on the header of NHYD to sort the Parameter Table by NHYD ascendingly. The final table will be looked like this.

Step 10: Developed Site - Run Simulation

To run the simulation for all design storms, click the Run button in the Simulation toolbar to open the Batch Run window. Click Run in the Batch Run window to run the batch simulation in the “undeveloped” scenario. Three runs will be made, one for each design storm event.

Step 11: Developed Site - Model Results

Hydrographs

We can view the summary results in the Result Summary Tables in the same fashion as for the pre-development condition. Select the run to view results in the Run dropdown list and click the header of NHYD to sort the table by subcatchment NHYD.

Pre- and Post-Development Comparison

To compare hydrographs of pre- and post-development, select the Outfall node and then click the Scenario Comparison button in the Simulation toolbar. In the pop-up window, select the Run to be compared in the Design Storm drop-down list and choose Total Inflow in the Variables. The comparison Graphs and Statistics table will display. Set the color of “developed” as red and “undeveloped” as green. Users can also save the comparison results to the Scenario Comparison group in the Project Manager by clicking the Save button on the Scenario Comparison window.

Step 12: Save Project

Click the Save Project button in the Home tab. In the pop-up window, navigate to the folder where you want to save your project and give a name in the File Name field. Click Save.

×

Table of Contents