SewerGems Creating Model
SewerGems Creating Model
To learn about the different elements available in Bentley SewerGEMS CONNECT, click one of the following links:
Link Elements
Catch Basins
Manholes
[Link] 2025/06/14
Creating Your Model Page 2 of 174
Taps
Cross Sections
Transitions
Pressure Junctions
Pond Outlet Entrances
Outfalls
Wet Wells
Pumps
Variable Speed Pump Battery
Pump Stations
Catchments
Low Impact Development Controls
Ponds
Air Valves
SCADA Elements
Headwalls
Property Connections
Other Tools
Link Elements
Link elements connect the other elements to form the sewer network. The link elements are the conveyance elements that carry flow through the network to its eventual
discharge point at an outlet. You can add any of the following link elements to your model, depending on the link element’s location within the network:
• Pressure pipes
• Conduits
• Laterals
• Channels
• Gutters
When you click the Layout tool on the Layout toolbar, you select the type of link element to add (pressure pipe, conduit, channel, lateral, or gutter), then select an element. You
can place multiple elements with different kinds of connections using the Layout tool.
The dialog box contains the depth vs. width table and the following controls:
Delete This button deletes the currently highlighted row from the depth-width table.
Report Opens a print preview window containing a report that details the input data for this dialog box.
[Link] 2025/06/14
Creating Your Model Page 3 of 174
Graph Opens a graph window plotting the depth-width curve defined by the points in the table
Column Description
Elevation (Relative) Lets you define the depth of the curve point.
Width Lets you define the width of the conduit at a specific depth.
Irregular Channel
The Irregular Channel dialog box contains buttons and a station vs. elevation table. The dialog box contains the following controls:
Delete This button deletes the currently highlighted row from the table.
Column Description
Station Allows you to select whether the associated values define the Left Bank, Right Bank, or the Main Channel.
Elevation (Relative) Allows you to define the depth at which the Manning's n you define will be applied.
The Elevation-Roughness dialog box contains buttons and a elevation-roughness table. The dialog box contains the following controls:
Delete This button deletes the currently highlighted row from the table.
Column Description
Channel Bank Location Allows you to select whether the associated values define the Left Bank, Right Bank, or the Main Channel.
Depth Allows you to define the depth at which the Manning's n you define will be applied.
Manning’s n Allows you to define the Manning's n at the associated depth.
Interpolate Allows you to define interpolation zones for the variations in Manning's n.
[Link] 2025/06/14
Creating Your Model Page 4 of 174
The upstream hydraulic grade in a diversion link is the result of the backwater profile calculation moving up the diversion link, thus it has no impact on the upstream node
hydraulic grade since the upstream node hydraulic grade is determined from the primary (non-diversion) conduit profile calculation, not the diversion profile. Because of such
profile calculation treatment, sometimes a discontinuity of the diversion profile with the upstream node hydraulic grade can be observed (i.e. the profile at the upstream end of
the diversion link will be different than the profile at the upstream end of the non-diversion link and the upstream node). Usually this difference is small.
If the diversion link’s upstream hydraulic grade is higher than the upstream node hydraulic grade, it indicates that either the diverted flow is too big or the diversion conduit is
undersized. The reverse case is also true. For multiple diversions, such as those seen in a wastewater treatment plant, the multiple diversion profiles provide a clue to adjust the
multiple diversion curves so that the resulting profiles are continuously connected to the upstream node hydraulic grade. If the upstream heads in the diversion links are
significantly different than that at the upstream node, the user may wish to modify the flow split or modify the hydraulic characteristics of the system downstream of the split.
The dialog box contains a table displaying the section results and the following control:
Report: Opens a print preview window containing a report of the sections results.
• Section Distance
• Section Velocity
• Section Flow
• Section Hydraulic Grade
• Section Depth
• Section Flow-Width
• Section Flow-Area
• Section Is Overflowing?
• Section Froude Number
To open this dialog box, go to the Results section of the Property Editor for a pipe, conduit, or a channel after the model has been calculated. Then click the Ellipsis (...) button in
the Section Results field.
To find flow results for more than 3 points in a conduit, under Analysis -> Calculation Options, choose an appropriate computational distance (that divides the conduit in more
than 2 sections).
What Happens When the Water Level Exceeds the Top Elevation of an Open Channel?
When the hydraulic grade line (HGL) exceeds the channel top elevation, the last width defined for the channel (or the cross section node) is extended vertically to no limit. So
there is no overflow for these. When the channel is bounded by a manhole, overflow occurs at the manhole.
If there is a cross section node at each end of a channel, then the channel will start with a cross section as defined in the upstream cross-section node, and will make a transition
to the cross-section defined in the downstream cross section node.
When you connect a channel to a conduit at a cross-section node, a transition is added between the channel and the conduit. You can specify the type of transition in the
Property Editor for the cross-section node as either Gradual or Abrupt. If you specify Abrupt, the top width of the channel cross-section is used as the length of the transition
part. If you select Gradual, you enter a value for the Transition Length. If the Transition Length is larger than the top width of the cross-section node, the Transition Length value
is used as the length of the transition part.
[Link] 2025/06/14
Creating Your Model Page 5 of 174
Laterals
Laterals are pipes which are connected to a catchbasin at their upstream end, and either a node or another conduit at their downstream end. When connected to a conduit
(which is done through a “Tap” node) the crucial aspect is that they do not break that conduit into two separate pieces.
There could be a number of lateral connections to a single trunk conduit. The flows from each lateral are assumed to enter the network at the upstream end of the trunk conduit
in the GVF Rational and GVF Convex solvers, and at the Tap node in the SWMM solver. They are not supported in the DW solver.
Pressure pipes are treated as circular conduits and are solved with Manning’s equation with the following rules applied to the converted conduit:
• The converted conduit has the same diameter as the pressure pipe.
• Pressure pipe roughness is converted to an equivalent conduit roughness value based on the pressure friction method and gravity friction method as follows:
• Manning's n = 1.3/C, where C is Hazen Williams C
• Manning's n = 0.0952/(|ln(e/7.4 + 0.000182)|), where e is Darcy Weisbach e
• Manning's n = Kutter's n
• Virtual pipes are treated as physical pipes, using the original data.
• Number of Barrels is set to 1.
• Design Conduit is set to False.
Pressure junctions are treated as manholes with the following rules applied to the converted manhole:
Note: When gutter is connected to a catchbasin with an inlet type for which depth and spread aren’t calculated, some results will be reported as N/A.
The following input data will not be used by the GVF-Rational Solver, and user notifications will be generated on compute or validate:
• Roughness Type: If the Roughness Type is a value of Manning's n - Depth Curve or Manning's n -Flow Curve.
• Transition Type: If the Transition Type is Gradual and the Transition Length is greater than zero.
[Link] 2025/06/14
Creating Your Model Page 6 of 174
In SewerGEMS and CivilStorm for the Implicit and Explicit solvers you have the option of the "Arch" shape type. This is simply defined by a rise and span. For the Explicit solver
you have the additional option of the Arch Data Type.
In SewerCAD and StormCAD for the GVF-Convex and GVF-Rational solvers you can only use a Pipe-Arch shape as a Catalog Conduit reference. If the conduit is user defined you
do not have the option of either Pipe-Arch or Arch.
If you set the conduit type to "Catalog Conduit" you can select, if available, the Pipe-Arch conduit shape which will in turn filter any catalog conduits that are of that type.
Note that if you have SewerGEMS/CivilStorm SELECTseries 2 model which references a Pipe-Arch from the Catalog Conduit library, upon conversion to SELECTseries 3 those
references will be converted to User-Defined Arch shapes local to each relevant conduit. The more complex Pipe-Arch shape is only supported by the Rational and GVF-Convex
engines. A validation error will occur if the Pipe-Arch shape is used with the Implicit or Explicit engines.
Conversely, if you set up a StormCAD or SewerCAD SELECTseries 3 model (or within SewerGEMS or CivilStorm using the appropriate GVF solver) and the conduit is set to user
defined with the Arch conduit shape you will get an error message that will prevent the model from computing. If you receive this error, change the conduit to catalog conduit
and select a pipe-arch reference.
While the term “Tractive Force” is commonly used, the quantity of interest is actually tractive stress which has units of force per unit area parallel to the direction of flow. When
the tractive stress is sufficient sewers are essentially self-cleaning in that particles will either not settle or they be re-suspended if they do. The tractive stress does not need to
continuously exceed the target tractive stress to be self-cleaning but should exceed the target at least some time during each day.
The user can specify the global target for tractive stress to achieve self-cleaning in the Calculation options under Gravity hydraulics > Tractive stress (Global minimum).
In addition, the user can override the global target for any conduit by setting the conduit or channel property "Use local minimum tractive stress" to True and specifying a target
value for that individual element.
Tractive stress calculations are only performed for the GVF Convex solver but may be extended to other solvers.
[Link] 2025/06/14
Creating Your Model Page 7 of 174
Click New to create a new Hydrograph Time vs. Flow point for the hydrograph.
Click Report to open a print preview window containing a report that details the input data for this dialog box.
Catch Basins
Catch basins convey surface water into a storm sewer pipe system. A catch basin (a.k.a., storm drain inlet, curb inlet) is an inlet to the storm drain system that typically includes a
grate or curb inlet where stormwater enters the catch basin and a sump to capture sediment, debris and associated pollutants. They are also used in combined sewer
watersheds to capture floatables and settle some solids.
When you click the catch basin element on the Layout toolbar, your mouse cursor changes into a catch basin element symbol. Clicking in the drawing pane while this tool is
active causes a catch basin element to be placed at the location of the mouse cursor.
Bentley SewerGEMS now supports HEC-22 inlet capacity calculations. You can set up inlets (grate, combination, curb opening, etc.) and Bentley SewerGEMS will compute inlet
capacity based on flow to the inlet, as well as inlet and gutter geometry.
Inlet Type
Adding Inflow vs. Capture Data to a Catch Basin
Catch Basins in the SewerCAD Gradually Varied Flow Solver
Flow (Local Surface) at Catch Basins
Inlet Type
The inflow to a catch basin does not all enter the basin. The flow that actually enters the basin is referred to as its "capture."
• Capture all the flow that comes to it, which is referred to as "full capture."
• Capture all of the flow up to a "maximum capacity," and you specify the maximum flow.
• Capture flow in accordance with some curve called an inflow vs. capture curve. For more information on inflow vs. capture curves, see "Adding Inflow vs. Capture Data to
a Catch Basin" .
• When "Inlet Type" is set to "Catalog Inlet", with the Inlet attribute you can select a Catalog Inlet reference. By referencing a catalog inlet, the capture is computed instead
of defined by the user. For more information on Catalog Inlets see Inlet Catalog Dialog Box.
• Capture a percentage of flow that comes to it, which is referred to as "percent capture”.
Any inflow that is not captured goes to a gutter. If there is no gutter, the inflow that is not captured is lost from the system.
1. Click a catch basin in your model to display the Property Editor, or right-click a catch basin and select Properties from the shortcut menu.
2. In the Inlet section of the Property Editor, select Inflow-Capture Curve as the Inlet Type. The Inflow-Capture Curve field becomes available.
3. Click the Ellipses (...) button next to the Inflow-Capture Curve field.
4. In the Inflow-Capture Curve dialog box, each row in the table represents a data point on the Inflow-Capture curve. Type values for the Total Inlet Flow and Inlet Capture
for each row. Click the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
This dialog box allows you to define Total Inflow vs. Inlet Capture tables for catchments. The dialog box contains the inflow vs. capture table along with the following controls:
Delete Deletes the currently highlighted row from the inflow-capture curve table.
Report Opens a print preview window containing a report that details the input data for this dialog box.
Graph Opens a graph window plotting the inflow-capture curve defined by the points in the table.
[Link] 2025/06/14
Creating Your Model Page 8 of 174
Column Description
Total Inlet Lets you define the inflow at the current curve point. Total inlet flow is the cumulative flow from all catchments and other loads that actually reaches
Inflow the catch basin.
Inlet Capture Lets you define the total captured flow for the current curve point. Inlet capture is the portion of the total inlet flow that actually enters the catch
basin and is passed downstream.
Sanitary Loads on Catch Basins should be added directly into the system, and should not be applied as surface flow.
SWMM Engine
Sanitary Loads will be applied to a catch basin when using the SWMM engine in a different manner depending on which routing method (Dynamic, Kinematic, Uniform) is used.
• Upon export to SWMM a junction is created connected to CB-1 with the name CB-1-SAN, where all sanitary loads are applied.
The Dynamic Wave (Implicit) solver treats the dry weather flow (sanitary load) the same for all type of sanitary loads; it creates a separate inflow for the load and the solver
knows that the inflow is a dry weather flow (a new inflow type is added in the input file).
For the calculation, the solver will not include the dry weather flow when calculating the inlet capture/bypass flows, so the dry weather flow is always added to the pipe system
and there is no bypass flow for them.
Manholes
Manholes are placed in a sewer system to provide access for inspection, maintenance, and emergency service. Manholes should be placed at sewer junctions (i.e., tees, wyes,
and crosses), upstream terminal ends of sewers, and locations where there is a change in sewer grade or direction. Manholes are locations where loads enter the gravity portion
of the sewer system.
[Link] 2025/06/14
Creating Your Model Page 9 of 174
When you click the manhole element on the Layout toolbar, your mouse cursor changes into a manhole element symbol. Clicking in the drawing pane while this tool is active
causes a manhole element to be placed at the location of the mouse cursor.
1. Display the Property Editor for a catch basin or manhole by clicking the element in the Drawing Pane, or by right-clicking the element then selecting Properties from the
shortcut menu.
2. In the Physical: Surface Storage section of the Property Editor, select Surface Depth- Area Curve as the Surface Storage Type. The Surface Depth-Area Curve field becomes
available.
3. Click the Ellipses (...) button next to the Surface Depth-Area Curve field.
4. In the Surface Depth-Area Curve dialog box, each row in the table represents a data point on the Surface Depth-Area curve. Type values for the Depth and Area for each
row. Click the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
This dialog box allows you to define Depth vs. Area tables for manholes and catch basins. The dialog box contains the depth-area table and the following buttons:
Delete Deletes the currently highlighted row from the depth-area table.
Report Opens a print preview window containing a report that details the input data for this dialog box.
Graph Opens a graph window plotting the surface depth-area curve defined by the points in the table.
Column Description
Depth The depth data for the curve.
Area The area data for the curve.
The dialog box contains the Flow vs. Headloss table along with the following controls:
• Flow: This field allows you to define the flow at the current curve point.
• Headloss: This field allows you to define the headloss for the current curve point.
The tab section is used to define the settings for the flow-headloss curve that is currently highlighted in the flow-headloss curve list pane. The following controls are available:
Data Tab This tab consists of input data fields that allow you to define the points that make up the flow-headloss curve.
Flow Enter the flow data point.
[Link] 2025/06/14
Creating Your Model Page 10 of 174
1. Double-click the node element in your model to display the Property Editor, or right-click a node and select Properties from the shortcut menu.
2. In the Physical (Structure Losses) section of the Property Editor, select Flow-Headloss Curve as the Headloss Method. The Flow-Headloss Curve field becomes available.
3. Click the <Select...> list item in the Flow-Headloss Curve field.
4. In the Flow-Headloss Curves Dialog Box, all of the Flow-Headloss Curves that have been created for the model are listed in the left pane. Create a new Curve by clicking
the New button.
5. The data for each Flow-Headloss Curve is displayed in the table on the right. Each row in the table represents a data point on the Flow-Headloss Curve curve. Type values
for the Flow and Headloss for each row. Click the New button to add a row or press the Tab key to advance to the next field in the table.
6. Perform the following optional steps:
7. To delete a row from the table, select the row then click Delete.
8. To view a report on the curve, click Report.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
Taps
A Tap node is used to connect a lateral pipe to another conduit. It controls the location of the connection, and the stop invert elevation of the lateral pipe. Unlike most other
types of node, when it is placed it does not break the conduit into two separate pieces, so it is the same as a bend in that respect. A tap can either be inserted into the conduit,
and will therefore be along its path, or associated to the trunk conduit, and therefore be at an offset from it.
The Tap node can either be connected so that the invert of the lateral pipe is aligned with the centre or the soffit of the other conduit. In both cases an offset can be specified to
adjust this, so that the lateral can be made to align “centre to centre” with the other conduit, or a vertical connection into the top of the other conduit can be modelled if
required.
Note: Tap elevations are dynamic, based on the elevation at the location where the tap connects to the pipe. All tap elevations are reset to N/A whenever anything changes that
might impact the elevation (e.g. move an element, change a diameter, etc).
Cross Sections
When you click the cross section element on the Layout toolbar, your mouse cursor changes into a cross section element symbol. Clicking in the drawing pane while this tool is
active causes a cross section element to be placed at the location of the mouse cursor.
You can model an open channel with the combination of a channel link and a cross section network element. The transect of the channel is defined by the upstream cross
section node attributes. You have the option to define the channel shape as User Defined or using a Conduit Catalog reference. The user defined 'Section Types' are Trapezoidal
Cross Section and Irregular Channel. If the Cross Section Type is Catalog Cross Section, you may select a Conduit Catalog reference that is a trapezoidal or irregular channel
shape. The other catalog conduit shapes are not applicable to cross section nodes.
Transitions
Transitions are locations where upstream flows in a gravity system combine. No loads enter the sewer at these points.
When you click the transition element on the Layout toolbar, your mouse cursor changes into a transition element symbol. Clicking in the drawing pane while this tool is active
causes a transition element to be placed at the location of the mouse cursor.
[Link] 2025/06/14
Creating Your Model Page 11 of 174
Pressure Junctions
Pressure junctions are connections between two or more pressure pipes of varying characteristics. Loads may enter a pressure portion of a network through a pressure junction.
When you click the pressure junction on the Layout toolbar, your mouse cursor changes into a pressure junction element symbol. Clicking in the drawing pane while this tool is
active causes a pressure junction element to be placed at the location of the mouse cursor.
Note: If there are multiple discharges locations serving a pond then they must all be modeled in the same manner; that is, they must either all be modeled with outlet control
structures, or all modeled without outlet control structures.
The outlet control structure hydraulics normally result in relationships (as we expressed and internally used in the form of E-Q-T), however in some unusual conditions,
characterized by an extremely undersized downstream conduit from the control, the use of EQT can result in instabilities for extreme flows (as compared with the downstream
conduit capacity). In order to prevent such instability from happening, the model adds a flow filter to limit the flow from the control if the flow exceeds overflow level. The
overflow level is:
If the Q given by EQT, Q(eqt), exceeds the overflow level, the model uses the following filtered new flow:
1. Click a pond outlet structure in your model to display the Property Editor, or right-click a pond outlet structure and select Properties from the shortcut menu.
2. In the Pond Outlet section of the Property Editor, select Yes in the Has Control Structure field. The Control Structure field becomes available.
3. Click the Ellipses (...) button next to the Control Structure field. The Composite Outlet Structures dialog box appears, displaying the existing composite outlet structure
associated with the selected pond outlet structure.
4. To create a new composite outlet structure, perform these steps:
5. Click New, then select the type of outlet structure component you want to add. The right side of the dialog box displays settings for the composite outlet structure and for
each individual component in the composite outlet structure. With the composite outlet structure selected in the list pane, enter values for Tolerance Settings and ICPM
Settings. Select each individual component in the list pane, then enter values for that component in the fields on the right. If you define a weir as an Irregular Weir, you
must define the cross-sectional shape of the irregular weir by entering X (Station) vs. Y (Depth) data. To do this, click the Cross Section button, enter X and Y values in the
Irregular Cross Section dialog box, then click OK to close that dialog box.
6. To edit an existing composite outlet structure, perform these steps:
7. If necessary, edit the Tolerance Settings and ICPM Settings for the selected composite outlet structure. Click the plus sign (+) next to the outlet structure in the list pane to
display its individual components. Select the component (Orifice, Riser, or Weir), then edit the values for the component on the right side of the dialog box. If you define a
weir as an Irregular Weir, you must define the cross-sectional shape of the irregular weir by entering X (Station) vs. Y (Depth) data. To do this, click the Cross Section
button, enter X and Y values in the Irregular Cross Section dialog box, then click OK to close that dialog box. To add a new component to an existing composite outlet
structure, select the outlet structure in the list pane then click New and select Orifice, Riser, or Weir from the submenu. You can also right click an existing composite
structure in the list pane, then select New > Orifice, New > Riser, or New > Weir from the shortcut menu.
8. Perform the following optional steps:
9. To delete a row from the table, select the row then click Delete.
10. To rename an existing composite outlet structure, click Rename, then type the new name.
11. To view a report on the composite outlet structure, click Report.
12. To view a plot of the composite outlet structure, click Graph. The graph will display multiple curves, one for each component in the composite outlet structure.
13. Click OK to close the dialog box and save your data in the Property Editor.
The Composite Outlet Structures dialog lets you create complex outlet structures.
[Link] 2025/06/14
Creating Your Model Page 12 of 174
The dialog consists of a tree view pane and property editor on the left and a tabbed section on the right. The tree view displays all of the outlet structure definitions associated
with the model. The property editor allows you to define the attributes of the element currently highlighted in the tree view. Above the tree view are the following buttons:
Delete: Removes the entry that is currently highlighted in the list pane
•
Rename: Allows you to enter a new label for the entry that is currently highlighted in the list pane.
•
Duplicate: Creates a copy of the entry that is currently highlighted in the list pane.
•
Expand All: Expands each of the nodes in the tree view, so that all entries are displayed.
•
Collapse All: Collapses each of the nodes so that only the top-level nodes are visible.
•
Report: Generates a preformatted report that details the data associated with the entry that is currently highlighted in the list pane.
•
Compute: When you click this button a submenu opens. The submenu contains the following commands:
• Validate: Click this button to perform a validation on the entry that is currently highlighted in the list pane.
• Compute: Click this button to compute the entry that is currently highlighted in the list pane.
• Compute All: Click this button to compute all of the entries in the list pane.
•
The attributes displayed in the property editor section below the tree view will change depending on the type of node that is currently highlighted in the tree view. Depending
on the node type, the property grid allows you to define the following attributes:
• Composite Structure Node (Top Level Node): When a top level node is highlighted in the tree view, the following properties are available:
• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• Headwater Type: The type of headwater range to use.
• Pond: The pond to use for headwater range.
Note: The <Automatic> headwater/tailwater calculation only works if you access this dialog through the Properties grid. If you access it from the components menu (where
topology is not known and the range has already been set by a previous calculation) the standard validation is executed.
The headwater and tailwater elements do not need to be user-defined to determine the ranges. If edited from the Properties grid of the pond outlet structure node the ranges
will automatically be determined ( in the same way as if you computed the entire hydraulic model).
• Minimum (Headwater): The minimum pond surface elevation to use in the headwater range.
• Increment (Headwater): The step value represents the step increment for the rating table. As a general rule, interpolation precision between table points increases as the
step increment is decreased.
• Maximum (Headwater): The maximum pond surface elevation to use in the headwater range.
• Spot Elevations (Headwater): The spot elevations for the headwater range.
• Tailwater Range Type: Select the type of tailwater range to specify. You can specify a user defined range or automatically determine the range by selecting a pond or
outfall.
• Downstream Element ID: Specify the domain element in which to determine the tailwater range or leave it set to Automatic and let the application figure it out
automatically.
• Minimum (Tailwater): The minimum tailwater elevation to use in the range.
• Increment (Tailwater): Set the step used to compute the rating curve for the elevation beginning at the minimum tailwater and increment by this tailwater step elevation
until the maximum tailwater is reached. In general, smaller tailwater step increments yield more precise routing interpolation.
• Maximum (Tailwater): The maximum tailwater elevation to use in the range.
• Spot Elevations (Tailwater): The spot elevations for the tailwater range.
• Store Elevation-Flow-Tailwater Table: Determines if the elevation-flow-tailwater curves are stored. This option can be used in conjunction with the Store Elevation-Flow-
Tailwater Table? Calculation Option. See ”Store Elevation-Flow-Tailwater Table’ for more details.
[Link] 2025/06/14
Creating Your Model Page 13 of 174
Where:
.
• A typical value for the Weir Coefficient is 3.3 (ft0.5/s) or 1.8 (m0.5/s).
• Orifice Coefficient: The orifice coefficient for this structure.
• Orifice Area: The orifice area of this riser structure.
• Transition Elevation: The transition elevation for this structure.
• Transition Height: The transition height for this structure.
• K Reverse: The K reverse coefficient for this structure.
• Weir Length: The weir length of this riser structure.
• Use Orifice Depth to Crest?: There are two methods available to calculate the headwater depth of a fully charged riser orifice. The default method measures the
headwater depth from the riser crest to the headwater elevation. The other method measures the headwater depth from the tailwater elevation to the headwater
elevation. To use the first method, this value should be set to True (the default). To use the second method, set this property to False.
• If the Use Orifice Depth to Crest property is set to True, then Head Across Orifice = Pond Elevation - Riser Crest Elevation.
• If the Use Orifice Depth to Crest property is set to False, then Head Across Orifice = Pond Elevation - Tailwater Elevation.
• Use Submerged Weir Equation?: There are two methods available to calculate a fully-charged riser weir flow: non-submerged weir and submerged weir. The non-
submerged weir method is used when this property is set to False (the default method). When this property is set to True, the submerged weir method is used.
• If the Use Submerged Weir Equation? property is set to False, then:
• Qw = Kwc * Lw * (Pond Elevation - riser crest)1.5
• Where:
• Qw = weir flow through the riser
• Kwc = riser weir flow coefficient
• Lw = riser weir length
• If the Use Submerged Weir Equation? property is set to True, then
[Link] 2025/06/14
Creating Your Model Page 14 of 174
• Qws = Qw * (1 - (H2/H1)1.5)0.385
• Where:
• Qw = weir flow through the riser
• Qws = weir flow through riser (weir is submerged)
• H1 = Pond Elevation - Riser Crest Elevation
• H2 = Tailwater Elevation - Riser Crest Elevation
• Culvert Attributes: When a Culvert is selected in the tree view the following attributes are available:
• Culvert Type: The type of culvert.
• Outlet ID: Upstream structure ID.
• Flow Direction: Defines the direction in which flow is considered.
• Downstream ID: Downstream Structure ID.
• Notes: Additional information about this element.
• Convergence Tolerance: Performance can be greatly increased by increasing the convergence tolerance. However, since this parameter affects the calculation precision,
the results should be checked to see if this assumption produces results within an acceptable precision.
• Specify Number of Backwater Sections: Specify to use a user defined number of backwater sections.
• Number of Backwater Sections: Calculation performance can usually be greatly increased by setting the number of backwater sections to three. Results should be checked
to see if this assumption produces results with an acceptable precision.
• Inlet Description: The description of the culvert coefficients.
• Chart: The inlet chart that this set of coefficients appears on.
• Nomograph: The culvert nomograph this set of coefficients belongs to.
• Equation Form: The type of equation form to use for this culvert.
• K: K and M are equation coefficients used in both forms of the unsubmerged inlet control equation.
• M: K and M are equation coefficients used in both forms of the unsubmerged inlet control equation.
• C: C and Y are equation coefficients used in the submerged inlet control equation.
• Y: C and Y are equation coefficients used in the submerged inlet control equation.
• Manning’s n: The Manning’s n coefficient for this culvert.
• Ke: The Ke coefficient.
• Kr: The Kr coefficient.
• Slope Correction Factor: The slope correction factor to use for this culvert.
• Number of Barrels: The number of barrels for this culvert.
• Length: The length of this culvert.
• Upstream Invert: The upstream invert of the culvert.
• Downstream Invert: The downstream invert of the culvert.
• Diameter: The culvert diameter.
• Width: The culvert width.
• Height: The culvert height.
• Elevation (On): Elevation (On) is the lower elevation of range over which to use this structure. No flows will be computed for elevations less than this value. If 0.0 then this
value is ignored.
• Elevation (Off): Elevation (Off) is the upper elevation of range over which to use this structure. No flows will be computed for elevations equal to or greater than this
number. If 0.0 then this value is ignored.
• Specify Transitions: Defines whether user defined transitions are used.
• HW/D End Unsubmerged: The user defined HW end unsubmerged value.
• HW/D Begin Submerged: The user defined HW begin submerged value.
• Compute Outlet Control Only: Determines if inlet control only is considered during calculations.
• Weir Attributes: When a Weir is selected in the tree view the following attributes are available:
• Elevation: Structure’s invert elevation.
• Outlet ID: Upstream structure ID.
• Flow Direction: Defines the direction in which flow is considered.
• Downstream ID: Downstream Structure ID.
• Notes: Additional information about this element.
• Weir: The type of weir for this structure.
• Vary Coefficient with Depth: Determines if a depth-coefficient table is considered.
• Weir Coefficient: The coefficient of discharge multiplied by other constants in the weir flow equation. For example, flow over a rectangular weir with no end contractions
can be determined using the following equation:
• Where:
• Q = discharge (cfs, m3/s)
• Cd = coefficient of discharge
• g = gravitational constant (32.2 ft/s2, 9.81 m/s2)
• L = length of the weir crest (ft, m)
• H = height of the energy grade above weir crest (ft, m)
• In this case the Weir Coeffcient,
.
• A typical value for the Weir Coefficient is 3.3 (ft0.5/s) or 1.8 (m0.5/s).
• Weir-Depth Coefficient Table: The weir depth coefficient table to use for this weir structure.
• Coefficient of Discharge: The ratio of actual discharge to theoretical discharge across a weir (the differences between actual and theoretical values are generally due to
contractions and energy losses). Note that the coefficient of discharge is unitless and is different from a "weir coefficient", and is typically on the order of 0.6. This
property is only available for V-Notch Weirs.
• V-Notch Angle: The angle for this v-notch weir structure.
• Elevation (On): Elevation (On) is the lower elevation of range over which to use this structure. No flows will be computed for elevations less than this value. If 0.0 then this
value is ignored.
• Elevation (Off): Elevation (Off) is the upper elevation of range over which to use this structure. No flows will be computed for elevations equal to or greater than this
number. If 0.0 then this value is ignored.
• User Defined Table: Determines if a weir submergence table is considered for this weir structure.
• Weir Submergence Table: The weir submergence table to use with this weir structure.
• Irregular Weir: The station-depth curve for this irregular weir section.
• Rectangular Weir: The type of rectangular weir for this structure.
• Weir Length: The weir length for this weir structure.
• Rating Table Attributes: When a Rating Table is selected in the tree view the following attributes are available:
• Elevation: Structure’s invert elevation.
• Outlet ID: Upstream structure ID.
• Flow Direction: Defines the direction in which flow is considered.
• Downstream ID: Downstream Structure ID.
• Notes: Additional information about this element.
• Elevation (On): Elevation (On) is the lower elevation of range over which to use this structure. No flows will be computed for elevations less than this value. If 0.0 then this
value is ignored.
[Link] 2025/06/14
Creating Your Model Page 15 of 174
• Elevation (Off): Elevation (Off) is the upper elevation of range over which to use this structure. No flows will be computed for elevations equal to or greater than this
number. If 0.0 then this value is ignored.
• Elevation-Flow Curve: The user defined depth-elevation curve for this structure.
• Vortex Valve Attributes: When a Vortex Valve is selected in the tree view the following attributes are available:
• Elevation: Structure’s invert elevation.
• Outlet ID: Upstream structure ID.
• Flow Direction: Defines the direction in which flow is considered.
• Downstream ID: Downstream Structure ID.
• Notes: Additional information about this element.
• Vortex Valve: Allows you to select the vortex valve to use. Click the ellipsis (...) button to open the Vortex Valve dialog.
• Elevation (On): Elevation (On) is the lower elevation of range over which to use this structure. No flows will be computed for elevations less than this value. If 0.0 then this
value is ignored.
• Elevation (Off): Elevation (Off) is the upper elevation of range over which to use this structure. No flows will be computed for elevations equal to or greater than this
number. If 0.0 then this value is ignored.
• Results Tab: This tab consists of a graph displaying the calculated results for the element that is currently highlighted in the tree view pane.
• Rating Table Tab: This tab displays a rating table of the calculated results for the element that is currently highlighted in the tree view pane.
Option 1 allows you to store the results of an interconnected outlet structure (which is a composite outlet structure with a tailwater setting of "Interconnected Ponds") into an
Elevation-Flow-Tailwater curve.
You first set this option to "Yes" and then specify the table to store the data in. If there is no table available yet you can select "<Create New EQTW Series>" which will
automatically create one for you with the label of the composite outlet structure.
The storing of the results into the Elevation-Flow-Tailwater curve is generally done only when computing from the composite outlet structure dialog box. However, there is an
option in Bentley SewerGEMS that allows you to store these results when you run the scenario.
Option 2 allows you to store the Elevation-Flow-Tailwater table when computing the scenario that uses the calculation options you just modified. It tells the engine that if the
pond outlet link has the "Has Control Structure?" property set to "Yes" and an assigned composite outlet structure that has a tailwater of "Interconnected Ponds" and the "Store
Elevation-Flow-Tailwater Table" set to "Yes" to store the results in the specified table.
These two options are used in conjunction with each other. You would not normally set Option 2 to True if you are not using interconnected pond routing or have an outlet
structure that has "Store Elevation-Flow-Tailwater" set to No.
If, however, you have Option 2 set to False and Option 1 set to Yes and for the latter have the "<Create New EQTW Series>" selected, a new blank Elevation-Flow-Tailwater
Series table will be created with no data.
If you have Option 1 set to Yes with an actual table specified and Option 2 set to False and you compute the scenario the data in the selected Elevation-Flow-Tailwater table will
NOT change.
Option 1 can be used alone but Option 2 should be used with Option 1.
EQT Curves
EQT curves refer to the relationship between the flow (Q) through a structure and the elevation (E) of the water upstream of the structure and the water elevation in the
tailwater (T) downstream of the structure. They consist of a family of curves with upstream elevation on the horizontal axis, flow on the vertical axis and individual curves for
different tailwater elevations.
EQT curves are an intermediate step in the hydraulic calculations for pond outlets (composite outlet structure), and (box and circular) conduits that are culverts.
To view the EQT curve for a structure (after an implicit or explicit solver run),,
When the GVF solver is used, the tailwater effect is ignored so there is only a single EQ line. It usually corresponds to the lowest of the EQT curves.
[Link] 2025/06/14
Creating Your Model Page 16 of 174
Click the New button to add a row. Click the Delete button to remove the currently highlighted row. Click the Report button to generate a preformatted report containing all of
the curve data.
Enter the X vs. Y points to define the cross-sectional shape of the weir.
Click the New button to add a row. Click the Delete button to remove the currently highlighted row. Click the Report button to generate a preformatted report containing all of
the curve data.
Click the New button to add a row. Click the Delete button to remove the currently highlighted row.
[Link] 2025/06/14
Creating Your Model Page 17 of 174
Click the New button to add a row. Click the Delete button to remove the currently highlighted row.
Click the New button to add a row. Click the Delete button to remove the currently highlighted row. Click the Report button to generate a preformatted report containing all of
the curve data. Click the Graph button to generate a plot of the elevation-flow-area curve.
The Irregular Weir Cross Section dialog box is accessible only from within the Composite Outlet Structures dialog box when a weir component is selected in the list pane. For the
selected weir, click the Cross Section button to display the Irregular Weir Cross Section dialog box.
The dialog box contains the x vs. y table along with the following controls:
Delete This button deletes the currently highlighted row from the x-y table.
Column Description
X This field allows you to define the cross-sectional distance at the current point.
Y This field allows you to define the depth (0 at the weir crest) for the current point.
[Link] 2025/06/14
Creating Your Model Page 18 of 174
The dialog consists of a list pane on the left and a tabbed section on the right. The list pane displays all of the weir depth coefficient definitions associated with the model. Above
the list pane are the following buttons:
Duplicate: Creates a copy of the entry that is currently highlighted in the list pane.
•
Delete: Removes the entry that is currently highlighted in the list pane
•
Rename: Allows you to enter a new label for the entry that is currently highlighted in the list pane.
•
Report: Generates a preformatted report that details the data associated with the entry that is currently highlighted in the list pane.
•
Synchronization Options: Clicking this button opens a submenu containing the following commands:
•
The tabbed section on the right side of the dialog consists of the following tabs:
• Weir Depth Table: Enter the Weir Depth vs Weir Coefficient points to define the weir depth coefficient curve. Click the New button above the table to add a new row; click
the Delete button to remove the currently highlighted row.
• Notes Tab: This text field that allows you to enter descriptive notes that will be associated with the currently highlighted list pane entry.
• Library Tab: This tab displays information about the template that is currently highlighted in the list pane. If the template is derived from an engineering library, the
synchronization details can be found here. If the template was created manually for this model, the synchronization details will display the message Orphan (local),
indicating that the template was not derived from a library entry.
[Link] 2025/06/14
Creating Your Model Page 19 of 174
The dialog consists of a list pane on the left and a tabbed section on the right. The list pane displays all of the weir submergence definitions associated with the model. Above the
list pane are the following buttons:
Duplicate: Creates a copy of the entry that is currently highlighted in the list pane.
•
Delete: Removes the entry that is currently highlighted in the list pane
•
Rename: Allows you to enter a new label for the entry that is currently highlighted in the list pane.
•
Report: Generates a preformatted report that details the data associated with the entry that is currently highlighted in the list pane.
•
Synchronization Options: Clicking this button opens a submenu containing the following commands:
•
The tabbed section on the right side of the dialog consists of the following tabs:
• Weir Submergence Table: Enter the Hw/Tw Ratio vs Q Multiplier points to define the weir submergence correction table. Click the New button above the table to add a
new row; click the Delete button to remove the currently highlighted row.
• Notes Tab: This text field that allows you to enter descriptive notes that will be associated with the currently highlighted list pane entry.
• Library Tab: This tab displays information about the template that is currently highlighted in the list pane. If the template is derived from an engineering library, the
synchronization details can be found here. If the template was created manually for this model, the synchronization details will display the message Orphan (local),
indicating that the template was not derived from a library entry.
Click the New button to add a row. Click the Delete button to remove the currently highlighted row. Click the Report button to generate a preformatted report containing all of
the rating curve data.
Enter the Elevation vs. Flow points to define the rating curve.
Outfalls
Outfalls represent the ultimate termination points in a sanitary sewer network.
When you click the outfall element on the Layout toolbar, your mouse cursor changes into a outfall element symbol. Clicking in the drawing pane while this tool is active causes a
outfall element to be placed at the location of the mouse cursor.
[Link] 2025/06/14
Creating Your Model Page 20 of 174
Note: You can also add a Cyclic Time vs. Elevation curve to an outfall. For more information, see "Adding Cyclic Time vs. Elevation Data to an Outfall" .
1. Click an outfall in your model to display the Property Editor, or right-click an outfall and select Properties from the shortcut menu.
2. In the Boundary Condition section of the Property Editor, select Time-Elevation Curve in the Boundary Condition Type field. The Time-Elevation Curve field becomes
available.
3. Click the Ellipses (...) button next to the Time-Elevation Curve field.
4. In the Time-Elevation Curve dialog box, each row in the table represents a point on the Time-Elevation curve. Type values for the Time and Elevation for each row. Click
the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
This dialog box allows you to define tidal curve (time vs. elevation) tables for outfalls when the Boundary Condition is set to Time-Elevation Curve.
The dialog box contains the time-vs.-elevation table and the following buttons:
New This button creates a new row in the tidal curve table.
Delete This button deletes the currently highlighted row from the tidal curve table.
Report This button opens a print preview window containing a report that details the input data for this dialog box.
Graph This button opens a graph window plotting the time-elevation curve defined by the points in the table.
Column Description
Time This field allows you to define the hour of the tidal curve point.
Elevation This field allows you to define the elevation for the tidal curve point.
1. Click an outfall in your model to display the Property Editor, or right-click an outfall and select Properties from the shortcut menu.
2. In the Boundary Condition section of the Property Editor, select Elevation-Flow Curve in the Boundary Condition Type field. The Elevation-Flow Curve field becomes
available.
3. Click the Ellipses (...) button next to the Elevation-Flow Curve field.
4. In the Elevation-Flow Curve dialog box, each row in the table represents a point on the Elevation-Flow curve. Type values for Elevation and Outlet Flow for each row. Click
the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
The dialog box contains the elevation vs. flow table and the following buttons:
New This button creates a new row in the E-Q-TW curve table.
Delete This button deletes the currently highlighted row from the E-Q-TW curve table.
Report This button opens a print preview window containing a report that details the input data for this dialog box.
[Link] 2025/06/14
Creating Your Model Page 21 of 174
Graph This button opens a graph window plotting the elevation-volume curve defined by the points in the table.
Column Description
Outlet Elevation This field allows you to define the elevation of the E-Q-TW curve point.
Outlet Flow This field allows you to define the flow for the E-Q-TW curve point.
Note: You can also add a Time vs. Elevation curve to an outfall. For more information, see "Adding Time vs. Elevation Data to an Outfall" .
1. Click an outfall in your model to display the Property Editor, or right-click an outfall and select Properties from the shortcut menu.
2. In the Boundary Condition section of the Property Editor, select Tidal in the Boundary Condition Type field. The Cyclic Time-Elevation Curve field becomes available.
3. Click the Ellipses (...) button next to the Cyclic Time-Elevation Curve field.
4. In the Cyclic Time-Elevation Curve dialog box, each row in the table represents a point on the Cyclic Time-Elevation curve. Type values for Time and Elevation for each
row. Click the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
This dialog box allows you to define tidal curve (time vs. elevation) tables for outfalls when the Boundary Condition is set to Tidal.
The dialog box contains the time-vs.-elevation table and the following buttons:
New This button creates a new row in the tidal curve table.
Delete This button deletes the currently highlighted row from the tidal curve table.
Report This button opens a print preview window containing a report that details the input data for this dialog box.
Graph This button opens a graph window plotting the time-elevation curve defined by the points in the table.
Column Description
Time This field allows you to define the hour of the tidal curve point.
Elevation This field allows you to define the elevation for the tidal curve point.
Wet Wells
Wet wells are required at a pumping station to store wastewater before it is pumped. Wet wells represent boundary conditions between pressure and gravity portions of a
sewer network. They serve as collection points for gravity systems, and as an HGL boundary node for the pressure system. Dry loads can also enter the sewer network at these
locations.
When you click the wet well element on the Layout toolbar, your mouse cursor changes into a wet well element symbol. Clicking in the drawing pane while this tool is active
causes a wet well element to be placed at the location of the mouse cursor.
[Link] 2025/06/14
Creating Your Model Page 22 of 174
1. Click a wet well in your model to display the Property Editor, or right-click a wet well and select Properties from the shortcut menu.
2. In the Physical section of the Property Editor, select Wet Well Depth-Area Curve in the Wet Well Boundary Type field. The Wet Well Depth-Area Curve field becomes
available.
3. Click the Ellipses (...) button next to the Wet Well Depth-Area Curve field.
4. In the Wet Well Depth-Area Curve dialog box, each row in the table represents a point on the Wet Well Depth-Area curve. Type values for Depth and Area for each row.
Click the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
This dialog box allows you to define Depth vs. Area tables for wet wells. The dialog box contains the depth-area table and the following buttons:
Delete Deletes the currently highlighted row from the depth-area table.
Report Opens a print preview window containing a report that details the input data for this dialog box.
Graph Opens a graph window plotting the surface depth-area curve defined by the points in the table.
Column Description
Depth The depth data for the curve.
Area The area data for the curve.
The inflow into the wet well is determined by summing all loads flowing to that wet well.
Gravity hydraulic calculations upstream of a wet well are based on the wet well hydraulic grade, just as they are for standard calculations within gravity systems.
During a Steady State analysis there is a difference, however, in determining the hydraulic grade within the wet well itself. The wet well level may be set by the user to either be
fixed or not fixed.
If the wet well level is fixed, the wet well's starting hydraulic grade is used for pressure calculations. No adjustments are made, and this grade is used as the tailwater grade for
the upstream gravity systems.
If the wet well level is not fixed, the pressure calculations will attempt to balance the wet well level such that the total flow out of the wet well is equal to or greater than the
total flow into the wet well.
The wet well's starting grade is used for the first iteration. If the calculated flows out of each wet well are greater than or equal to each wet well's incoming flow, the iterations
stop there. If not, the wet well levels are increased by the increment specified in the calculation options, and the pressure subnetwork is recalculated. When the wet well level is
increased, it changes the static heads and increases the discharge for connected pumps, and may also trigger additional pumps to turn on.
This process continues until the level in each non-fixed wet well either meets the flow criteria, or is prevented by rising to the maximum elevation of the wet well.
During an Extended Period Simulation the fixed wet well level options are not available. The wet well level for a time step is actually determined by the change in storage due to
inflows and outflows over a single time step.
In the hydrologic transition from a gravity system into a pressure system, gravity loads upstream from the wet well are accumulated and combined with the wet well's local load
to determine the total load entering the pressure system at that location. This can be imagined as the total load "dumping into" the wet well. The GVF solver will determine the
impact of the wet well on the HGL upstream but the wet well will not back flow up into the inflow conduit in the GVF solver. If the user wants to study this occurrence, one of
the dynamic wave solvers should be used.
If a user attempts to connect a gravity conduit to a pressure pipe, a user notification "Gravity elements do not have downstream wet well or outfall. Cannot flow directly to
pressure pipes. Find with network navigator." will be issued. In complex systems, it may be difficult to locate the node where this occurs. This can be found using the Network
Navigator query "Isolated Gravity Elements". This will identify the elements in the gravity subnetwork connected to pressure subnetworks.
[Link] 2025/06/14
Creating Your Model Page 23 of 174
Users may want to model a gravity conduit discharging into a pressure pipe in an inverted siphon. In that situation, it is best to model the pipes in the inverted siphon as gravity
conduits with bolted manhole covers.
Cross-Section Curve
This dialog allows you to define the Cross-Section Curve for a Wet Well with a Variable Volume Cross Section.
Define the cross section by entering the Depth Ratio vs Volume Ratio points in the table.
Pumps
In a wastewater collection system, pumps are placed where the hydraulic grade line must be raised. Since sewage primarily flows by gravity, a pump transports sewage from a
low elevation to a higher elevation. The sewage then flows again by gravity to the next pumping station or until it reaches its destination.
When you click the pump element on the Layout toolbar, your mouse cursor changes into a manhole pump symbol. Clicking in the drawing pane while this tool is active causes a
manhole pump to be placed at the location of the mouse cursor.
Note: Since parallel pumps are a special case of looped network, they are not supported in the StormCAD engine.
You can group elements together by any desired criteria through the use of zones. A Zone can contain any number of elements and can include a combination of any or all
element types.
You define the settings for each pump in your model in the Pump Definitions dialog box. You can define a collection of pump settings for each pump.
1. Click a pump in your model to display the Property Editor, or right-click a pump and select Properties from the shortcut menu.
2. In the Physical section of the Property Editor, click the Ellipses (...) button next to the Pump Definitions field. The Pump Definitions dialog box opens.
3. In the Pump Definitions dialog box, each item in the list represents a separate pump definition. Click the New button to add a new definition to the list.
4. For each definition in the list, perform these steps:
5. Type a unique label for the pump definition.
6. Define a new pump definition by entering Head, Efficiency, and Motor data.
7. Click OK to close the Pump Definitions dialog box and save your data in the Property Editor.
When using the SewerCAD Gradually Varied Flow - Convex (GVF-Convex) engine, user defined on/off elevations will toggle the pump setting based on the HGL at the node
immediately upstream of the pump.
Internally, two logical controls will be generated for each pump during the engine loading phase.
For example:
You also have the option of ignoring the on and off elevations on the pump using the "Ignore On/Off Elevations?" property. When set to True this allows the user to create more
complex logical controls with the existing infrastructure, without worrying about potential conflicting controls.
The following controls are available in the pump definitions dialog box:
[Link] 2025/06/14
Creating Your Model Page 24 of 174
Delete Deletes the currently highlighted entry in the pump definition Pane.
Rename Renames the currently highlighted entry in the pump definition Pane.
Report Generates a pre-formatted report that contains the input data associated with the currently highlighted entry in the pump definition Pane.
Synchronization Clicking this button opens a submenu containing the following commands: Browse Engineering Library —Opens the Engineering Library
Options manager dialog, allowing you to browse the Pump Definition Libraries. Synchronize From Library —Updates a set of pump definition entries
previously imported from a Pump Definition Engineering Library. The updates reflect changes that have been made to the library since it
was imported. Synchronize To Library —Updates an existing Pump Definition Engineering Library using current pump definition entries that
were initially imported but have since been modified. Import From Library —Imports pump definition entries from an existing Pump
Definition Engineering Library. Export To Library —Exports the current pump definition entries to an existing Pump Definition Engineering
Library.
Head Tab This tab consists of input data fields that allow you to define the pump head curve. The specific fields vary depending on which type of pump is selected
in the Pump Definition type field.
Pump A pump is an element that adds head to the system as water passes through it. This software can currently be used to model six different pump types:
Definition Constant Power —When selecting a Constant Power pump, the following attribute must be defined: Pump Power —Represents the water horsepower, or
Type horsepower that is actually transferred from the pump to the water. Depending on the pump's efficiency, the actual power consumed (brake
horsepower) may vary. Design Point (One-Point) —When selecting a Design Point pump, the following flow vs. head points must be defined: Shutoff
—Point at which the pump will have zero discharge. It is typically the maximum head point on a pump curve. This value is automatically calculated for
Design Point pumps. Design —Point at which the pump was originally intended to operate. It is typically the best efficiency point (BEP) of the pump. At
discharges above or below this point, the pump is not operating under optimum conditions. Max Operating —Highest discharge for which the pump is
actually intended to run. At discharges above this point, the pump may behave unpredictably, or its performance may decline rapidly. This value is
automatically calculated for Design Point pumps. Standard (Three-Point) —When selecting a Standard Three-Point pump, the following flow vs. head
points must be defined: Shutoff —Point at which the pump will have zero discharge. It is typically the maximum head point on a pump curve. Design
—Point at which the pump was originally intended to operate. It is typically the best efficiency point (BEP) of the pump. At discharges above or below this
point, the pump is not operating under optimum conditions. Max Operating —Highest discharge for which the pump is actually intended to run. At
discharges above this point, the pump may behave unpredictably, or its performance may decline rapidly.
Pump Standard Extended —When selecting a Standard Extended pump, the following flow vs. head points must be defined: Shutoff —Point at which the pump
Definition will have zero discharge. It is typically the maximum head point on a pump curve. Design —Point at which the pump was originally intended to operate. It
Type is typically the best efficiency point (BEP) of the pump. At discharges above or below this point, the pump is not operating under optimum conditions.
(cont’d) Max Operating —Highest discharge for which the pump is actually intended to run. At discharges above this point, the pump may behave unpredictably,
or its performance may decline rapidly. Max Extended —Absolute maximum discharge at which the pump can operate, adding zero head to the system.
This value may be computed by the program, or entered as a custom extended point. This value is automatically calculated for Standard Extended
pumps. Custom Extended —When selecting a Custom Extended pump, the following attributes must be defined: Shutoff —Point at which the pump will
have zero discharge. It is typically the maximum head point on a pump curve. Design —Point at which the pump was originally intended to operate. It is
typically the best efficiency point (BEP) of the pump. At discharges above or below this point, the pump is not operating under optimum conditions. Max
Operating —Highest discharge for which the pump is actually intended to run. At discharges above this point, the pump may behave unpredictably, or its
performance may decline rapidly. Max Extended —Absolute maximum discharge at which the pump can operate, adding zero head to the system. This
value may be computed by the program, or entered as a custom extended point. Multiple Point (SWMM Type 3) —When selecting a Multiple Point
pump, an unlimited number of Flow vs. Head points may be defined defined relating the pump flow and head as found in a pump head characteristics
curve. The points should be entered in increasing order in terms of flow. Volume vs. Flow —The user populates a table in increasing order with respect to
volume of the flow from the pump as a stepwise function of volume in the wet well. Depth vs. Flow (SWMM Type 2) —The user enters a table in
increasing order with respect to depth of the flow from the pump as a stepwise function of depth in the wet well. Depth Flow (Simulated Variable Speed)
—Variable speed in-line pump where flow varies continuously with inlet node depth. The user enters a table giving the flow as a function of depth in the
wet well. It can be used in the implicit dynamic wave or explicit SWMM solvers to approximate the behavior of one of more variable speed pumps in a
station where the variable speed pump flows are controlled to match the inflow to the wet well. The user should initialize the wet well depth to be the
level which the user wants to maintain. The flow in the pump definition should increase significantly when the level exceeds the target and decrease
significantly when the level decreases below the target.
Efficiency This tab allows you to specify efficiency settings for the pump that is being edited.
Tab
Pump Allows you to specify the pump efficiency type for the pump that is being edited. The following efficiency types are available: Constant Efficiency —This
Efficiency efficiency type maintains the efficiency determined by the input value regardless of changes in discharge. When the Constant Efficiency type is selected,
the input field is as follows: Pump Efficiency —The Pump Efficiency value is representative of the ability of the pump to transfer the mechanical energy
generated by the motor to Water Power. Best Efficiency Point —This efficiency type generates a parabolic efficiency curve using the input value as the
best efficiency point. When the Best Efficiency Point type is selected, the input fields are as follows: BEP Flow —The flow delivered when the pump is
operating at its Best Efficiency point. BEP Efficiency —The efficiency of the pump when it is operating at its Best Efficiency Point. Define BEP Max Flow
—When this box is checked the User Defined BEP Max Flow field is enabled, allowing you to enter a maximum flow for the Best Efficiency Point. User
Defined BEP Max Flow —Allows you to enter a maximum flow value for the Best Efficiency Point. Multiple Efficiency Points —This efficiency type
generates an efficiency curve based upon two or more user-defined efficiency points. These points are linearly interpolated to form the curve. When the
Multiple Efficiency Points type is selected, the input field is as follows: Efficiency Points Table —This table allows you to enter the pump's efficiency at
various discharge rates.
Motor Tab This tab allows you to define the pump's motor efficiency settings. It contains the following controls:
Motor The Motor Efficiency value is representative of the ability of the motor to transform electrical energy to rotary mechanical energy.
Efficiency
Is Variable This check box allows you to specify whether or not the pump is a Variable Speed Pump. Toggling this check box On allows you to input points on the
Speed Efficiency Points table.
Drive?
Efficiency This table allows you to enter speed/efficiency points for variable speed pumps. This table is activated by toggling the "Variable Speed Drive" check box
Points On.
Table
Transient This tab allows you to define the pump's Bentley SewerGEMS -specific transient settings. It contains the following controls:
Tab
Inertia Inertia is proportional to the amount of stored rotational energy available to keep the pump rotating (and transferring energy to the fluid), even after the
(Pump power is switched off. You can obtain this parameter from manufacturer's catalogs, or from pump curves, or by using the Pump and Motor Inertia
Calculator. To access the calculator, click the ellipsis button.
[Link] 2025/06/14
Creating Your Model Page 25 of 174
and
Motor)
Speed Speed denotes thenumber of rotations of the pump impeller per unit time, generally in revolutions per minute or rpm. This is typically shown
(Full) prominently on pump curves and stamped on the name plate on the pump itself.
Specific Specific speed provides four-quadrant characteristic curves to represent typical pumps for each of the most common types, including but not limited to:
Speed 1280, 4850, or 7500 (U.S. customary units) and 25, 94, or 145 (SI metric units).
Reverse Indicates whether the pump is equipped with a ratchet or other device to prevent the pump impeller from spinning in reverse.
Spin
Allowed?
Library This tab displays information about the pump that is currently highlighted in the Pump Definitions Pane. If the pump is derived from an engineering
Tab library, the synchronization details can be found here. If the pump was created manually for this model, the synchronization details will display the
message Orphan (local), indicating that the pump was not derived from a library entry.
Notes Tab This tab contains a text field that is used to type descriptive notes that will be associated with the pump that is currently highlighted in the Pump
Definitions Pane.
The following illustration shows the four different pump curve types.
Bentley SewerGEMS pump types correspond to the above pump types as follows:
Some pump types only work with certain solvers as described below:
[Link] 2025/06/14
Creating Your Model Page 26 of 174
In the GVF solver, the user can specify (in the Calculation Options) whether linear or smooth interpolation is used with the multipoint pump curve. The implicit and explicit
solvers use linear interpolation between points.
You define pump curves in the Pump Definitions dialog box. You can also define pump curves in the Engineering Library.
Pump Controls
There are several ways of controlling pump on/off status depending on the active solver. There are three types of controls: on/off, SWMM control statements and GVF pressure
control statements and are summarized below and described in more detail in the following paragraphs.
The GVF-rational solver and steady runs in the GVF-convex solver do not have pump controls because these solvers only perform a steady run only and the initial pump status is
all that is needed.
On/Off controls are a property of a given pump based on the hydraulic grade line elevation at the node (usually a wet well) immediately upstream of the pump. These controls
will not be used if "Ignore On and Off Elevations" is set to True. If it is set to false, these settings must be specified and the on elevation must be higher than the off elevation.
This type of control setting is the simplest and works with all three solvers than use controls which makes it easy to switch between solvers. However, it cannot consider
complicated control actions such as those based on time or flow rates.
SWMM control statements can be established for any element when the explicit solver is used. These can handle complex conditions and actions. They are set up under
Components > SWMM extensions > Control sets. See the help for [Control Sets Tab and Control Sets Dialog Box] for details on setting up these controls.
GVF pressure control statements apply to pressure elements in a pressure subnetwork and are generally used for controlling pumps. These controls are set in Components >
Controls. Like SWMM control statements, they can contain complex conditions and actions. See the help for [Controls and Controls Tab] for details on setting up these controls.
When both GVF pressure controls and on/off controls are provided for a pump, the GVF pressure controls have priority in case the two types of controls try to set different
pump status.
The columns that are available in this dialog will vary depending on the Pump Curve Type that is selected in the menu of the same name in the Engineering Library. For
descriptions of the various pump attributes, see "Pump Definitions Dialog Box" .
[Link] 2025/06/14
Creating Your Model Page 27 of 174
To view combination pump curves it is first necessary to include the pumps in a Pump Station element. This can be done by opening the property grid for the pump, picking the
Pump Station property and selecting the pump station in which this pump is located. It is usually advisable to draw the pump station polygon to include the pumps within the
polygon (See ”Pump Stations’).
The pump head and efficiency characteristic curves are properties solely of the pump and can be displayed even if the model only consists of the pump station with the pumps. If
the user wants to display system head curves, then the pump station must be part of a valid hydraulic model.
The Flow-Efficiency Curve dialog is only available for the Multiple Efficiency Points efficiency curve type. The curve is defined by entering points in the Flow vs. Efficiency table.
Click the New button to add a new row and click the Delete button to delete the currently highlighted row.
The Speed-Efficiency Curve dialog is only available for Variable Speed Drive pumps (Is Variable Speed Drive? is set to True). The curve is defined by entering points in the Speed
vs. Efficiency table. Click the New button to add a new row and click the Delete button to delete the currently highlighted row.
[Link] 2025/06/14
Creating Your Model Page 28 of 174
Submersible Pumps
Wastewater collection systems frequently use submersible pumps. However, the model needs a link to connect the suction side of the pump to a node (usually a wet well). The
pressure solver in the GVF-convex solver needs a suction pipe (pressure pipe) connecting the pump to a suction node (a wet well for submersible pumps). To simulate a
submersible pump, the user should connect the wet well to the pump with a short pipe to move the water into the pump with negligible head loss. It can even be a virtual
conduit. In the GVF-convex solver, this pipe must be a pressure pipe while in the other solvers it can be a pressure pipe or conduit. If the user plans to switch between solvers, it
is bet to make it a pressure pipe.
The Elevation (Invert) for the submersible pump should be the low point of the pump inlet.
The following hydraulic and hydrologic behaviors apply to pumps and wet wells when using the Gradually Varied Flow - Rational engine:
Flows:
When the status of the pump is ON, then pump discharge is equal to wet well inflow. When the status is OFF, pump discharge is set to zero.
Profiles:
The pump curves specified in the other solvers are not used by the GVF solver. Instead, the suction head of the pump is taken as the wet well level and the discharge head on the
pump is determined using the GVF backwater analysis from downstream elements. The heads can be used to determine pump selection.
Parallel variable speed pumps (VSPs) are operated as one group and led by a single VSP, the so-called lead VSP, while the other VSPs at the same battery are referred as to as lag
VSPs. A lag VSP turns on and operates at the same speed as the lead VSP when the lead VSP is not able to meet the target head and turns off when the lead VSP is able to deliver
the target head or flow.
From the standpoint of input data, Variable Speed Pump Batteries are treated exactly the same as single pump elements that are defined as variable speed pumps of the Fixed
Head Type with one exception; number of Lag Pumps must be defined in the Lag Pump Count field.
When simulating a Pump Battery in a transient analysis, the pump battery is converted to an equivalent pump using the following conversion rules:
1. The Flow (Initial) of the equivalent pump is the total flow of all the running pumps in the pump battery.
2. The Inertia of the Pump and Motor of the equivalent pump is the sum of all the inertia values for all the running pumps.
3. The Specific Speed of the equivalent pump is the Specific Speed value that is closest to the result of the following equation: sqrt(number of running pumps) * Specific
Speed of pump battery
The behavior of a VSPB in cannot be captured with the GVF-rational solver if the pump is operated any way other than inflow matching outflow. However, there are ways of
mimicking VSPB behavior in the dynamic wave implict (DW) and explicit (SWMM) solvers using the “Depth-Flow (Variable Speed)" (Type 4) pump in the pump definition. For
example, suppose that a variable speed pump station with several pumps is operated to maintain a wet well depth of 30 in. (outflow matching inflow), and the normal inflow is
roughly 0.5 cfs and the maximum the station can pump is 2 cfs. The table of flow vs. depth in the pump definition might have values like the ones below. The final point should
correspond to the maximum pump battery flow at the maximum wet well depth. It is advisable to cover the full range of wet well depths.
[Link] 2025/06/14
Creating Your Model Page 29 of 174
As soon as the inflow deviated from the previous value, the depth would change and the outflow would respond.
If you want to switch between the GVF-convex and either SWMM or DW with a VSPB, a different active topology must be used for the two types of models. Create an active
topology which contains a VSPB for GVF-convex scenarios and one which contains a pump that simulates a VSPB for SWMM and DW scenarios. The model should look something
like the image below, which shows the case where the VSPB is inactive.
If there is an active VSPB element in a solver other than GVF-convex a fatal error message is issue and the run does not proceed.
Pump Stations
A pump station element provides a way for a user to indicate which pumps are in the same structure, serving the same pressure zone. It provides a graphical way to display the
pumps associated with the station. A pump station is not a hydraulic element in that it is not directly used in a hydraulic analysis but rather it is a collection of pumps which are
the hydraulic elements.
A pump station is a polygon element which displays which pumps are in the station by dashed lines connecting the pumps with the station polygon centroid. A pump does not
need to be inside the polygon to be a pump assigned to the station and pumps inside the polygon still need to be assigned to the station. The only information saved with a
pump station is the geometry of the station and the list of pumps assigned to the station.
A pump station element is useful in calculating and displaying an analysis of pump combinations.
Usually the pumps and associated piping are laid out before the station is drawn. However, the station polygon can be drawn first. The station element is created by picking the
pump station element icon
from the layout menu and drawing a polygon around the extents of the station. When the polygon is complete, the user right clicks and selects "Done".
Individual pump elements are assigned to a station by selecting the pump element and in the Pump Station property, picking the pump station which the pump is associated. A
dashed line is drawn from the pump to the station. This also can be done in the physical alternative for pumps. To assign several pumps at once, a global edit can be used
provided that at least one pump has already been assigned to that station.
Sometimes a pump station structure can house pumps pumping to more than one pressure zone (e.g. medium service and high service). For the purposes of Bentley
SewerGEMS , this would be two (or more) pump station polygon elements, one for each pressure zone.
[Link] 2025/06/14
Creating Your Model Page 30 of 174
New Creates a new pump station that uses an automatically created label.
Report Lets you generate a preformatted report that contains the input data associated with the currently highlighted pump station.
Click the Report button to generate a report containing the list of pumps included in the pump station as well as their associated pump definitions. Click the Zoom To button to
focus the drawing view on the pump that is highlighted in the list.
The notion of pump stations changed significantly with the SELECT series 3 release of the Bentley storm and sanitary sewer models. Pump stations are treated differently in the
GVF-convex solver vs. the implicit and explicit solvers.
Pump station elements are polygons and individual pumps are assigned to them by assigning the "Pump station" property for each pump element in the property grid. Pumps do
not need to be assigned to pump stations for the model to run. Below, PMP-1 and PMP-2 are assigned to pump station PS-1 as indicated by the dashed line.
[Link] 2025/06/14
Creating Your Model Page 31 of 174
In the GVF-convex solver, it is possible to right click on a pump station polygon and analyze combination pump curves which can overlay pump head and efficiency curves and
when the station is part of a runable model, can overlay the system head curve. See [combination pump curve help] for details.
Variable speed pump batteries can also be assigned to pump station but they are only used in the GVF-convex solver.
In the explicit and implicit solver, the pump station element is used only for drawing purposes and generally there is one pump element for each pump. (The ability to lump
multiple pumps into a single station using Components > Pump station only exists in SELECTseries 1 and earlier. When importing an earlier model into a newer version, the pump
station properties (initial level and on/off settings) are assigned to the individual pumps not a pump station.)
In special cases in explicit and implicit solvers, a Volume vs. Flow or Depth vs. Flow curve can be used to approximate multiple pumps turning on with a curve as shown below.
Catchments
When you click the catchment element on the Layout toolbar, your mouse cursor changes into a catchment element symbol. Clicking in the drawing pane while this tool is active
causes a catchment element to be placed at the location of the mouse cursor.
Hydrograph Methods
Specifying a Time of Concentration (Tc) Method for a Catchment
Defining the Geometry of a Catchment or a Pond
Time-Area Table Dialog
Loss Methods
Subareas Collection
Hydrograph Methods
With the exception of purely sanitary flow systems with no wet weather effects, Bentley SewerGEMS starts its hydraulic calculations from a hydrograph for each catchment.
There are numerous ways of generating those hydrographs. Most involve starting with Storm Data then calculating a runoff hydrograph using one of the following methods:
• SCS
• Unit Hydrograph
• EPA SWMM
• Modified Rational Method
• RTK Unit Hydrograph Method
Virtually any hydrograph and loss method can be used with any numerical engine with the following exceptions:
1. Modified rational method only works with Implicit engine and only with peak intensity (IDF) rainfall (Local rainfall is not supported).
2. If you choose the SWMM engine and specify EPA-SWMM runoff method, then all catchments must use that runoff method and the loss method specified on the
calculation options manager (only Green -Amt, Horton, or SCS).
[Link] 2025/06/14
Creating Your Model Page 32 of 174
However, it is also possible to directly enter a hydrograph by specifying a user-defined hydrograph for any catchment.
Some types of Tc equations can apply to flow segments within a multiple-segment Tc calculation. Other Tc methods are equations intended to model the entire average subarea
flow distance and slope in one single flow segment. When combining multiple flow segments to compute Tc, it is up to you to only combine Tc methods that can be modeled in
combination with multiple flow segments.
1. Click a catchment in your model to display the Property Editor, or right-click a catchment and select Properties from the shortcut menu.
2. In the Runoff section of the Property Editor, select Modified Rational Method in the Runoff Method field. The Tc (hours) field becomes available.
3. Click the Ellipses (...) button next to the Tc (hours) field. The Tc Data Collection dialog box appears.
4. Click New, then select a Tc Method from the submenu.
5. Different fields become available depending on which Tc Method you select. For each Tc Method, type values in the appropriate fields.
6. Click OK to close the dialog box and save your Tc Collection data (time of concentration in hours) in the Property Editor.
This dialog box allows you to define the Time of Concentration method. Both single and multiple flow segments can be modeled in this dialog box.
The dialog box contains the Tc Method display pane, which lists all of the methods currently assigned to the catchment, a control section that allows you to edit the attributes
associated with the method currently highlighted in the table, and the following buttons:
New Displays a submenu that allows you to specify the Tc method to be created.
Report Opens a print preview window containing a report that details the input data for this dialog box.
Bentley SewerGEMS supports the following 13 methods, which are listed along with the required input data for each:
• User Defined Tc—The user-defined time of concentration (Tc) is a method that allows the direct input of the Tc rather than using an equation to calculate it. This method
would be used when the Tc needs to be calculated using a methodology that is not supported by Bentley SewerGEMS , or when a quick estimate of Tc is sufficient for the
analysis.
◦ User Defined Tc—Lets you explicitly define the Tc, rather than have it calculated for you using one of the other methods.
• Carter—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
• Eagleson—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
◦ Manning’s n—The Manning’s roughness value of the catchment section.
◦ Hydraulic Radius—Lets you define the hydraulic radius of the catchment section.
• Espey/Winslow—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
◦ Channel Factor—Lets you define the Espey channelization factor of the catchment section.
◦ Impervious—Lets you define the percentage of impervious area of the catchment section.
• FAA—This method requires the following input data:
◦ Overland Flow Length—Lets you define the length of the overland pipe flow of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
◦ Runoff Coefficient—Lets you define the rational C coefficient of the catchment section.
• Kerby/Hathaway—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
◦ Manning’s n—The Manning’s roughness value of the catchment section.
• Kirpich (PA)—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
◦ Tc Multiplier—Lets you define the time-of-concentration adjustment multiplier.
• Kirpich (TN)—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
◦ Tc Multiplier—Lets you define the time-of-concentration adjustment multiplier.
• Length and Velocity—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Velocity—Lets you define the velocity of flow in the catchment section.
• SCS Lag—This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section of the catchment section.
◦ CN—Lets you define the SCS runoff curve number of the catchment section.
• TR-55 Sheet Flow—This number represents the sheet flow time computed for each column of sheet flow data. This method requires the following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
◦ Slope—Lets you define the slope of the catchment section.
◦ Manning’s n—The Manning’s roughness value of the catchment section.
◦ 2 yr. 24 hr. Depth—Depth of 2 year 24 hour storm.
• TR-55 Shallow Concentrated Flow—This number represents the sheet flow time computed for each column of shallow concentrated flow data. This method requires the
following input data:
◦ Hydraulic Length—Lets you define the flow length of the catchment section.
[Link] 2025/06/14
Creating Your Model Page 33 of 174
You may have defined the geometry of a polygon element with some number of points (vertices) but you want to refine the shape by adding more vertices to the polygon or
removing vertices. To add vertices, right click on an edge of the polygon and pick Bend > Add Bend. If you want to smooth the edge by removing points, pick on the point, right
click and pick Bend > Remove Bend.
1. Click a catchment or pond in your model to display the Property Editor, or right-click a catchment or pond and select Properties from the shortcut menu.
2. In the Geometry section of the Property Editor, click the Ellipses (...) button next to the Geometry field.
3. In the Polygon Vertices dialog box, click the New button to add a new row to the table.
4. Type values for X and Y points for each row in the table.
5. To remove rows from the table, click the Delete button.
6. Click OK.
This dialog box lets you define X vs. Y points that plot the shape of the polygon that represents the selected element. The dialog box contains the X vs. Y table that allows you to
define any number of points and the following buttons:
Specify the Time vs Area points in associated columns of the table. Click New to create a new row in the table. Click Delete to remove the currently highlighted row from the
table. Click Report to generate a report for the Time-Area table. Click Graph to generate a graph of the time-area points.
See also:
[Link] 2025/06/14
Creating Your Model Page 34 of 174
Loss Methods
Supported hydrology runoff and loss methods include:
Constant Rate: This method is also called as "fLoss", the model uses the user specified loss rate (unit being depth/time) to deduct it from the rainfall intensity curve to get the
excess rainfall curve for runoff calculation.
Initial Loss and Constant Rate: User specifies an initial loss value and a constant loss rate, the model first applies the initial loss to the rainfall intensity curve and after the initial
loss taken the model applies a constant loss rate to get the excess rainfall intensity curve for runoff calculation. If one of the two data is zero then it means that only one of the
loss types (either initial loss or the constant rate loss) is applied. Therefore basically this loss method covers 3 types of losses:
• Initial Loss
• Constant Rate Loss
• Initial Loss and Constant Rate Loss combined
Initial Loss and Constant Fraction: User specifies an initial loss value and a constant fraction, the model first applies the initial loss to the rainfall intensity curve and after the
initial loss taken the model applies a constant fraction loss to get the excess rainfall intensity curve for runoff calculation. If one of the two data is zero then it means that only
one of the loss types (either initial loss or the constant fraction loss) is applied. Therefore basically this loss method covers 3 types of losses:
• Initial Loss
• Constant Rate Loss
• Initial Loss and Constant Rate Loss combined
Subareas Collection
Most catchments are comprised of more than one type of ground cover. For example, a roadside drainage inlet may accept flow from the paved roadway, the curbside grass,
and a nearby wooded area. This dialog allows you to model this, using a collection of subareas, each with their own characteristics. You can define the percentage of the total
catchment area, a surface description, and a runoff coefficient. Note that the percentages must add up to 100. Surface description is a text field that you can use to further
describe the subarea, so you could use descriptions like "Paved Roadway Surface" or "Curbside Grass" for example.
When you click the LID control element on the Layout toolbar, your mouse cursor changes into a LID control element symbol. LID control elements are polygons. Clicking in the
drawing pane while this tool is active causes one point of the LID control polygon to be placed at the location of the mouse cursor. Continue clicking to define the other points
that make up the polygon to define the shape of the LID control. To finish placing the LID control, right-click and select Done.
If the shape of the LID control is not important, such as in a schematic drawing, you can place a generic LID control by holding down the Ctrl button after clicking once, then
moving the mouse cursor to define the size of the LID control, then clicking again to place it.
Although a LID control can only be associated with a single Parent catchment, a single catchment may be a "Parent" for multiple LID controls acting in parallel.
Further, a Parent catchment may represent only the area occupied by LID controls, or it may include non-LID area. The catchment must have an outflow node, which, if desired,
can be another catchment.
[Link] 2025/06/14
Creating Your Model Page 35 of 174
The possibilities just described for configuring LID controls and Parent catchments translate to two main options for how to approach your network configuration. The benefits
and limitations of each approach should be carefully considered against the needs of a particular model.
With this approach, a new catchment is created for each LID control in the network. It is the LID control's Parent Catchment, and represents only the area occupied by the LID
control.
Flow from additional catchment area(s) is directed to the LID control by designating the LID's Parent Catchment as the additional catchment's "Outflow Node."
Under this scenario, in the Low Impact Development Control properties dialog, the attribute "Occupies Full Subcatchment" will be set to True.
• Multiple LIDs can be placed in series, if desired (i.e., upstream LID's parent catchment and have downstream LID's parent catchment as its outflow node)
• Explicit definition of a LID's contributing area (as opposed to defining as a percentage of impervious area, which is in turn a percentage of total catchment area)
• Ability to direct upstream pervious area to the LID control. (With a parent catchment, only impervious non-LID area can be directed to the LID control.)
• Avoids possible mistakes with parent catchment impervious area percentage and characteristic width resulting from the addition of a LID control (see Option 2)
• Enables more explicit hydrograph reporting to show LID control effects
A possible disadvantage of this option is a greater number of network elements in the model.
With this option, the Parent catchment Area includes the total area occupied by the LID Control(s), as well as adjacent non-LID area. The LID Control attribute "Occupies Full
Catchment?" is set to False, and the attributes "Area of Each Unit" and "Number of "Replicate Units" define the area that a LID control displaces from the Parent catchment.
This approach allows multiple LID controls to be associated with a single catchment. If multiple LID controls are present, they act in parallel to each treat a different portion of
the runoff generated from the non-LID catchment area.
The advantage of this option is that it minimizes the number of network elements that must be placed in the model, enabling a more uncluttered appearance and reducing data
entry in some cases.
• The catchment's LID controls cannot be considered in series (i.e., the outflow from one LID control cannot be inflow for another downstream).
• Only runoff from the impervious portion of the parent catchment can be directed to the LID control(s).
• Caution must be exercised with regard to parent catchment attributes for Percent Impervious and Width. These values must reflect the non-LID portion of the catchment
only. For example, if the original Parent catchment is 40% impervious, and in the course of design, 75% of this impervious area is changed to porous pavement, then the
percent impervious must be adjusted to (1 - 0.75)*40/(100 - 0.75*40) = 14.3%. Similarly, the catchment's "Characteristic Width" can be affected. If estimating this value as
area divided by overland flow length, the area used would typically be the non-LID area only.
Ponds
When you click the pond element on the Layout toolbar, your mouse cursor changes into a pond element symbol. Clicking in the drawing pane while this tool is active causes a
pond element to be placed at the location of the mouse cursor.
Note: If there are multiple discharges locations serving a pond then they must all be modeled in the same manner; that is, they must either all be modeled with outlet control
structures, or all modeled without outlet control structures.
The first two are modeled as “ponds” in Bentley SewerGEMS CONNECT. Any of these elements may be used as the suction side of a pump.
Not all of the physical properties are needed for each method of describing pond (storage element) dimensions.
The type of attribute needed for each type of data entry is summarized in the table below:
[Link] 2025/06/14
Creating Your Model Page 36 of 174
For more information on the physical characteristics of ponds, see the following help topics:
Outdoor Ponds
Elevation vs. Area
Elevation vs. Volume
Percent Void Space (%)
Pipe Volumes
Functional (Equation)
1. Click a pond in your model to display the Property Editor, or right-click a pond and select Properties from the shortcut menu.
2. In the Physical section of the Property Editor, select Elevation-Area Curve in the Volume Type field. The Elevation-Area Curve field becomes available.
3. Click the Ellipses (...) button next to the Elevation-Area Curve field.
4. In the Elevation-Area Curve dialog box, each row in the table represents a point on the Elevation-Area curve. Type values for Elevation, Area, and Percent Void Space for
each row. Click the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
The dialog box contains the elevation-area table and the following buttons:
Delete Deletes the currently highlighted row from the elevation-area table
Report Opens a print preview window containing a report that details the input data for this dialog box.
Graph Opens a graph window plotting the area-elevation curve defined by the points in the table.
Column Description
Elevation The elevation data for the pond.
Area The plan area at that elevation.
Percent Void The void space volume data for the pond. Void space is used on any volumes option to adjust the effective storage volume for rock-filled or other
Space porous media filled basins or vaults. Set this to 100% if there are no rocks or fill to reduce the available volume.
[Link] 2025/06/14
Creating Your Model Page 37 of 174
You can add an elevation-volume curve to a pond. The area-volume points defined in the curve are used to calculate pond volumes. The elevation-volume points defined in the
table are used to calculate total pond volume. It is important that this storage relation be single-valued. This means that any volumetric quantity occurs only once in the table
only, as Bentley SewerGEMS interpolates linearly between any two values in the table. You define elevation-area curves in the Elevation-Volume Curve dialog box.
1. Click a pond in your model to display the Property Editor, or right-click a pond and select Properties from the shortcut menu.
2. In the Physical section of the Property Editor, select Elevation-Volume Curve in the Volume Type field. The Elevation-Volume Curve field becomes available.
3. Click the Ellipses (...) button next to the Elevation-Volume Curve field.
4. In the Elevation-Volume Curve dialog box, each row in the table represents a point on the Elevation-Volume curve. Type values for Elevation, Volume, and Percent Void
Space for each row. Click the New button to add a row or press the Tab key to advance to the next field in the table.
5. Perform the following optional steps:
6. To delete a row from the table, select the row then click Delete.
7. To view a report on the curve, click Report.
8. To view a plot of the curve, click Graph.
9. Click OK to close the dialog box and save your curve data in the Property Editor.
This dialog box allows you to define elevation-volume tables. The dialog box contains the elevation-volume table and the following buttons:
Delete Deletes the currently highlighted row from the elevation-volume table
Report Opens a print preview window containing a report that details the input data for this dialog box.
Graph Opens a graph window plotting the area-volume curve defined by the points in the table.
Column Description
Elevation The cumulative volume from the bottom of the pond to that elevation.
Volume The volume data for the pond.
Void The void space volume data for the pond. Void space is used on any volumes option to adjust the effective storage volume for rock-filled or other porous
Space media filled basins or vaults. Set this to 100% if there are no rocks or fill to reduce the available volume.
Ponds in StormCAD
Ponds in StormCAD are treated similarly to a manhole node, however there are calculation differences based on how the pond is set up as follows:
The control structures are normally used to reduce the peak flow, so StormCAD calculations on such pond settings consider the flow reduction through the pond control
structures.
You can use the pond initial elevation to control the outflow reduction; the solver uses the specified pond initial elevation and performs hydraulic calculations for the outlet
control structures to determine the pond outflow. Once the pond outflow is determined it becomes a fixed flow (system additional flow) and all other fixed and rational flow
elements are terminated at the pond outlet and the new fixed outlet flow will carry on to the downstream calculations.
The user-specified pond initial elevation will be the calculated pond hydraulic grade line and is used for upstream profile calculations, regardless what the downstream
backwater profile gives at the pond.
Ponds in SewerCAD
If there is no control structure, a pond in SewerCAD is treated just like a manhole node; the steady flow routing is passing through the pond the same as passing through a
manhole. All flow elements are passed through the pond and the steady routing calculation is continued downstream.
The outlet control structures are ignored (no control hydraulics are performed). Flow(in) = Flow(out).
If there is no control structure, the HGL is the value calculated by the gradually varied flow profiler and the input pond initial elevation is ignored.
If there is a control structure and the initial elevation is larger than the one given by the outlet pipe profile calculation then the initial elevation is set as the pond HGL.
The existing Inflow(Wet Collection) in the pond is kept and you caninput a Fixed load for steady state simulations.
[Link] 2025/06/14
Creating Your Model Page 38 of 174
The engine performs storage routing for a pond when the convex routing comes to the pond node.
The pond initial elevation is the start pond HGL for the storage routing and the inflow hydrograph is determined from the upstream convex routing.
AE-Q curve is loaded for the pond outlet (the first curve of the EQT curves based on the fundamental GVF assumption that there are no backwater effects).
Then the Gradually Varied Flow (GVF) engine performs the storage routing to determine the pond outflow hydrograph and the pond elevations for each hydrologic time step.
For the profile, the pond elevation time series determined from the storage routing will be compared with the HGL calculated by GVF profiler and the larger value will be used as
the pond HGL for the time.
In the case where the outlet has no control structures, the outlet conduit data is used to generate an E-Q curve for the outlet.
The infiltration calculation assumes the pond has outlet control structures since there is no pond routing without control structures. The behavior is the as same as the Dynamic
Wave engine.
If the pond type is of elevation-volume, there will be an error message for the average type infiltration.
This scenario is treated very similarly to the way it is handled in StormCAD (see ”Ponds in StormCAD’).
If there is no control structure, a pond is treated just like a manhole node; the steady flow routing is passed through the pond the same as it would pass a manhole. All flow
elements are passed through the pond and the steady routing calculation is continued downstream.
1. The pond outflow will be determined by an EQT curve using the pond initial elevation and assuming a very low tailwater.
2. The pond outflow will become a wet weather flow and all system unit flows are set to 0 from this point.
3. The pond HGL will use the user-specified pond initial elevation.
Air Valves
Air valves are placed at high points in piping systems, to bleed air during filling, release air that accumulates over time and allow inflow of air to prevent negative pressure and
possible pipe collapse.
In typical wastewater collection system piping, pressures are positive between the pump station and a high point along the force main when the pumps are running. When the
pump turns off, the force main that was pressurized remains full while any downward sloping pipes drain. The behavior of air valves becomes very important in force mains with
multiple high points.
No loads can be assigned to air valves. Air valve elements can only be attached to pressure pipes, not on gravity conduits. They should be attached to two pipes. If they are
attached to more than two, an error will be issued. If they are placed at the end of a dead end pipe, they will not do anything.
In the Bentley storm and sanitary sewer products, the behavior of air valve elements depends on the active solver.
GVF-Convex Solver
The GVF-convex solver uses a true pressure solver where the pipes are generally treated as full. When the hydraulic grade is above the valve elevation, the valve will remain
closed. When the hydraulic grade line drops to the valve elevation, the air valve prevents the hydraulic grade from dropping below the valve and the pipe acting as a siphon. The
GVF solver enables the user the ability to see which pipes flow partly full as those pipes will have a hydraulic grade line below the pipe on the downhill side of a high point.
A user can force an air valve to be closed in a model run by setting the "Treat Air Valves as Junction" property to True. The default setting in sewer models is False. However, only
those air valves than may reasonably open during a simulation need to have that property set to False. This will make the simulations run faster as fewer checks will need to be
made on valve status.
If an air valve at a high point is closed or treated as a junction and the pressure becomes negative (hydraulic grade drops below valve), the pipes will behave as a siphon. This is
usually undesirable because the pipe may collapse under the negative pressure or gases may come out of solution and cause excess head loss at the high point. The maximum
that a high point of a pipe can be above the hydraulic grade is 32 ft (9.8 m) or a siphon cannot be formed.
Gravity Solvers -- Implicit (Dynamic Wave), Explicit (SWMM) and GVF rational Solvers
These solvers do not have the unique air valve behavior as in the GVF convex solver since none of these are true pressure solvers. An air valve, assigned to a model with these
solvers, is treated as a manhole with a bolted cover which is essentially the same as an active air valve. It is not possible to solve for a high point as a siphon with these solvers.
In the implicit and explicit solvers, air valve elements are treated essentially as manholes with a bolted cover which can let air in and out but do not allow release of water. They
do not accurately model air flow through orifices and as such cannot be used for sizing orifices in the air valves.
While they are useful in normal operation, they are especially important in transient analysis. This is described in "Air Valves in HAMMER". They are also used in filling and
draining of pipelines which can be addressed in the implicit and explicit solvers in Bentley SewerGEMS .
While air valves are often placed on pumps to remove air, their primary use is at high points in pressure piping systems which are the first locations which can experience
negative pressure in pipeline systems and are the most likely places where air and other gases can accumulate.
[Link] 2025/06/14
Creating Your Model Page 39 of 174
In sewer force mains, irrigation systems and raw water transmission systems, pressure can drop when pumps turn off or head loss becomes excessive and they can often be in
the open position and pipes can be partly full, immediately downstream of the high point. Drinking water distribution systems are designed not to have negative pressures.
If there is no air valve placed at a high point and the pressure drops below zero, the valve will behave as a siphon. This is generally not recommended as flexible pipes may
collapse.
The behavior of air valves can be best viewed using a profile view. With an air valve in place, the valve would prevent the negative pressure by opening to atmosphere. There
may be partially full flow downstream of the high point (where the hydraulic grade line is below the pipe). The location where the hydraulic grade line rises over the pipe is the
location where full pipe flow is restored.
In most cases, when the pump is operating, the hydraulic grade line will remain above the pipe and the air valve will be closed.
When the pump or other source on the upstream side of the high point is shut off or closed, the pipe generally remains full. The display when the pump is off will look like this. In
this example, the fact that the pipe downstream of the high point is still draining at this time is reflected in the hydraulic grade above the pipe in some places.
While they are useful in normal operation of pressure pipes, they are especially important in transient analysis. See the help for air valves in HAMMER. They are also used in
filling and draining of pipelines which is best modeled with the implicit or explicit solvers.
While air valves are often placed on pumps to remove air, their primary use is at high points in pressure piping systems which are the first locations which can experience
negative pressure in pressurized water systems and are the most likely places where air can accumulate.
[Link] 2025/06/14
Creating Your Model Page 40 of 174
In sewer force mains, irrigation systems and raw water transmission systems, pressure can drop when pumps turn off or head loss becomes excessive and they can often be in
the open position and pipes can be partly full, immediately downstream of the high point.
Because air valves can change status during a model run, they can introduce instability in the run. The more air valves, the more likely this is to occur. In systems with multiple
valves, it is best to focus the analysis on those valves which are likely to open and close. The valves that are almost certain to be closed in the analysis can have a property "Treat
as Junction?" set to True and the air valve will behave as a junction node in the model run. The "Treat as Junction" property is the only property in steady and EPS runs that is
different between a pressure junction and an air valve. For transient analysis (available in HAMMER), there are numerous other properties that can come into play.
If there is no air valve at a high point and the pressure drops below zero, the pipeline will behave as a siphon. This is generally not recommended as flexible pipes may collapse
and corrosive gases can build up in the high point.
The behavior of air valves can be best viewed using a profile view. With no air valve, the profile of a siphon would look like the figure below with the hydraulic grade below the
node level.
With an air valve in place, the valve would prevent the negative pressure by opening to atmosphere. There may be partially full flow downstream of the high point (where the
hydraulic grade line coincides with the pipe). The location where the hydraulic grade line rises over the pipe is the location where full pipe flow is restored.
In most cases, when the pump is operating, the hydraulic grade line will remain above the pipe and the air valve will be closed.
When the pump or other source on the upstream side of the high point is shut off or closed, the pipe generally remains full. Therefore, the profile will be flat between the pump
and the high point. The GVF solver does not account for the time it takes to fill the downstream section of pipe beyond the air valve once the pump is turned back on based on
the assumption that the time to fill the pipe is small compared with the model time step. If analysis of the filling of a pipe is critical, the implicit or explicit solver should be used
(available in SewerGEMS or CivilStorm).
[Link] 2025/06/14
Creating Your Model Page 41 of 174
SCADA Elements
Define the SCADA element using the following properties:
Target Element: The domain element that the ASCADA Signal targets.
Real-Time Signal: The signal returning realtime values for the selected attribute.
Historical Signal: The signal returning historical value(s) for the selected attributes.
Target Element (Storage Unit): Displays the storage unit used by the target element.
Field: The attribute of the target element that the SCADA signal relates to.
Headwalls
When you click the headwall element on the Layout toolbar, your mouse cursor changes into a headwall symbol. Clicking in the drawing pane while this tool is active causes a
headwall element to be placed at the location of the mouse cursor.
Headwall Layout
Physical Attributes of Headwalls
Culvert Inlet Coefficient Library
Headwall Connectivity and Function in Model
Headwall Layout
Only a Conduit link can be used to model a Culvert.
A conduit that is declared to be a culvert link may have a Headwall node at either end. The user may model projected or mitered end treatments on a culvert link with a
connection to a cross section or outfall node.
[Link] 2025/06/14
Creating Your Model Page 42 of 174
• Inlet Description: Lets you type or select a description for the inlet. Click the ellipsis button (...) to display the Culvert Inlet Coefficient Engineering Library, where you can
select an existing culvert.
• Chart: The inlet chart that this set of coefficients appears on.
• Nomograph: The culvert nomograph this set of coefficients belongs to.
• Culvert Equation Form: If the conduit is a culvert, define the nomograph form to use in culvert calculations.
• Slope Correction Factor: Lets you define the slope correction factor to be used in inlet control calculations. Normally this factor is -0.5, but for mitered inlets HDS No. 5
suggests +0.7.
• C: Lets you define the C equation coefficient that is used in the submerged inlet control equation.
• M: Lets you define the M equation coefficient that is used in both forms of the unsubmerged inlet control equation.
• K: Lets you define the K equation coefficient that is used in both forms of the unsubmerged inlet control equation.
• Y: Lets you define the Y equation coefficient that is used in the submerged inlet control equation.
• Ke: Lets you define the entrance loss value for the associated conduit.
• Kr: Lets you define the reverse flow loss value for the associated conduit.
In most cases, the user will prefer to select a culvert definition from the default library. The user can pick Browse or Import from library to see the list of existing definitions as
shown below:
[Link] 2025/06/14
Creating Your Model Page 43 of 174
The values for Chart, Nomograph and Forms can be found in HDS-5. When importing a culvert definition from the library, it is best to use the values from the library. The
manipulation of these referenced values is not advised, without justification.
1. Culvert entrance/exit
2. Network outfall
3. Pond Entrance
4. Pond Outlet
5. Open channel cross section to closed channel transition
When a headwall is connected to a conduit it represents the transition from an open channel to a closed channel or vice versa. You can use the headwalls to define inlet/exit
structures for a culvert as well.
To do so:
1. On the headwall set the "Inlet Description" to the appropriate set Culvert Inlet Coefficients.
2. On the connecting Conduit set the "Is Culvert?" flag to true.
3. Then specify whether or not to set the culvert inlet coefficient set for upstream and downstream inlets either based on the adjacent headwall or to simply specify on the
conduit itself.
When a channel link connects to a headwall you can specify the shape of the cross section at the interface of the open channel and the headwall structure.
To do so:
1. In the "Upstream Pond" field pick the "<Select Upstream Pond>" option.
2. Then select the pond that outflows to headwall.
[Link] 2025/06/14
Creating Your Model Page 44 of 174
Property Connections
Property connection elements are used to load sewer models based on data at the level of individual properties. This is useful when a user has loading data provided for
customers/properties based on metering, number of occupants/fixture units, or simply flow per property.
Property connections can be connected to a downstream gravity network using lateral links. Laterals connect to tap elements and most gravity nodes such manholes, transitions,
and catch basins. Property connections cannot be connected to pressure elements. Laterals can only make a single connection to a tap or other hydraulic element.
Property connections are used for loading in the Explicit and GVF Convex solvers, but not the Implicit solver. Property connections support hydrograph inflows, pattern loads, or
directly accept runoff as the outlet of a catchment. For the GVF Rational Solver, flow through a Property Connection must come from a Catchment. (Property Connection
designated as the Outflow Element.)
A Property Connection can be placed manually in a model by selecting Layout, then either Property Connection or Lateral. There cannot be any hydraulic elements on the
upstream side of a Property Connection. (However, a Property Connection can be the Outflow Element for a catchment.)
Elevation of the ground and the lateral invert can be placed in the attributes of the Property Connection element but are not used in the hydraulic calculations. It is not possible
to construct a profile through a lateral link and up to a Property Connection.
Click the New button to add a row to the Time vs. Flow table. Click Delete to remove the currently highlighted row. Click Report to generate a report containing the hydrograph
data.
Other Tools
Bentley SewerGEMS provides several ways to add elements to your model. They include:
1. Click an element symbol on the Layout toolbar. The mouse cursor changes to the element symbol you selected.
2. Click in the drawing pane to add the element to your model.
3. Click again to add another element of the same type to your model.
4. To add a different element, click on the desired element symbol in the Layout toolbar, then click in the drawing pane.
5. To stop adding an element, right-click in the drawing pane to display a shortcut menu, then click Done.
The layout tool lets you quickly add new elements to your model without having to select a new element button on the Layout toolbar. When the layout tool is active, you can
right-click in the drawing pane to select different elements and pipes to add to the model.
1. Click the Layout tool on the Layout toolbar. A shortcut menu appears.
[Link] 2025/06/14
Creating Your Model Page 45 of 174
2. Click the type of pipe you want to use to connect your elements in the model.
3. Right-click in the drawing pane, then select the type of element you want to add from the shortcut menu. The shortcut menu displays only those element types that are
compatible with your pipe selection.
4. Click in the drawing pane to add the element.
5. Click again to add another of the same element type. The elements you add will automatically be connected by the type of pipe you selected earlier.
6. To change the type of pipe, right-click and select a different type from the shortcut menu.
7. To change the element, right-click and select a different element from the shortcut menu.
8. To stop adding elements using the Layout tool, right-click anywhere in the drawing pane and click Done.
Note: In AutoCAD, you must hold down the mouse button to keep the submenu open while selecting an element from the layout toolbar. Alternate layout methods include
using the right-click menu to select elements or using the command line.
1. Click an element symbol on the Layout ribbon. The mouse cursor changes to the element symbol you selected.
2. Click in the drawing pane to add the element to your model.
3. Click again to add another element of the same type to your model.
4. To add a different element, click on the desired element symbol in the Layout ribbon, then click in the drawing pane.
5. To stop adding an element, right-click in the drawing pane to display a shortcut menu, then click Done.
The layout tool lets you quickly add new elements to your model without having to select a new element button on the Layout ribbon. When the layout tool is active, you can
right-click in the drawing pane to select different elements and pipes to add to the model.
1. Click the Layout tool on the Layout ribbon. A shortcut menu appears.
2. Click the type of pipe you want to use to connect your elements in the model.
3. Right-click in the drawing pane, then select the type of element you want to add from the shortcut menu. The shortcut menu displays only those element types that are
compatible with your pipe selection.
4. Click in the drawing pane to add the element.
5. Click again to add another of the same element type. The elements you add will automatically be connected by the type of pipe you selected earlier.
6. To change the type of pipe, right-click and select a different type from the shortcut menu.
7. To change the element, right-click and select a different element from the shortcut menu.
8. To stop adding elements using the Layout tool, right-click anywhere in the drawing pane and click Done.
Note: In AutoCAD, you must hold down the mouse button to keep the submenu open while selecting an element from the layout ribbon. Alternate layout methods include using
the right-click menu to select elements or using the command line.
The software does not account for any additional head loss due to the curvature because in most cases the increased head loss is negligible. If you feel the extra head loss is
significant, it is possible to increase the Manning's n value to account for such losses.
Connecting Elements
When building your model, you must consider these rules of connectivity:The table below and the help topic ”Connectivity Rules for Storm and Sanitary Models’ describe which
elements can be connected to one another. However, there are cases where even if the layout tool allows elements to be connected, they may not be able to be calculated
depending on the solver. Some of those special cases are listed below. At run time or during validation, illegal connections for a set of elements in a solver will show up as User
Notifications.
• A network needs at least one outfall or a pond to end the network. A lone outfall cannot be a "boundary element" type unless it’s draining into a pond.
• Cross section nodes need at least one channel connected to it and a channel needs at least one cross section.
• Gutters cannot be the only link exiting a catch basin, or the catch basin is considered hydraulically disconnected.
• In the GVF-convex solver, a pressure pipe cannot be downstream of a node that is fed from a gravity conduit.
• A pump can only be connected to a pressure pipe in the GVF-convex solver.
[Link] 2025/06/14
Creating Your Model Page 46 of 174
• Air valves and variable speed pump batteries can only be used with the GVF-convex solver.
• Low impact development control elements can only be used with SWMM hydrology and have special rules for connectivity which can be found in
Element Connectivity
Pressure Pipe Layout Mode Conduit Layout Mode Channel Layout Mode Gutter Layout Mode Lateral Layout Mode
Default: Pressure Junction Default: Manhole Default: Cross Section Default: Catch Basin Default: Catch Basin
Pressure Junction Catch Basin Cross Section Catch Basin Catch Basin
Pump Manhole Catch Basin Cross Section Tap
Variable Speed Pump Battery Junction Chamber Manhole Outfall Manhole
Air Valve Cross Section Junction Chamber Transition
Wet Well Pond Outlet Entrance Pond Outlet Entrance Cross Section
Manhole Pump (Only recommended for SewerCAD) Wet Well Headwall
[Link] 2025/06/14
Creating Your Model Page 47 of 174
Pressure Pipe Layout Mode Conduit Layout Mode Channel Layout Mode Gutter Layout Mode Lateral Layout Mode
Junction Chamber Wet Well Outfall
Outfall Outfall
Note: If you do not want to split a conduit with an access hole type node (i.e. Manhole), then use a tap node instead. Placing a tap node on a conduit does not split the pipe into
two separate hydraulic links.
If you attempt to split a link with an invalid element type you may receive a prompt (similar to the one pictured below) if the split is going to result in invalid connectivity.
Answer "Yes" if you would like to continue with the split. You can correct the connectivity at a later time by selecting Analysis > Validate.
Answer "Yes" if you would like to continue with the morph. You can correct the connectivity at a later time by selecting Analysis > Validate.
Link Morphing
You can morph a conduit into a pressure pipe and vice versa. Any applicable data associated with the link will be carried over to the new link after the morph.
When the node to be morphed is connected to a link you may receive a prompt (similar to the one pictured below) if the morph is going to result in invalid connectivity.
To morph a conduit into a pressure pipe, right-click it and select the Morph Conduit to Pressure Pipe command.
[Link] 2025/06/14
Creating Your Model Page 48 of 174
• Conduits
• Pressure Pipes
• Channels
• Gutters
• Laterals
Not all node elements can be connected to all link types. For example, a pump cannot be expected to take suction from a gutter.
In the layout tool, in order to protect the user from building model that can't solve, the user is limited in the elements that can be selected as the next node type. The
downstream nodes that are allowed for each link type are listed below:
Conduit
• Catch Basin
• Manhole
• Transition
• Cross Section
• Pond Outlet Entrance
• Pump
• Wet well
• Outfall
• Headwall
Pressure Pipe
• Pressure Junction
• Pump
• Variable Speed Pump Battery
• Air Valve
• Wet well
• Catch Basin
• Manhole
• Transition
• Outfall
Channel
• Cross Section
• Catch Basin
• Manhole
• Pond Outlet Entrance
• Wet well
• Outfall
• Headwall
Gutter
• Catch Basin
• Cross Section
• Outfall
Lateral
• Catch Basin
• Tap
• Manhole
• Transition
• Cross Section
In addition, even if the model allows a user to connect elements, their behavior may depend on the active solver. For example, while a pump can be hooked to a conduit, it will
work in the implicit and explicit solvers but not in the GVF solvers which expect the pump to be connected to a Pressure Pipe. For another example, Air Valve and Variable Speed
Pump Battery elements were created for Pressure Pipes in the GVF-convex solvers and require some considerations when used with the other solvers.
Polygon elements like catchments and pond outlets must be connected in special ways. Inflows to a pond are modeled as outfalls where the Boundary Condition Type for the
outfall is a Boundary Element and the boundary element is the pond. Outflow from a pond is modeled as a Pond Outlet Structure. Ponds cannot be connected to one another
pond.
Unlike ponds, catchments can be connected in series by making one catchment the Outflow element of an upstream catchment. Catchments can also have LID (low impact
development) elements within them. The LID would then have the catchment as its Parent Catchment.
Outfall elements cannot be connected downstream to links but must either be the terminal node or associated with a pond. When using the explicit solver, only one conduit can
be connected to an outfall. An outfall cannot be connected to other elements through a gutter.
Pumps can only have one link on the suction side and one on the discharge side. In the GVF-rational solver, there can only be a single pump element representing a station, with
no pumps in parallel or in loops.
A conduit can refer to any prismatic channel or pipe that conveys flow. The cross section of a conduit must remain constant from one end to the next.
[Link] 2025/06/14
Creating Your Model Page 49 of 174
A channel refers to a channel that changes geometry from the upstream cross section to the downstream cross section. Channels can be used to model natural streams or
swales which are not prismatic in cross section. Channels must have a cross section element at either end and properties are interpolated along the channel.
A uniform trapezoidal channel can either be modeled as a conduit with the shape defined in a conduit element or a channel with the shape defined as a property of the cross
section elements at each end.
A lateral link can be used to model a surface (channel) or piped (conduit) tributary flow into the hydraulic network. The point at which this flow is injected into the network is
modelled with location of a tap node. User should select a lateral instead of small diameter conduit when it is not important to compute full hydraulic results along the tributary
link. User may option to use a lateral link and tap node to model this injected flow when the connection point is not an access hole with junction losses, or user does not wish to
split the carrier pipe into two distinct hydraulic links.
Related Topics
• Connecting Elements
Virtual Links
A user can specify that a user defined conduit or pressure pipe has a section type of "Virtual" by setting the section type to "Virtual" in the property grid for conduits or the "Is
virtual" property to "True" in the property grid for pressure pipes. The behavior of a virtual link depends on the active solver and whether the link is a conduit or pressure pipe.
Gutters and channels cannot be virtual.
Virtual links pass the flow from the upstream node to the downstream nodes but do not always calculate hydraulic properties such as velocity and head loss. Virtual links usually
have length but this is only to assist in plotting the link in a profile drawing. Depending on the solver, the rise of the virtual link may not be shown in the profile. In some solvers
(e.g. GVF-convex), the "Is virtual = True" setting is ignored and hydraulic properties are calculated. The behavior of different virtual links is summarized in the table below.
Virtual links enable the same model file to be used with different solvers even though the solvers have very different ways of representing different physical facilities. The
explicit solver internally represents pumps as links with essentially no length while the GVF solver represents pumps as points which must be connected to non-virtual pipes at
each end. To make these two solvers compatible, in a model (e.g. SewerGEMS, SewerCAD, CivilStorm or StormCAD) which represents pumps as points, virtual links must be
inserted on the suction and discharge side of pump nodes. These virtual pipes and the pump node are combined into a single effective link when the model is run in the explicit
solver and the results are later applied to model elements.
Similarly, control structures (e.g. weirs, orifices) are represented as links in the explicit solvers but are properties of links in the implicit and GVF solvers. The control structures
need to be associated with virtual links to work with the explicit solver.
For details on using virtual links as conduits or pressure pipes, see help topics ”Virtual Conduits’ and ”Virtual Pressure Pipes’
1. If the Property Editor is not open, click View > Properties (F4) to open it.
2. Click the catchment for which you want to set an outflow node.
3. In the Catchment section of the Property Editor, click the Outflow Node field to enable the selection drop-down.
4. Click Select if you want to select the outflow node from the model, or select the outflow node from the drop-down list.
For information on how to direct flow from a catchment to a LID control, see ”LID Control and Parent Catchment Network Representation’.
1. Set Has Start Control Structure? or Has Stop Control Structure? to True in the Physical:Has Control Structure section of the Property Editor for the conduit.
2. Click the Ellipse (...) button that appears next to the Start Control Structure or Stop Control Structure field. This opens the Conduit Control Structure dialog box.
3. Select New > Weir.
[Link] 2025/06/14
Creating Your Model Page 50 of 174
Weirs can be placed in any shape of conduit but the weir structure itself is treated as being in a rectangular section. The weir length is the distance across this section measured
perpendicular to the flow (for all except side weirs).
Manipulating Elements
You can manipulate elements in your model in any one of the following ways:
• Select elements--manually select individual elements, manually select multiple elements, select all elements, or select all elements of a single element type
• Move elements
• Delete elements
• Split pipes
Note: You can change the selection color in the Options dialog box, which is accessible by selecting Home > Tools > Options.
Click the first element, then click additional elements while holding down Shift or Ctrl.
To select all of the elements in your model, select Home > Select > Select All.
To select all elements of the same type (for example, all junction chambers), select Home > Select > Select by Element, then click the desired element type.
All elements of the selected type appear in red, including connecting pipes.
Click the Select tool then click any blank space in the drawing pane.
or
or
To delete an element:
or
Splitting Pipes
Disconnecting and Reconnecting Pipes
How Do I Model a Split in a Channel?
Merge Nodes in Close Proximity
Batch Pipe Split Dialog Box
Batch Morph
Assign Taps to Links Dialog Box
Branch Labeling
[Link] 2025/06/14
Creating Your Model Page 51 of 174
Splitting Pipes
You may encounter a situation in which you need to add a new element in the middle of an existing pipe.
If you accidentally split a pipe, this action can be undone by selecting Undo.
To do this in the Stand-Alone version, drag the element into position along the pipe to be split, then right-click the node and select Split <Pipe Label> from the shortcut menu
(where <Pipe Label> is the name of the pipe to be split).
To do this in the MicroStation version, drag the element into position along the pipe to be split. Hold down the Shift key, then right-click the node and select Split <Pipe Label>
from the shortcut menu (where <Pipe Label> is the name of the pipe to be split).
Note: When links that are a part of an existing profile are reconnected such that the previously created profile does not remain continuous, the profile may no longer show
correct results. If you reconnect links that are part of an existing profile, edit and redefine a valid path to ensure correct results.
If you reconnect the start end of a link to an invalid element type you get the following message:
If you reconnect the stop end of a link to an invalid element type you get the following message:
Answer "Yes" if you would like to continue with the reconnect. You can correct the connectivity at a later time by selecting Home > Validate.
[Link] 2025/06/14
Creating Your Model Page 52 of 174
To access the dialog, right-click one of the nodes to be merged and select the Merge nodes in close proximity command.
Node to keep: Displays the node that will be retained after the merge operation.
Tolerance: Allows you to define the tolerance for the merge operation. Nodes that fall within this distance from the "Node to keep" will be available in the "Nodes to merge"
pane.
Refresh: Refreshes the nodes displayed in the "Nodes to merge" pane. Click this button after making a change to the tolerance value to update the list of nodes available for the
merge operation.
Select nodes to merge: Toggle this button on to select the nodes that are selected in the "Nodes to merge" pane in the drawing pane.
Nodes to merge: This pane lists the nodes that fall within the specified tolerance of the "Node to keep". Nodes whose associated boxes are checked will be merged with the
Node to keep when the Merge operation is initiated.
Merge: Performs the merge operation using the nodes whose boxes are checked in the "Nodes to merge" list.
Choose Allows you to specify which pipes to include in the split operation. The following options are available: All : All pipes in the model that have a
Features to neighboring node within the specified tolerance will be split by that junction. Selection : Only the pipes that are currently selected in the drawing
Process pane will be split by a neighboring junction that lies within the specified tolerance. Selection Set : Only those pipes that are contained within the
selection set specified in the drop down list will be split by a neighboring junction that lies within the specified tolerance.
Allow splitting When this box is checked, nodes that are marked Inactive will not be ignored during the split operation.
with inactive
nodes
Tolerance This value is used to determine how close a pipe must be to a node in order for the pipe to be split by that junction.
Pipes will be split by every junction that falls within the specified tolerance. To prevent unwanted pipe splits, first use the Network Navigator’s "Network Review > Pipe Split
Candidates" query to verify that the tolerance you intend to use for the Batch Split operation will not include nodes that you do not want involved in the pipe split operation.
[Link] 2025/06/14
Creating Your Model Page 53 of 174
4. In the Network Navigator, highlight nodes in the list that you do not want to be included in the pipe split operation and click the Remove button.
5. Open the Batch Pipe Split dialog.
6. Click the Selection button.
7. Type the tolerance you used in the Network Review query and click OK.
Note: Cleaning up your model is something that needs to be done with great care. It is best performed by someone who has good familiarity with the model, and/or access to
additional maps/personnel/information that will allow you to make the model match the real world system as accurately as possible.
We provide a number of Network Navigator queries that will help you find "potential" problems (see Using the Network Navigator.
1. Review and clean up your model as much as possible prior to running the "batch split" operation. Run the "duplicate pipes" and "nodes in close proximity" queries first.
(Click View > Queries. In the Queries dialog expand the Queries-Predefined tree. The Duplicate Pipes and Nodes in Close Proximity queries are found under the Network
Review folder.)
2. Next, use the network navigator tool to review "pipe split candidates" prior to running batch split.
3. Using the network navigator tool, run the "pipe split candidates" query to get the list of potential batch split candidate nodes. Take care to choose an appropriate
tolerance (feel free to run the query multiple times to settle on a tolerance that works best; jot down the tolerance that you settle on, you will want to use that same
tolerance value later when you perform the batch split operation.
4. Manually navigate to and review each candidate node and use the "network navigator" remove tool to remove any nodes that you do not want to process from the list.
5. After reviewing the entire list, use the network navigator "select in drawing" tool to select the elements you would like to process.
6. Run the batch split tool. Choose the "Selection" radio button to only process the nodes that are selected in the drawing. Specify the desired tolerance, and press OK to
proceed.
Batch Morph
This tool allows you to morph a selected node type into another type of node element as a batch operation.
• All: All nodes in the model will be morphed to the specified Target Element Type.
• Selection: Only the nodes that are currently selected in the drawing pane will be morphed to the specified Target Element Type.
• Selection Set: Only those nodes that are contained within the selection set specified in the drop down list will be morphed to the specified Target Element Type.
Check the Allow Morphing of Inactive Nodes? box to include nodes set as Inactive in the batch operation.
Finally, select the Target Element Type that the selected nodes will be morphed into.
Note: Users can morph junction elements into Isolation Valves using two steps: First, morph the desired junctions into TCV's, GPV's, or PBV's. Then use the Skelebrator "Inline
Isolation Valve Replacement" operation.
[Link] 2025/06/14
Creating Your Model Page 54 of 174
Choose Features to Process Allows you to specify which taps to include in the assignment operation. The following options are available:
All : All taps in the model will be assigned to the link closest to them.
Selection: Only the taps that are currently selected in the drawing pane will be assigned to a link.
Selection Set: Only those taps that are contained within the selection set specified in the drop down list will be assigned to
a link.
Also process taps that already have an When this box is checked, a tap that has already been assigned a link will still be eligible for assignment to a link that is
associated link closer than the one already assigned, if one exists.
Allow assignment to inactive links When this box is checked taps can be assigned to links that are inactive.
You can use Network Navigator to find taps that are not assigned to a link using the Network Review > Taps Without Reference Link query.
Note: In case a tap is equally distant to multiple links, it will be associated to the shortest link (2D length from graphics).
Branch Labeling
The purpose of branch labeling is to set the labels of conduits (or pressure pipes) using the indexes of the branches that the conduits are in and using the indexes of conduits in
the branches. The branches used for setting conduit labels are found by searching the longest path from an outfall node or a node in a branch. The following is an example of
setting conduit labels using the UK convention:
There are two parts in conduit label: the first part is the branch number and the second part is the conduit number in a branch.
Network Parsing
Network parsing finds branches in the storm/sewer network for the purpose of setting conduit (and pressure pipe) labels. For branch labeling, we always find the longest branch
from an outfall node or from a node in a found branch. This is different from DW engine calculation network parsing, in which we find branches based on the size of the conduits
and bending angle between conduits.
The following are the steps the software uses for finding branches from an outfall node for branch labeling:
[Link] 2025/06/14
Creating Your Model Page 55 of 174
1. Find loops in the network. From an outfall node, run a depth first search to find a tree and non-tree edges. From non-tree edge, find loops by connecting no-tree edge
with tree branches. In the loop, the link with the highest invert is set as a loop branch. If multiple links have the same highest invert, the smaller pipe with the highest
invert is set as a loop.
2. From the leaves of all tree branches, search to the root outfall node. Set the upstream path length for each node. If there are multiple upstream paths to a node, use the
longest path length as the upstream path length for the node.
3. Disconnect the loop branch from the upstream node and make the loop is the same as a tree branch. Calculate the upstream path length for each node in the loop
branch.
4. Run a depth first search from the outfall node by searching the link with the longest upstream calculated from link length and the upstream path length of the upstream
node.
5. Create branches from the tree searched from depth first search.
• Branch Numbering
◦ Start: The Start value is the start number of branches in the first part of the conduit label. The default value is 1.
◦ Increment: The Increment is the increment of the branch number part in conduit label. The default value is 1.
• Pipe Numbering
◦ Start: The Start value is the start number of a pipe in a branch in the second part of conduit label. The default value is 0.
◦ Increment: The Increment is the increment of the pipe number part in conduit label. The default value is 1.
◦ Number of Digits: The Number of Digits value is the number of decimal places displayed for a conduit number in a branch. The default value is 3, which causes the
pipe label to look like "1.001", "1.002" or "1.022".
• Separator: The Separators string is the string between the branch number part and pipe number part in conduit label. The default value is "."
• Preview: The Preview field displays a read-only example of a label that will be generated using the current settings.
Running branch labeling on a model will generate the following conduit label results (using the default settings):
When there are loops in a storm/sewer network, the software finds those loop branches. Then, it breaks the loop branch from its upstream node and treats the loop branch as a
regular branch. The numbering of the loop branch follows the branch that the loop branch downstream node is in. For example, the numbering of loop branch 5.000 to 5.001 in
the example above is numbered after branch 4.000 to 4.001.
[Link] 2025/06/14
Creating Your Model Page 56 of 174
Double-click the element in the drawing pane. The Property Editor displays the attributes of the selected element.
or
Select the element whose properties you want to edit, then select Layout > Properties or click the Properties button on the Analysis Ribbon tab.
Property Editor
What Length is Used for Conduits, Channels, and Gutters When I Don't Enter a User-defined Length?
What is the Difference Between a User Defined Unit Hydrograph and a Hydrograph Entered in the Inflow Collection Editor?
Property Editor
The Property Editor is a contextual dialog box that changes depending on the status of other dialog boxes. For example, when a network element is highlighted in the drawing
pane, the Property Editor displays the attributes and values associated with that element. When one of the manager dialog boxes is active, the Property Editor displays the
properties pertaining to the currently highlighted manager element.
Attributes displayed in the Property Editor are grouped into categories by default. An expanded category can be collapsed by clicking the plus (+) button next to the category
heading. A collapsed category can be expanded by clicking the minus (-) button next to the category heading.
Note: The available fields will also change depending on the currently active solver. The currently active solver is determined by the Active Numerical Solver Calculation Option.
When editing data in the property grid you can also double-click the label to change the value. This applies to Boolean fields (those that show true/false values); reference fields
(i.e. zone); and enumerated fields (i.e. Status (Initial). When you double-click any of these field types it will "cycle" through the available values in the drop-down list. Commands
like "Edit" for reference fields are excluded during the cycling.
You can change the sorting to alphabetical by clicking the Search button and selecting "Arrange Alphabetically".
For the most efficient data entry in Text Box style fields, instead of clicking on the Field, click on the label to the left of the field you want to edit, and start typing. Press Enter to
commit the value, then use the Up/Down keyboard arrows to navigate to the next field you want to edit. You can then edit the field data without clicking the label first; when
you are finished editing the field data, press the Enter key, and proceed to the next field using the arrow keys, and so on.
Find Element
The top section of the Property Editor contains the Find Element tool. The Find Element tool lets you:
• Quickly find a recently-created or added element in your model. The Element menu contains a list of the most recently-created and added elements. Click an element in
the Element menu to center the drawing pane around that element and highlight it.
• Find an element in your model by typing the element label or ID in the Element menu then clicking the Find button or pressing Enter. The drawing pane centers around
the highlighted element.
• Find all elements of a certain type by using a percent sign (%) as a wild-card character. For example, if you want to find all of the pumps in your model, you type pmp%
(this is not case-sensitive) then click the Find button. The drawing pane centers around and highlights the first instance of a pump in your model, and lists all pumps in
your model in the Element menu. Once the Element menu is populated with a list of elements, you can use the Find Next and Find Previous buttons to quickly navigate to
the next or previous element in the list.
Note: See the Using the Like Operator topic for more information about wildcard symbols.
Element Type an element label or ID in this field then click the Find button to quickly locate it in your model. The element selected in this menu will be
centered in the drawing pane when the Zoom To command is initiated, at the magnification level specified by the Zoom Level menu. The drop-
down menu lists recently-created or added elements, elements that are part of a selection set, and that are part of the results from a recent Find
operation.
Find This button allows you to find the previous element in the list of results from a recent Find operation.
Previous
Find Zooms the drawing pane view to the element typed or selected in the Element menu at the magnification level specified in the Zoom Level
menu.
Find Next This button allows you to find the next element in the list of results from a recent Find operation.
Zoom Level Allows you to specify the magnification level at which elements are displayed in the drawing pane when the Zoom To command is initiated.
Alphabetic Displays the attribute fields in the Property Editor in alphabetical order.
Categorized Displays the attribute fields in the Property Editor in categories. This is the default.
Related Topics
Property Search
You can search for a specific attribute by typing the name of the attribute into the search box and clicking the Search button
When you have entered one or more search terms, only those properties containing the search term will be displayed in the property editor.
When the box contains search terms the Search button turns to a Clear button
. Click this button to clear the terms from the search box.
To match multiple items, enter the desired list of terms separated by semicolon without spaces in between.
[Link] 2025/06/14
Creating Your Model Page 57 of 174
A maximum of 12 search terms are stored in the search box. Click the down arrow to view the last 12 search terms that were used; clicking an entry in this list will make that
search term active.
Relabeling Elements
Set Field Options Dialog Box
Relabeling Elements
You can relabel elements from within the Property Editor.
To relabel an element:
1. Select the element in the Drawing Pane then, if the Property Editor is not already displayed, select Layout > Properties.
2. In the General section of the Property Editor, click in the Label field, then type a new label for the element.
To use the Set Field Options dialog box, right-click any numerical field that has units, then select Units and Formatting.
What Length is Used for Conduits, Channels, and Gutters When I Don't Enter a User-defined Length?
If you do not enter a user-defined length in the attributes for conduits, channels, and gutters, the length used in Bentley SewerGEMS is the plan view distance between the
coordinates at each end of the link element. This length is used as the actual length in hydraulic calculations. However, as the slope increases, the difference between the plan
length and the actual length also increases as shown below.
The table below shows the difference between the actual and plan length as a function of slope. Note that for most reasonable slopes, the difference between the actual and
plan view length is less than one percent. (100% slope is 1:1 slope.) As the slope approaches vertical, you must enter the actual length.
0 1.000
10 1.005
20 1.020
[Link] 2025/06/14
Creating Your Model Page 58 of 174
* The model’s generalized friction formulation is only valid for slopes less than 10%.
If you are not satisfied with the plan view length, you can enter a user-defined length, which you can determine using the following equation:
What is the Difference Between a User Defined Unit Hydrograph and a Hydrograph Entered in the Inflow
Collection Editor?
You can enter a hydrograph (in flow units) at any node element (e.g. catch basin, manhole, catchment, cross section, wet well). You can also enter a unit hydrograph, but only at
a catchment node.
To enter a hydrograph (in flow units) using the Inflow Collection Editor:
Panning
Zooming
Panning
You can change the position of your model in the drawing pane by using the Pan tool.
or
If your mouse is equipped with a mousewheel, you can pan by simply holding down the mousewheel and moving the mouse to reposition the current view.
or
Select View > Pan, then click anywhere in the drawing, hold down the mouse button and move the mouse to reposition the current view
Zooming
You can enlarge or reduce your model in the drawing pane using one of the following zoom tools:
The simple Zoom In and Zoom Out commands allow you to increase or decrease, respectively, the zoom level of the current view by one step per mouse click.
To use Zoom In or Zoom Out, click the desired button on the Tools toolbar, or select View > Zoom In or View > Zoom Out.
If your mouse is equipped with a mousewheel, you zoom in or out by simply moving the mousewheel up or down respectively.
[Link] 2025/06/14
Creating Your Model Page 59 of 174
Zoom Window
The Zoom Window command lets you zoom in on an area of your model defined by a window that you draw in the drawing pane.
To use Zoom Window, select View > Zoom Window button, then click and drag the mouse inside the drawing pane to draw a rectangle. The area of your model inside the
rectangle will appear enlarged.
Zoom Extents
The Zoom Extents command automatically sets the zoom level such that the entire model is displayed in the drawing pane.
To use Zoom Extents, click View > Zoom Extents. The entire model is displayed in the drawing pane.
Zoom Realtime
The Zoom Realtime command lets you dynamically scale up and down the zoom level. The zoom level is defined by the magnitude of mouse movement while the tool is active.
Zoom Previous returns the zoom level to the most recent previous setting. To use Zoom Previous click View > Zoom Previous.
Zoom Next returns the zoom level to the setting that was active before a Zoom Previous command was executed. To use Zoom Next, click View > Zoom Next.
1. Select View > Zoom Center. The Zoom Center dialog box appears.
2. Enter the X and Y coordinates.
3. Select the zoom factor from the Zoom drop-down, then click OK.
X: Defines the X coordinate of the point at which the model will be centered.
Y: Defines the Y coordinate of the point at which the model will be centered.
Zoom Factor: Defines the zoom level that will be applied when the zoom center command is initiated. Available zoom levels are listed in percentages of 25, 50, 75, 100, 125, 150,
200 and 400
Bentley SewerGEMS CONNECT contains powerful features that let you view or analyze subsets of your entire model. You can find these elements using the Network Navigator
(see Using the Network Navigator ). The Network Navigator lets you choose a selection set, then view the list of elements in the selection set or find individual elements from
the selection set in the drawing.
In order to use the Network Navigator, you must first create a selection set. There are two ways to create a selection set:
• From a selection of elements--You create a new selection set in the Selection Sets Manager, then use your mouse to select the desired elements in the drawing pane.
• From a query--Create a query in the Queries Manager, then use the named query to find elements in your model and place them in the selection set.
[Link] 2025/06/14
Creating Your Model Page 60 of 174
You can sort the selection set manager by clicking the Label column header. The initial click will sort in ascending order. A subsequent click will sort in ascending order.
New Contains the following commands: Create from Selection —Creates a new static selection set from elements you select in your model. Create from
Query —Creates a new dynamic selection set from existing queries.
Delete Deletes the selection set that is currently highlighted in the list pane. This command is also available from the short-cut menu, which you can
access by right-clicking an item in the list pane.
Edit When a selection-based selection set is highlighted when you click this button, opens the Selection Set Element Removal dialog box, which lets you
edit the selection set. This command is also available from the short-cut menu, which you can access by right-clicking an item in the list pane.
When a query-based selection set is highlighted when you click this button, opens the Selection By Query dialog box, which lets you add or remove
queries from the selection set. This command is also available from the short-cut menu, which you can access by right-clicking an item in the list
pane.
Rename Lets you rename the selection set that is currently highlighted in the list pane. This command is also available from the short-cut menu, which you
can access by right-clicking an item in the list pane.
Select In Lets you quickly select all the elements in the drawing pane that are part of the currently highlighted selection set. Once you have selected the
Drawing elements in a selection set using Select In Drawing, you can delete them all at once or create a report on them. This command is also available
from the short-cut menu, which you can access by right-clicking an item in the list pane.
Help Displays online help for the Selection Sets Manager.
You can view the properties of a selection in the Property Editor by right-clicking the selection set in the list pane and selecting Properties from the shortcut menu.
You use the Network Navigator to view the elements that make up a selection set.
1. Open the Network Navigator by selecting Analysis > Analysis Views > Network Navigator.
2. Select a selection set from the Selection Set drop-down list. The elements in the selection set appear in the Network Navigator.
Note: You can double-click an element in the Network Navigator to select and center it in the Drawing Pane.
[Link] 2025/06/14
Creating Your Model Page 61 of 174
1. Select all of the elements you want in the selection set by either drawing a selection box around them or by holding down the Ctrl key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Create Selection Set.
3. Type the name of the selection set you want to create, then click OK to create the new selection set. Click Cancel to close the dialog box without creating the selection set.
4. Alternatively, you can open the Selection Set manager and click the New button and select Create from Selection. The software prompts you to select one or more
elements.
This dialog box opens when you create a new selection set. It contains the following field:
New Selection Set Name: Type the name of the new selection set.
You create a dynamic selection set by creating a query-based selection set. A query-based selection set can contain one or more queries, which are valid SQL expressions.
1. In the Selection Sets Manager, click the New button and select Create from Query. The Selection by Query dialog box opens.
2. Available queries appear in the list pane on the left; queries selected to be part of the selection set appear in the list pane on the right. Use the arrow buttons in the
middle of the dialog to add one or all queries from the Available Queries list to the Selected Queries list, or to remove queries from the Selected list. You can also double-
click queries on either side of the dialog box to add them to or remove them from the selection set.
1. Right-click the element to be added, then select Add to Selection Set from the shortcut menu.
2. In the Add to Selection Set dialog box, select the selection set to which you want to add the element.
3. Click OK to close the dialog box and add the element to the selected selection set. Click Cancel to close the dialog box without creating the selection set.
1. Select all of the elements to be added by either drawing a selection box around them, or by holding down the Ctrl key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Add to Selection Set.
3. In the Add to Selection Set dialog box, select the selection set to which you want to add the element.
4. Click OK to close the dialog box and add the element to the selected selection set. Click Cancel to close the dialog box without creating the selection set.
This dialog box opens when you select the Add to Selection Set command. It contains the following field:
Add To: Selects the selection set to which the currently highlighted element or elements will be added.
You can easily remove elements from a static selection set in the Selection Set Element Removal dialog box.
1. Display the Selection Sets Manager by selecting Home > Selection Sets or clicking the Selection Sets button on the View toolbar.
2. In the Selection Sets Manager, select the desired selection set then click the Edit button.
3. In the Selection Set Element Removal dialog box, find the element you want to remove in the table. Select the element label or the entire table row, then click the Delete
button.
4. Click OK.
This dialog opens when you click the edit button from the Selection Sets manager. It is used to remove elements from the selection set that is highlighted in the Selection Sets
Manager when the Edit button is clicked.
1. Open the Network Navigator by selecting View > Network Navigator or clicking the Network Navigator button on the View toolbar.
2. Select a selection set from the Selection Set drop-down list. The elements in the selection set appear in the Network Navigator.
3. You can double-click an element in the Network Navigator to select and center it in the Drawing Pane.
1. Select all of the elements you want in the selection set by either drawing a selection box around them or by holding down the Ctrl key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Create Selection Set.
3. Type the name of the selection set you want to create, then click OK to create the new selection set. Click Cancel to close the dialog box without creating the selection set.
4. Alternatively, you can open the Selection Set Manager and click the New button and select Create from Selection. Bentley SewerGEMS CONNECT prompts you to select
one or more elements.
[Link] 2025/06/14
Creating Your Model Page 62 of 174
This dialog box appears when you create a new selection set. It contains the following field:
New Selection Set Name: Lets you type the name of the new selection set.
1. In the Selection Sets Manager, click the New button and select Create from Query. The Selection by Query dialog box appears.
2. Available queries appear in the list pane on the left; queries selected to be part of the selection set appear in the list pane on the right. Use the arrow buttons in the
middle of the dialog to add one or all queries from the Available Queries list to the Selected Queries list, or to remove queries from the Selected list.
3. You can also double-click queries on either side of the dialog box to add them to or remove them from the selection set.
The Selection by Query dialog box lets you create selection sets from available queries. The dialog box contains the following controls:
Available Queries Contains all the queries that are available for your selection set. The Available Columns list is located on the left side of the dialog box.
Selected Queries Contains queries that are part of the selection set. To add queries to the Selected Queries list, select one or more queries in the Available
Queries list, then click the Add button [>].
Query Lets you select or clear queries to be used in the selection set: [ > ] Adds the selected items from the Available Queries list to the Selected
Manipulation Queries list. [ >> ] Adds all of the items in the Available Queries list to the Selected Queries list. [ < ] Removes the selected items from the
Buttons Selected Queries list. [ << ] Removes all items from the Selected Queries list.
Note: You can select multiple queries in the Available Queries list by holding down the Shift key or the Control key while clicking with the mouse.
Holding down the Shift key provides group selection behavior. Holding down the Control key provides single element selection behavior.
1. Right-click the element to be added, then select Add to Selection Set from the shortcut menu.
2. In the Add to Selection Set dialog box, select the selection set to which you want to add the element.
3. Click OK to close the dialog box and add the element to the selected selection set. Click Cancel to close the dialog box without creating the selection set.
1. Select all of the elements to be added by either drawing a selection box around them, or by holding down the Ctrl key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Add to Selection Set.
3. In the Add to Selection Set dialog box, select the selection set to which you want to add the element.
4. Click OK to close the dialog box and add the element to the selected selection set. Click Cancel to close the dialog box without creating the selection set.
This dialog box appears when you select the Add to Selection Set command. It contains the following field:
Add To: Drop-down menu that lets you select the selection set to which the currently highlighted element or elements will be added.
1. Display the Selection Sets Manager by selecting View > Selection Sets or clicking the Selection Sets button on the View toolbar.
2. In the Selection Sets Manager, select the desired selection set then click the Edit button.
3. In the Selection Set Element Removal dialog box, find the element you want to remove in the table. Select the element label or the entire table row, then click the Delete
button.
4. Click OK.
This dialog appears when you click the edit button from the Selection Set Manager. It allows you to remove elements from the selection set that is highlighted in the Selection
Sets Manager when the Edit button is clicked.
[Link] 2025/06/14
Creating Your Model Page 63 of 174
Note: While it is not possible to directly edit groups of elements in a selection set, you can use the Next button in the Network Navigator to quickly navigate through each
element in the selection set and edit its properties in the Property Editor.
1. Open the Selection Sets Manager by selecting View > Selection Sets or clicking the Selection Sets button on the View toolbar.
2. In the Selection Sets Manager, highlight the selection set that contains elements you want to delete.
3. Click the Select In Drawing button in the Selection Sets Manager to highlight all of the selection set's elements in the drawing pane. If there is only one selection set listed
in the Selection Set Manager, you don't have to highlight it before clicking the Select In Drawing button.
4. Shift-click (hold down the Shift key and click the left mouse button) any selected elements that you do not want to delete.
5. Right-click and select Delete. The highlighted elements in the selection set are deleted from your model.
Query Selection List Choose the element sets to use in the query. Once a query is selected, it can be executed when you
click the > icon. If there is already a Query listed in the list box, it can be run when the Execute
icon is clicked.
Click to run the selected query.
Execute
Zooms the drawing pane view to the element prior to the currently selected one in the list.
Previous
Zooms the drawing pane view to the selected element in the list.
Zoom To
Zooms the drawing pane view to the element below the currently selected element in the list.
Next
Copies the elements to the Windows clipboard.
Copy
Removes the selected element from the list.
Remove
Selects the elements in the drawing pane and performs a zoom extent based on the selection.
Select In Drawing
When this toggle button is on, elements returned by a query will be highlighted in the drawing pane to
Highlight increase their visibility.
Predefined Queries
[Link] 2025/06/14
Creating Your Model Page 64 of 174
The Network Navigator provides access to a number of predefined queries grouped categorically, accessed by clicking the [>] button. Categories and the queries contained
therein include:
Element types - finds all elements of a specified type (e.g. all manholes).
Network review - finds potential problems in the model (e.g. finding disconnected elements). This is a very powerful tool for model cleanup.
Input - finds elements in model with specified properties (e.g. find elliptical conduits)
Results - finds elements in model with results that meet the query criteria (e.g. manholes that are flooded in this time step).
Note: The criteria to meet the Near Horizontally Sloped results query is that the slope is:
In addition to predefined queries, you can create your own queries in the Queries Manager. These queries can be saved with the model or in a shared file.
1. In the Network Navigator, click the Query Selection List button and select Network Trace > Upstream.
2. In the Query Parameters dialog, click the Downstream Node field and choose Select.
3. In the drawing pane, click the downstream element. The trace query will find all elements that are upstream of the element chosen here.
4. Click OK.
1. In the Network Navigator, click the Query Selection List button and select Network Trace > Downstream.
2. In the Query Parameters dialog, click the Upstream Node field and choose Select.
3. In the drawing pane, click the upstream element. The trace query will find all elements that are downstream of the element chosen here.
4. Click OK.
Using Prototypes
Prototypes allow you to enter default values for elements in your network. These values are used while laying out the network. Prototypes can reduce data entry requirements
dramatically if a group of network elements share common data.
Note: Changes to the prototypes are not retroactive and will not affect any elements created prior to the change.
If a section of your system has distinctly different characteristics than the rest of the system, adjust your prototypes before laying out that section. This will save time when you
edit the properties later.
Creating Prototypes
Creating Prototypes
Prototypes contain default values for Bentley SewerGEMS elements. You create prototypes in the Prototypes Manager.
To create a prototype:
Prototypes Manager
The Prototypes Manager allows you to create prototypes, which contain default common data for each element type. The Prototypes Manager consists of a toolbar and a list
pane, which displays all of the available elements.
[Link] 2025/06/14
Creating Your Model Page 65 of 174
Note that element types that are not used in the current model are marked with an icon.
The list of elements in the Prototypes Manager list pane is expandable and collapsible. Click on the Plus sign to expand an element and see its associated prototypes. Click on the
Minus sign to collapse the element.
Each element in the list pane contains a default prototype; you cannot edit this default prototype. The default prototypes contains common values for each element type; if you
add elements to your model without creating new prototypes, the data values in the default prototypes appear in the Property Editor for that element type.
Delete: Deletes the prototype that is currently highlighted in the list pane.
Rename: Lets you rename the prototype that is currently highlighted in the list pane.
Make Current: Lets you make the prototype that is currently highlighted in the list pane the default for that element type. When you make the current prototype the default,
every element of that type that you add to your model in the current model will contain the same common data as the prototype.
Report: Lets you view a report of the data associated with the prototype that is currently highlighted in the list pane.
Engineering Libraries
Engineering Libraries are powerful and flexible tools that you use to manage specifications of common materials, objects, or components that are shared across hydraulic
models. Some examples of objects that are specified through engineering libraries include pipe materials, Storm Data, and unit sanitary loads. You can modify engineering
libraries and the items they contain by using the Engineering Libraries command in the Components menu, or by clicking the ellipsis (...) buttons available next to the fields in
dialog boxes that make use of engineering libraries.
Note: The data for each engineering library is stored in an XML file in your Bentley SewerGEMS CONNECT program directory. We strongly recommend that you edit these files
only using the built-in tools available by selecting Components > Catalog > Engineering Libraries.
You work with engineering libraries and the items they contain in the Engineering Libraries dialog box, which contains all of the hydraulic model’s engineering libraries. Individual
libraries are compilations of library entries, along with their attributes. For more information about working with engineering libraries, see Working with Engineering Libraries .
By default, each hydraulic model you create in Bentley SewerGEMS CONNECT uses the items in the default libraries. In special circumstances, you may wish to create custom
libraries to use with one or more hydraulic models. You can do this by copying a standard library or creating a new library.
When you change the properties for an item in an engineering library, those changes affect all hydraulic models that use that library item. At the time a hydraulic model is
loaded, all of its engineering library items are synchronized to the current library. Items are synchronized based on their label. If the label is the same, then the item’s values will
be made the same.
The default libraries that are installed with Bentley SewerGEMS CONNECT are editable. In addition, you can create a new library of any type, and can then create new entries of
your own definition.
• Library types are displayed in the Engineering Library manager in an expanding/collapsing tree view.
• Library types can contain categories and subcategories, represented as folders in the tree view.
• Individual library entries are contained within the categories, subcategories, and folders in the tree view.
• Libraries, categories, folders, and library entries are displayed in the tree view with their own unique icons. You can right-click these icons to display submenus with
different commands.
Right-clicking a Library icon in the tree view opens a shortcut menu containing the following commands:
Create Library Creates a new engineering library of the currently highlighted type.
Add Existing Library Lets you add an existing engineering library that has been stored on your hard drive as an .xml file to the current hydraulic model.
Right-clicking a Category icon in the tree view opens a shortcut menu containing the following commands:
Right-clicking a Folder icon in the tree view opens a shortcut menu containing the following commands:
[Link] 2025/06/14
Creating Your Model Page 66 of 174
Right-clicking a Library Entry icon in the tree view opens a shortcut menu containing the following commands:
The Engineering Libraries dialog box contains an explorer tree-view pane on the left, a library entry editor pane on the right, and the following buttons above the explorer tree
view pane:
New Opens a submenu containing the following commands: Create Library —Creates a new engineering library. Add Existing Library —Lets you add an
existing engineering library that has been stored on your hard drive as an .xml file to the current hydraulic model.
Save Opens a submenu containing the following commands: Save As —Lets you save the current engineering library under a new name and/or to a new
location. ProjectWise Check Out —Lets you check out an existing engineering library that has been stored in ProjectWise.
Remove Removes the currently highlighted engineering library from the current hydraulic model.
To share an engineering library on a network, open the Engineering Libraries and create a new library in a network folder to which all users have read-write access.
The following management controls are located above the minor loss coefficient list pane:
[Link] 2025/06/14
Creating Your Model Page 67 of 174
Deletes the minor loss coefficient that is currently highlighted in the list pane.
Delete
Renames the minor loss coefficient that is currently highlighted in the list pane.
Rename
Opens a report of the data associated with the minor loss coefficient that is currently highlighted in the list pane.
Report
Browses the Engineering Library, synchronizes to or from the library, imports from the library or exports to the library.
Synchronization Options
The tab section is used to define the settings for the minor loss that is currently highlighted in the minor loss list pane. The following controls are available:
Minor Loss This tab consists of input data fields that allow you to define the minor loss.
Tab
Minor Loss General type of fitting or loss element. This field is used to limit the number of minor loss elements available in choice lists. For example, the minor
Type loss choice list on the valve dialog box only includes minor losses of the valve type. You cannot add or delete types.
Minor Loss Headloss coefficient for the minor loss. This unitless number represents the ratio of the headloss across the minor loss element to the velocity head
Coefficient of the flow through the element.
Library Tab This tab displays information about the minor loss that is currently highlighted in the minor loss list pane. If the minor loss is derived from an
engineering library, the synchronization details can be found here. If the minor loss was created manually for this model, the synchronization details
will display the message Orphan (local), indicating that the minor loss was not derived from a library entry.
Notes Tab This tab contains a text field that is used to type descriptive notes that will be associated with the minor loss that is currently highlighted in the minor
loss list pane.
You can also create a totalizing flow meter by simply right-clicking a pressure pipe and selecting the Totalizing Flow Meter command from the context menu that appears.
[Link] 2025/06/14
Creating Your Model Page 68 of 174
The Totalizing Flow Meter Summary tab displays the totals for each element type.
The Totalizing Flow Meter Details tab displays results for each individual element.
1. Set Start and Stop times. Once selected, the results are automatically updated.
2. Click the Report button to run a report or click Close.
Highlight the element to be removed in the list and click the Delete button above the list pane.
1. Click the Select From Drawing button above the element list pane.
2. In the Drawing View, click the element or elements to be added.
3. Click the Done button in the Select dialog.
• Combination
• Curb
• Ditch
• Grate
• Slot
• Flow to Inlet vs. Flow Captured
• Gutter Depth vs. Captured Flow
• Kerb (United kingdom)
• Grating (United Kingdom)
You can also import an inlet definition from the Inlet Libraries Engineering Library, and export inlet definitions to the Engineering Library for later use.
The dialog box contains a list pane on the left and a tabbed input data area on the right, and includes the following controls:
New: Creates a new inlet definition in the list pane on the left.
Report: Lets you generate a preformatted report that contains the input data associated with the currently highlighted inlet definition.
Synchronization Options: Clicking this button opens a submenu containing the following commands:
• Browse Engineering Library--Opens the Engineering Library manager dialog, allowing you to browse the Inlet Libraries.
• Synchronize From Library--Lets you update a set of inlet definitions previously imported from one of the Inlet Libraries. The updates reflect changes that have been made
to the library since it was imported.
• Synchronize To Library--Lets you update one of the existing Inlet Libraries using current inlet definitions that were initially imported but have since been modified.
• Import From Library--Lets you import a inlet definition from one of the existing Inlet Libraries.
• Export To Library--Lets you export the current inlet definitions to one of the existing Inlet Libraries.
• Connect to Library--Lets you create a connection between the inlet catalog and the specified engineering library.
The fields and controls that appear in the tabbed area depend on which inlet type is chosen. Not all fields will be available for all inlet types.
Inlet Tab
• Structure Width: Define the width of the inlet structure. This field is available for all inlet types.
• Structure Length: Define the length of the inlet structure. This field is available for all inlet types.
• Curb Opening Height: Define the height of the curb opening. This field is available for Curb and Combination inlet types.
• Default Curb Opening Length: Define the default length of the curb opening. This field is available for Curb and Combination inlet types.
• Local Depression: Define the depth of the gutter depression at the inlet, if any. This field is available for Curb and Combination inlet types.
• Depression Width: Define the width of the gutter depression at the inlet, if any. This field is available for Curb and Combination inlet types.
• Throat Type: Choose the throat type. The throat type defines the shape of curb opening. This field is available for Curb and Combination inlet types.
• Throat Angle: Define the angle of the inlet throat. This field is only available when the Inclined Throat Type is chosen. This field is available for Curb and Combination inlet
types.
[Link] 2025/06/14
Creating Your Model Page 69 of 174
• Grate Type: Choose the grating type. This field is available for Combination, Ditch, and Grating inlet types.
• Grate Width: Define the width of the grating. This field is available for Combination, Ditch, and Grating inlet types.
• Default Grate Length: Define the default length of the grating. This field is available for Combination, Ditch, and Grating inlet types.
• Slot Width: Define the default width of the slot. This field is available for Slot inlet type.
• Default Slot Length: Define the default length of the slot. This field is available for Slot inlet type.
• Flow to Inlet vs. Flow Captured Table: This table is only available when the Flow to Inlet vs. Flow Captured Inlet type is selected. It allows you to define the amount of Flow
Captured at various Flow to Inlet points. Click the New button to add a new row to the table. Click the Delete button to remove the currently highlighted row from the
table.
• Gutter Depth vs. Captured Flow Table: This table is only available when the Gutter Depth vs. Captured Flow Inlet type is selected. It allows you to define the amount of
Captured Flow at various Gutter Depth values. Click the New button to add a new row to the table. Click the Delete button to remove the currently highlighted row from
the table.
• Kerb Angle (Alpha): The angle of alpha as in the diagram below.
• Kerb Angle (Beta): The angle of beta as in the diagram below.
Design Tab
This tab contains a list of allowable design lengths. When performing a design analysis, the program will only be able to select inlets of one of lengths specified here. To add a
new length to the list click the New button and type in the length. To remove a length from the list, highlight it and click the Delete button.
Notes Tab
This tab contains a text field that allows you to enter descriptive notes that will be associated with the currently highlighted inlet definition.
Library Tab
This tab displays information about the inlet definition that is currently highlighted in the list pane. If the inlet definition is derived from an engineering library, the
synchronization details can be found here. If the inlet definition was created manually for this model, the synchronization details will display the message Orphan (local),
indicating that the inlet definition was not derived from a library entry.
1. Click the Synchronization Options button and select Import From Library from the submenu.
2. Expand the Inlet Libraries node to view all of the existing Inlet Libraries. There will be the default Inlets Library, along with any additional custom libraries you've created.
3. Expand the desired library to view all of the inlet definitions within that library. Click on the inlet definitions to view their properties on the right side of the dialog.
4. When you have chosen the desired inlet definition click the Select button. The new inlet will appear in the list pane.
In Stand-Alone and AutoCAD, click Components > Catalog > Inlet Catalog.
In MicroStation and ArcGIS click the Bentley menu, then select Components > Inlet Catalog.
When you assign a catalog inlet to a catch basin, SewerGEMS V8i will assign the default curb and grate length values for that catalog inlet (as defined in the Default Curb Opening
Length and Default Grate Length fields) to the catch basin’s curb opening length and grate length respectively. However, you can also manually change the values for the catch
basin so that it the catalog inlet values and catch basin values are not in sync. When you perform an analysis computation run, the value in the catch basin attribute is used.
When you do a design run, the value of the catch basin attribute is initially used, but then that catch basin attribute can be changed during design to one of the available curb
opening lengths listed in the design tab of the referenced catalog inlet.
[Link] 2025/06/14
Creating Your Model Page 70 of 174
[Link] 2025/06/14
Creating Your Model Page 71 of 174
This dialog allows you tp specify the grating parameters for each grating type.
The dialog box contains the grating type vs. grating parameter table and the following controls:
Delete This button deletes the currently highlighted row from the type-parameter table.
Report Opens a print preview window containing a report that details the input data for this dialog box.
Column Description
Grating Type Select the grating type to be defined.
Grating Parameter Enter the parameter for the associated grating type.
Typical range of Grating Parameter values, by Grating Type, are given in the following table:
Grating Type P Q R S T
Range if G(s/m2) < or = 30 30.1 - 45 45.1 - 60 60.1 - 80 80.1 - 110
Design value Gd 30 45 60 80 110
These Neenah grates are not currently included in the default Bentley SewerGEMS Engineering Libraries, but in Bentley SewerGEMS it is quite straightforward for users to add
them as required.
6. Now this relationship can be copied and pasted into the Kerb Channel Depth vs. Captured Flow area of the Inlet editor. To do this, copy the data to the windows clipboard,
then in Bentley SewerGEMS , select the top right cell in Kerb Channel Depth vs. Captured Flow grid and press Ctrl+V to paste.
Note: Make sure the units used in the Inlet editor match the units used in determining the Depth vs. Captured Flow relationship.
[Link] 2025/06/14
Creating Your Model Page 72 of 174
This inlet is now set up and ready to use in the current Bentley SewerGEMS model. To make it available for use in other models, click on the Synchronization Options button and
select Export to Library.
For rectangular grates in sag, it is generally possible to enter a Neenah grate as a standard Grate Inlet Type.
However, please note that the Bentley SewerGEMS uses the HEC-22 methodology for computing capacity, which does not always produce capacities that correspond to
capacities given by Neenah Foundary (since some discharge coefficients are slightly different).
The designer should verify that they are satisfied with the calculated capacity in these cases.
For non-rectangular grates, the designer should compute, or request from Neenah Foundry, a Kerb Channel Depth vs. Captured Flow relationship for the grate and then enter
that in Bentley SewerGEMS using a procedure similar to the procedure outlined for Inlets On Grade above.
Note that the capacities of grate inlets in sag are not a function of the transverse of longitudinal slopes, so one Kerb Channel Depth vs. Captured Flow curve per grate is sufficient
for all transverse and longitudinal slopes.
• Conventional
• Irregular
• Parabolic
• Trapezoidal
• V-Shaped
You can also import a gutter definition from the Gutter Catalogs Engineering Library, and export gutter definitions to the Engineering Library for later use.
The dialog box contains a list pane on the left and a tabbed input data area on the right, and includes the following controls:
New: Creates a new gutter definition in the list pane on the left.
Report: Lets you generate a preformatted report that contains the input data associated with the currently highlighted gutter definition.
Synchronization Options: Clicking this button opens a submenu containing the following commands:
• Browse Engineering Library--Opens the Engineering Library manager dialog, allowing you to browse the Gutter Catalogs.
• Synchronize From Library--Lets you update a set of gutter definitions previously imported from one of the Gutter Catalogs. The updates reflect changes that have been
made to the library since it was imported.
• Synchronize To Library--Lets you update one of the existing Gutter Catalogs using current gutter definitions that were initially imported but have since been modified.
• Import From Library--Lets you import a gutter definition from one of the existing Gutter Catalogs.
• Export To Library--Lets you export the current gutter definitions to one of the existing Gutter Catalogs.
• Connect to Library--Lets you create a connection between the gutter catalog and the specified engineering library.
The fields and controls that appear in the tabbed area depend on which gutter shape is chosen. Not all fields will be available for all gutter types.
Gutter Tab
[Link] 2025/06/14
Creating Your Model Page 73 of 174
point on the irregular section equal to the invert elevation at the upstream and downstream ends of the conduit, and the elevation of other points in the irregular section
are adjusted accordingly.
• Height: The height of the parabolic gutter.
• Width: The width of the parabolic gutter.
• Bottom Width: The width along the bottom of the trapezoidal gutter.
• Left Side Slope: The left side slope of the trapezoidal gutter.
• Right Side Slope: The right side slope of the trapezoidal gutter.
• Curb Cross Slope: The slope of the curb, specific to a V-Shaped gutter. Conventional gutters assume a vertically sloped curb.
Library Tab
This tab displays information about the gutter definition that is currently highlighted in the list pane. If the gutter definition is derived from an engineering library, the
synchronization details can be found here. If the gutter definition was created manually for this model, the synchronization details will display the message Orphan (local),
indicating that the gutter definition was not derived from a library entry.
Notes Tab
This tab contains a text field that allows you to enter descriptive notes that will be associated with the currently highlighted gutter definition.
1. Click the Synchronization Options button and select Import From Library from the submenu.
2. Expand the Gutter Catalogs node to view all of the existing gutter libraries. There will be the default Gutter Catalogs, along with any additional custom libraries you've
created.
3. Expand the desired library to view all of the gutter definitions within that library. Click on the gutter definitions to view their properties on the right side of the dialog.
4. When you have chosen the desired gutter definition click the Select button. The new gutter will appear in the list pane.
In MircoStation and ArcGIS: Click the Bentley SewerGEMS menu, then select Components > Gutter Catalog.
Move Upstream Click to move the gutter immediately upstream of the current gutter. If there are more than one upstream
gutters than select the gutter from the drop down menu.
Move Downstream Click to move the gutter immediately downstream of the current gutter. If there are more than one
downstream gutters than select the gutter from the drop down menu.
[Link] 2025/06/14
Creating Your Model Page 74 of 174
Build From Terrain Will find all sections of along the length of the gutter link from the terrain model. Click the arrow button to
select Build Gutter Sections Options, allowing you to set the options for building from the terrain model.
Sections List
Displays the list stations for each of the sections associated with the gutter. Click the section to view the section and its properties.
Displays a graph view of the gutter section that is currently highlighted in the Sections List.
The time browser will update the HGL value in the cross section viewer and time-variable property grid results
Displays the data values of the gutter section that is currently highlighted in the Sections List.
Section Properties
• Station - Location of section measured from the start node of the gutter.
• X - Actual location of section in the model.
• Y - Actual location of section in the model.
• Invert - Bottom elevation of the gutter section.
• Angle - Gutter cross section angle to road is the angle of the cross-section line to the X coordinate line.
• Depth Constraint - The depth design constraint that is used during the analysis.
• Spread Constraint - The spread design constraint that is used during the analysis.
• Depth - Depth of flow in gutter section at current time step.
• Depth Constraint Violated? - Is True if the depth constraint is violated at the currently selected time.
• Flow - Flow in gutter section at current time step.
• Spread - Top width of flow in gutter section at current time step.
• Spread Constraint Violated? - Is True if the spread constraint is violated at the currently selected time.
• Velocity - Velocity of flow in gutter section at current time step.
• Depth (Maximum) - The maximum flow depth that occurs at the gutter section.
• Depth Constraint Ever Violated? - Is True if the depth design constraint is violated at any point during the simulation.
• Spread (Maximum) - The maximum spread that occurs at the gutter section.
• Spread Constraint Ever Violated? - Is True if the spread design constraint is violated at any point during the simulation.
When using Gutter Sections derived from the terrain model the SWMM engine works as follows:
1. First the SWMM engine calculates and figures out the carryover flow entering the gutter and the total flow leaving gutter.
2. After the SWMM engine completes, the depth and spreads are computed at each of the sections based on linearly interpolating the bounding flows based on the station
of the section.
When using Gutter Sections derived from the terrain model the DW engine works as follows:
1. First the DW engine calculates and figures out the carryover flow entering the gutter and the total flow leaving gutter.
2. After the DW engine completes, the flow for a gutter section is derived by linearly interpolating the bounding flows: flow at the individual section: (start flow) + station *
(stop flow - start flow)/(pipe length)
3. With the interpolated flow at a particular gutter section, the depth and spread at the section are computed as if it was an irregular channel like FlowMaster: assuming
Manning’s Uniform Flow.
4. Statistics of Max Depth and Max Spread are computed for each section, and compare to the design threshold values for depth and spread for each gutter.
• Minimum Spacing Between Sections: Only when distance between 2 gutter cross-sections is larger than this value will a gutter section be added. Sections at the upstream
inlet and downstream inlet are always added. Other middle sections are added between the upstream inlet section and downstream inlet section. Space between 2
sections should be larger than the Minimum Gutter Section Space value, except the last two sections (the section before downstream inlet section and downstream inlet
section). The Space between the last 2 sections can be smaller than the Minimum Gutter Section Space value but must be larger than half of the Minimum Gutter Section
Space value.
The following is an example of gutter cross-sections between upstream and downstream inlets, in which blue lines are gutter cross-sections to be derived from terrain
model.
[Link] 2025/06/14
Creating Your Model Page 75 of 174
• Maximum Bank Search Height: For a composite terrain model with road design and natural area, the left or right bank of the gutter may be much higher than the gutter
invert and many more points can be added to the gutter station-elevation curve. For left bank and right bank of a gutter, we only find one point with depth more than
Gutter Depth (or Maximum Bank Search Height) value. In the following example, when we find point D, we stop the search on the left bank of the gutter cross-section.
• Maximum Bank Search Distance: For a natural terrain model, if the bank slope is small, the bank horizontal length can be very large. Maximum bank search distance is
used to avoid having very long gutter banks. In searching gutter left bank or right bank, when the distance between the searched point and the point with lowest
elevation in the cross-section is greater than the specified Maximum bank search distance, the search for the bank will stop. In the following example, when the horizontal
distance between the searched point D and the lowest point A in cross-section is larger than Maximum Bank Search Distance, the search for the bank will stop.
• Maximum Inlet Offset Search Distance: To create a valid gutter link between 2 inlets, the downstream inlet must be in the downstream trace path from the upstream
inlet. Since the inlet may not be exactly laid out in the gutter, a Maximum Inlet Offset Search Distance (or Inlet In Path Tolerance) is used to check if the downstream inlet
is in the downstream path from an upstream inlet. If the distance from the center of the downstream inlet to the downstream trace line from upstream inlet is less than
the Maximum Inlet Offset Search Distance value, the downstream inlet is assumed to be at the downstream trace path from the upstream inlet. The following is an
example of a downstream inlet in the downstream trace path from an upstream inlet, where distance from downstream inlet to the downstream trace path is smaller
than the Maximum Inlet Offset Search Distance value.
Methodology
To Find the Inlet Locations in a Gutter: Since the inlets may not be exactly laid out in gutters, the software needs to find the inlet locations in the gutter and search gutter cross-
sections from the inlet location in the gutter. A perpendicular line is drawn from inlet to gutter line and the intersecting point is the inlet location in gutter. The following is an
example of finding the inlet location in gutter:
[Link] 2025/06/14
Creating Your Model Page 76 of 174
From a point in a gutter, draw a line perpendicular to the gutter line, which is the downstream trace line. From the point in either direction of the line, search point in increasing
elevation order until invalid point or a point with lower elevation than last searched point is searched. Pass the searched 2 points in both directions to the terrain model to get
the profile information between the two points. Remove the duplicated points and the points that are beyond the gutter bank to get the gutter cross-section points. With Gutter
Depth value used, when a point with depth larger than the Gutter Depth value, the search in that direction is stopped to avoid getting too many points in the gutter cross-
section.
In the following gutter profiling example, search gutter cross-section points from lowest elevation point A in gutter to both sides. When It reaches point D (which has higher
elevation than elevation at A plus Gutter Depth), the search will stop on that side and point D is added to gutter cross-section. When search reaches point F which has lower
elevation than last searched point E, the search will stop on that side and point F is not added to gutter cross-section.
The dialog box contains a toolbar, a Conduit Catalog list pane, and two tabs. The toolbar contains the following buttons:
Delete Deletes the entry that is currently highlighted in the Conduit Catalog List Pane.
Rename Lets you rename the entry that is currently highlighted in the Conduit Catalog List Pane.
Report Lets you generate a preformatted report that contains the input data associated with the entry that is currently highlighted in the Conduit
Catalog List Pane.
Synchronize Clicking this button opens a submenu containing the following commands: Browse Engineering Library --This command opens the Engineering
Library manager dialog, allowing you to browse the Conduit Catalog Library. Synchronize From Library --This command allows you to update a
Conduit Catalog that was previously imported from a Conduit Catalog Engineering Library to reflect changes that have been made to the library
since it was imported. Synchronize To Library --This command allows you to update an existing Conduit Catalog Engineering Library using current
Conduit Catalog entries that were initially imported but have since been modified. Import From Library --This command allows you to import
catalog entries from an existing Conduit Catalog Engineering Library. Export To Library --This command allows you to export the current catalog
entries to an existing Conduit Catalog Engineering Library. Connect To Library --This command allows you to connect the current catalog entries
to an existing Conduit Catalog Engineering Library.
The following table describes the rest of the controls in the Conduit Catalog dialog box.
Conduit Catalog Located on the left side of the dialog box, displays a list of all of the catalog pipes that have been defined in the current model. Highlighting a
List Pane catalog pipe in this list causes the Cross Section Shape and Roughness Sections to display the associated information with the highlighted pipe.
Cross Section Located in the top-right corner of the Conduit Catalog tab, contains controls that allow you to define the size and shape of the catalog pipe
Shape currently highlighted in the List Pane. The controls that appear change according to the Cross Section Type that is selected.
Conduit Shape Lets you define the type of cross section for the currently highlighted catalog pipe.
Diameter Lets you define the diameter of the pipe. This field is only available for Circular catalog pipes.
Rise Lets you define the rise (height) of the catalog pipe. This field is available for all cross section types except Circular.
Span Lets you define the span (width) of the catalog pipe.
Power Exponent Lets you define the power exponent for Power Channel conduit shapes.
Bottom Radius Lets you define the bottom radius of Rectangular-Round conduit shapes.
(Rectangular-
Round)
Triangle Height Lets you define the triangle height of Rectangular-Triangle conduit shapes.
(Rectangular-
Triangle)
Bottom Width The width at the base of the cross section of the conduit.
Left Side Slope The left slope of the cross section of the conduit.
Right Side Slope The right slope of the cross section of the conduit.
Channel Lets you select the channel weighting method to use for Irregular Channel conduit shapes.
Weighting
Method
Irregular Channel This table allows you to define the following attributes when the Irregular Channel Conduit Shape is selected: The table contains the following
Table columns: Station - This field allows you to define the cross-sectional distance at the current curve point. You can enter these in any order that
defines the channel (e.g., from left-to-right, from right-to-left, with an upstream or downstream perspective). Depth - This field allows you to
define the depth for the current curve point for the channel. The value here is relative, i.e. you can define it based on the bottom of the channel
being 0 feet and the top being 1 foot, and it will perform identically as using the actual elevation of one endpoint for the bottom of the channel,
and the top sides of the channel being the bottom+1ft. This value can be a negative number.
Availability Located in the mid-right corner of the Conduit Catalog tab, lets you select whether or not the current conduit is available for automated design.
[Link] 2025/06/14
Creating Your Model Page 77 of 174
Available for When this box is checked, the current conduit will be available for use during an automated design run.
Design?
Roughness Located in the bottom-right corner of the Conduit Catalog tab, lets you define the roughness attributes of the catalog pipe currently highlighted in
the List Pane. The controls that are available change depending on the Roughness Type selected.
Roughness Type Lets you specify which of the available roughness methods to be applied to the catalog pipe currently highlighted in the List Pane. The other
controls available in section are dependent on the selection made in this box.
Material Lets you enter a material label. This field is informational only, and will not affect the roughness properties of the associated catalog entry.
Manning’s n Lets you define the roughness value for the catalog pipe. This field is available only when the Roughness Type is Single Manning’s n.
Depth vs. Lets you define a depth vs. roughness curve for the catalog pipe. This field is available only when the Roughness Type is Manning’s n-Depth Curve.
Manning’s Table
Manning’s vs. Lets you define a flow vs. roughness curve for the catalog pipe. This field is available only when the Roughness Type is Manning’s n-Flow.
Discharge Table
Library Tab Displays information pertaining to the catalog entry that is currently highlighted in the List Pane, including: ID Label Modified Date Library Source
Library Modified Date Synchronization Status
This dialog box lets you define a Manning’s n vs. Depth table for conduits and channels. The dialog box contains the Depth vs. Manning’s table and the following buttons:
Report Opens a print preview window containing a report that details the input data for this dialog box.
Column Description
Depth Lets you define the depth of the depth vs. Manning’s curve point.
Manning’ n Lets you define the roughness value at the specified depth in the Depth vs. Manning’s table.
Related Topics
• "Roughness Models"-315
[Link] 2025/06/14
Creating Your Model Page 78 of 174
1. Display the Property Editor for the link element. For a conduit, click the conduit in your model, or right-click the conduit and select Properties from the shortcut menu. For
a channel, click the connecting cross-section node in your model, or right-click the channel and select Properties from the shortcut menu.
2. In the Physical section of the Property Editor, select Manning's n - Flow as the Roughness Type. The Manning's-Flow Curve field becomes available.
3. Click the Ellipses (...) button next to the Manning's n - Flow Curve field.
4. In the Manning's n - Flow Curve dialog box, each row in the table represents a depth value and its associated Manning's n roughness value. For each row in the table,
perform the following steps: Type the depth in the Flow column, then press the Tab key to move to the Manning's n column. Type a value in the Manning's n column or
click the Ellipses (...) button in the column to display the Material Libraries in the Engineering Libraries. Click the plus signs to expand the Material Libraries, then select the
desired material and click the Select button. The Manning's n roughness value associated with the selected material appears in the table. You can edit the values of a
minor loss type in the Engineering Libraries in the Editor pane.
5. Click the New button to add a row to the table.
6. Repeat Steps 4 and 5 for each new row of values in the table.
7. Perform the following optional steps: To delete a row from the table, select the row then click Delete. To view a report on the curve, click Report.
8. Click OK to close the dialog box and save the curve data in the Property Editor.
This dialog box lets you define Flow vs. Manning's n tables for conduits and channels.
The dialog box contains the flow vs. Manning's table and the following buttons:
Report: Opens a print preview window containing a report that details the input data for this dialog box.
Flow: Lets you define the flow of the flow vs. Manning's curve point.
Manning's n: Lets you define the roughness value at the specified flow in the Flow vs. Manning's table.
Vortex Valves
This dialog allows you to define vortex valve elements.
The dialog box contains a toolbar, a list pane, and two tabs. The toolbar contains the following buttons:
Delete Deletes the entry that is currently highlighted in the Vortex Valve List Pane.
Duplicate Deletes the entry that is currently highlighted in the Vortex Valve List Pane.
Rename Lets you rename the entry that is currently highlighted in the Vortex Valve List Pane.
Report Lets you generate a preformatted report that contains the input data associated with the entry that is currently highlighted in the Vortex Valve
List Pane.
Synchronize Clicking this button opens a submenu containing the following commands: Browse Engineering Library --This command opens the Engineering
Library manager dialog, allowing you to browse the Vortex Valve Library. Synchronize From Library --This command allows you to update a valve
library that was previously imported from a Vortex Valve Library to reflect changes that have been made to the library since it was imported.
Synchronize To Library --This command allows you to update an existing Vortex Valve Library using current valve entries that were initially
imported but have since been modified. Import From Library --This command allows you to import catalog entries from an existing Vortex Valve
Library. Export To Library --This command allows you to export the current catalog entries to an existing Vortex Valve Library.
Help Opens the online help documentation.
To define a vortex valve, highlight it in the list pane, then enter points in the Head-Flow table of the Head-Flow Curve tab. Click the New button to add a row to the table, or
Delete to remove the currently highlighted row.
In addition to the Head-Flow Curve tab, the following tabs are also available:
Notes This tab contains a text field that allows you to enter descriptive notes that will be associated with the valve that is currently highlighted in the Vortex Valve
Tab List Pane.
Library This tab displays information about the valve that is currently highlighted in the Vortex Valve List Pane. If the valve is derived from an engineering library,
Tab the synchronization details can be found here. If the valve was created manually for this model, the synchronization details will display the message Orphan
(local), indicating that the valve was not derived from a library entry.
The dialog box contains thehead vs. flow table and the following buttons:
[Link] 2025/06/14
Creating Your Model Page 79 of 174
Head: Lets you define the head of the head vs. flow curve point.
Flow: Lets you define the flow of the head vs. flow curve point.
Water Quality
SWMM Hydrology
SWMM Snow Packs (SWMM Snow Pack Editor)
Climatology Dialog Box
Aquifers Dialog Box
SWMM Control Sets Dialog Box
Pollutants Dialog Box
Adding Pollutographs to a Node
Land Uses Dialog Box
Adding Treatment to a Node
Initial Buildup Collection Dialog Box
Buildup Time Series Dialog Box
EPA SWMM - Bentley (Enhanced)
Hydraulic Calculation Events
Water Quality
Bentley SewerGEMS CONNECT can perform water quality modeling using the SWMM water quality solver. In order to make a water quality run choose the SWMM5 Explicit
Engine from the Home > Calculation Options > Active Numerical Solver.
You must then define the pollutant being modeled using the Analysis > Components > SWMM Extensions > Pollutants dialog (see ”Pollutants Dialog Box’). In the Pollutants
dialog, the enter a name for the pollutant and define the properties.
If water quality data is present in a scenario, water quality calculations will be performed.
There are two methods for loading pollutants in a water quality simulation.
1. Point (node) load, which involves assigning a pollutograph (see ”Adding Pollutographs to a Node’) to a node element (such as a manhole or a cross section). This can be done
in the element property grid or under the water quality alternative of the Alternatives Manager for that element. This method is used for point loads such as industrial
dischargers or normal domestic customers.
2. Catchment runoff, where the pollutant enters the system based on one of several different washoff functions for each land use assigned to a catchment. Land uses and
washoff (and optional buildup/treatment) functions are defined under Components > SWMM Extensions > Land Use. Then under, Analysis > Alternatives > Water Quality >
Catchments, define what fraction of the catchment is associated with each land use (see ”Land Uses Collection Dialog Box’) and the initial buildup of pollutants (see ”Initial
Buildup Collection Dialog Box’) at the start of the run. In long-term runs, you can specify the rate at which pollutants build up on the catchment surface (and are possibly
removed by treatments such as street sweeping).
It is not possible to view the water quality results using the standard graphing. Instead, you must open the property grid for the element, scroll down to Results > Pollutant and
open the collection by clicking on the ellipsis button. This will display a graph of concentration vs. time. Switching to the Data tab will give tabular results.
Note: When Bentley SewerGEMS CONNECT is running calculations using the Implicit Engine Type (this setting is found in the Calculation Options Manager), SWMM attributes
and their associated values are not considered. Only when the SWMM Engine Type is used will the data contained in these dialog boxes have any effect on the calculated results.
[Link] 2025/06/14
Creating Your Model Page 80 of 174
SWMM Hydrology
You can use the Explicit (SWMM 5.1.012) engine in Bentley SewerGEMS CONNECT to route flows through the system. However, in order to use SWMM hydraulics, you must load
the model through inflows at nodes, or you must select EPA-SWMM Runoff as the runoff method for a catchment. If you are not familiar with SWMM hydrology, we strongly
recommend that you read SWMM 5 documentation for a detailed discussion of the topic.
The overall process through which precipitation is converted to flow in conduits and channels is summarized in the following figure.
The parameters used in determining runoff can be divided into two categories:
Parameters that are shared by the SWMM model and the Bentley SewerGEMS native hydrology calculations. These include SCS runoff curve number, Horton max and min
infiltration rates, etc. You can enter these parameters in the Property Editor or in the FlexTable for a specific catchment.
Parameters that are unique to the SWMM model. These include evaporation rates, aquifer conductivity, and wilting point. To enter these parameters, you must select
Components > SWMM Extensions, then select the appropriate SWMM dialog.
The SWMM engine allows for two different modes when applying the Horton infiltration method when using the EPA SWMM runoff method on catchments:
1. Horton - When this method is selected, the precipitation rate is always assumed to exceed the infiltration rate, regardless of how much rainfall as actually infiltrated.
Hence the infiltration rate is purely a function of time.
2. Horton (Modified) - When this method is selected, infiltration rate is a function of the total amount of rainfall which has infiltrated
You select which method is applied in the calculation property, "Default Infiltration Method" under the "Calculation Options (SWMM Hydrology)".
The Groundwater calculation is invoked when the “Apply groundwater” is set as “true” in the property of a Subcatchment. It is used to link a subcatchment to both a parent
aquifer and to a node of the conveyance system that exchanges groundwater with the subcatchment. It also specifies coefficients that determine the rate of groundwater flow
between the aquifer and the node. These coefficients (A1, A2, B1, B2, and A3) appear in the following equation that computes groundwater flow as a function of groundwater
and surface water levels.
In addition to the standard flow equation, the solver allows user to define a custom equation whose results will be added onto those of the standard equation. Finally, the dialog
offers the option to override certain parameters that were specified for the aquifer to which the subcatchment belongs. The properties listed in the editor are as follows:
• Aquifer Name: Name of the aquifer object that describes the subsurface soil properties, thickness, and initial conditions. Leave this field blank if you want the
subcatchment not to generate any groundwater flow.
• Receiving Node: Name of the node that receives groundwater from the subcatchment.
• Surface Elevation: Elevation of the subcatchment's ground surface (ft or m).
• Groundwater Flow Exponent: Value of A1 in the groundwater flow formula.
• Surface Water Flow Coefficient: Value of A2 in the groundwater flow formula.
• Surface Water Flow Exponent: Value of B2 in the groundwater flow formula.
• Surface-GW Interaction Coefficient: Value of A3 in the groundwater flow formula.
• Surface Water Height: Fixed height of surface water at the receiving node above the aquifer bottom (ft or m). Set to zero if surface water depth will vary as computed by
flow routing.
[Link] 2025/06/14
Creating Your Model Page 81 of 174
• Channel Bottom Height: Water table height above the aquifer bottom that must be reached before any flow occurs (feet or meters). Leave blank to use the receiving
node's invert elevation.
• Bottom Elevation: Elevation of the bottom of the aquifer (ft or m). Leave blank to use the value from the parent aquifer.
• Water Table Elevation: Elevation of the water table in the aquifer at the start of the simulation (ft or m). Leave blank to use the value from the parent aquifer.
• Unsaturated Zone Moisture: Moisture content of the unsaturated upper zone of the aquifer at the start of the simulation (volumetric fraction). Leave blank to use the
value from the parent aquifer.
• Custom Groundwater Flow Equation: Click the ellipsis button (or press Enter) to launch the Custom Groundwater Flow Equation editor. The equation supplied by this
editor will be used in addition to the standard equation to compute groundwater outflow from the subcatchment. The coefficients supplied to the groundwater flow
equations must be in units that are consistent with the groundwater flow units, which can either be cfs/acre for US units or cms/ha for SI units.
• The Plowable snow pack area consists of a user-defined fraction of the total impervious area. It is meant to represent such areas as streets and parking lots where plowing
and snow removal can be done.
• The Impervious snow pack area covers the remaining impervious area of a catchment.
• The Pervious snow pack area encompasses the entire pervious area of a catchment.
In addition, a set of snow removal parameters can be assigned to the Plowable area. These parameters consist of the depth at which snow removal begins and the fractions of
snow moved onto various other areas.
Catchments are assigned a snow pack object through their Snow Pack property. A single snow pack object can be applied to any number of catchments. Assigning a snow pack to
a catchment simply establishes the melt parameters and initial snow conditions for that catchment. Internally, the SWMM solver creates a "physical" snow pack for each
catchment, which tracks snow accumulation and melting for that particular catchment based on its snow pack parameters, its amount of pervious and impervious area, and the
precipitation history it sees.
The Snow Pack Editor contains a list view for the snow pack's name and two tabbed pages, one for Snow Pack Parameters and one for Snow Removal Parameters.
Access the Snow Pack Editor by selecting Components > SWMM Extensions > Snow Pack, or by selecting Edit in the Snow Pack field in the Properties Editor when viewing the
properties of a catchment (note: for the Snow Pack field to be visible, Has Snow Pack? must be set to True).
Minimum Melt Coefficient: The degree-day snow melt coefficient that occurs on December 21. Units are either in/hr-deg F or mm/hr-deg C.
Maximum Melt Coefficient: The degree-day snow melt coefficient that occurs on June 21. Units are either in/hr-deg F or mm/hr-deg C. For a short term simulation of less than a
week or so it is acceptable to use a single value for both the minimum and maximum melt coefficients.
The minimum and maximum snow melt coefficients are used to estimate a melt coefficient that varies by day of the year. The latter is used in the following degree-day equation
to compute the melt rate for any particular day: Melt Rate = (Melt Coefficient) * (Air Temperature - Base Temperature).
Fraction Free Water Capacity: The volume of a snow pack's pore space which must fill with melted snow before liquid runoff from the pack begins, expressed as a fraction of
snow pack depth.
Initial Snow Depth: Depth of snow at the start of the simulation (water equivalent depth in inches or millimeters).
Initial Free Water: Depth of melted water held within the pack at the start of the simulation (inches or mm). This number should be at or below the product of the initial snow
depth and the fraction free water capacity.
Depth at 100% Cover: The depth of snow beyond which the entire area remains completely covered and is not subject to any areal depletion effect (inches or mm).
Plowable Impervious Area: The fraction of impervious area that is plowable and therefore is not subject to areal depletion.
[Link] 2025/06/14
Creating Your Model Page 82 of 174
• Depth at which snow removal begins: Depth which must be reached before any snow removal begins.
• Fraction transferred out of watershed: The fraction of snow depth that is removed from the system (and does not become runoff).
• Fraction transferred to the impervious area: The fraction of snow depth that is added to snow accumulation on the pack's impervious area.
• Fraction transferred to the pervious area: The fraction of snow depth that is added to snow accumulation on the pack's pervious area.
• Fraction converted to immediate melt: The fraction of snow depth that becomes liquid water which runs onto any catchment associated with the snow pack.
• Snow Transferred Outside Catchment: The fraction of snow depth which is added to the snow accumulation on some other catchment.
• Snow Catchment: The name of the catchment that receives the snow that is transferred outside of the snow pack.
The various removal fractions must add up to 1.0 or less. If less than 1.0, then some remaining fraction of snow depth will be left on the surface after all of the redistribution
options are satisfied.
The dialog is divided into tabbed pages, where each page provides a separate editor for the following data categories (listed at the bottom of this page).
Access this dialog box by selecting Components > SWMM Extensions > Climatology.
The data shown in this dialog box is linked to the active Rainfall-Runoff Alternative, so differently climatology data can be used in different Scenarios.
Temperature Tab
Evaporation Tab
Wind Speed Tab
Snowmelt Tab
Areal Depletion Tab
Adjustments Tab
Climate Files
Temperature Tab
The Temperature page of the Climatology Editor dialog is used to specify the source of temperature data used for snow melt computations. There are three choices available:
Evaporation Tab
The Evaporation page of the Climatology Editor dialog is used to supply evaporation rates for a study area. There are six choices for specifying these rates; for all but the No
Evaporation option, check the Evaporate Only During Dry Periods? box to allow evaporation only during periods with no precipitation. You may also define a Monthly Soil
Recovery Pattern to allow the infiltration recovery rate to be adjusted by a fixed amount on a monthly basis to account for seasonal variation in evaporation rates. The
Evaporation Types are as follows:
From Climate File: Wind speeds will be read from the same climate file that was specified for temperature.
[Link] 2025/06/14
Creating Your Model Page 83 of 174
Monthly Averages: Wind speed is specified as an average value that remains constant in each month of the year. Enter a value for each month in the data grid provided. The
default values are all zero.
Snowmelt Tab
Snowmelt parameters are climatic variables that apply across the entire study area when simulating snowfall and snowmelt.
The Snowmelt page of the Climatology Editor dialog is used to supply values for the following parameters related to snowmelt calculations:
• Dividing Temperature Between Snow and Rain: Enter the temperature below which precipitation falls as snow instead of rain.
• Antecedent Temperature Index Weight: This parameter reflects to what degree heat transfer within a snow pack during non-melt periods is affected by prior air
temperatures. Smaller values reflect a thicker surface layer of snow which result in reduced rates of heat transfer. Values must be between 0 and 1, and the default is 0.5.
• Negative Melt Ratio: This is the ratio of the heat transfer coefficient of a snow pack during non-melt conditions to the coefficient during melt conditions. It must be a
number between 0 and 1. The default value is 0.6.
• Elevation Above Mean Sea Level: Enter the average elevation above mean sea level for the study area, in feet or meters. This value is used to provide a more accurate
estimate of atmospheric pressure. The default is 0.0, which results in a pressure of 29.9 inches Hg. The effect of wind on snow melt rates during rainfall periods is greater
at higher pressures, which occur at lower elevations.
• Latitude: Enter the latitude, in degrees North, of the study area. This number is used when computing the hours of sunrise and sunset, which in turn are used to extend
min/max daily temperatures into continuous values. It is also used to compute daily evaporation rates from daily temperatures. The default is 50 degrees North.
• Longitude Correction: This is a correction, in minutes of time, between true solar time and the standard clock time. It depends on a location's longitude (
) and the standard meridian of its time zone (SM) through the expression 4 (
-SM). This correction is used to adjust the hours of sunrise and sunset when extending daily min/max temperatures into continuous values. The default value is 0.
The Areal Depletion page of the Climatology Editor dialog is used to specify points on the Areal Depletion Curves for both impervious and pervious surfaces within a project's
study area. These curves define the relation between the area that remains snow covered and snow pack depth. Each curve is defined by 10 equal increments of relative depth
ratio between 0 and 0.9. (Relative depth ratio is the ratio of an area's current snow depth to the depth at which there is 100% areal coverage).
Enter values in the data grid provided for the fraction of each area that remains snow covered at each specified relative depth ratio. Valid numbers must be between 0 and 1 (0%
and 100%), and be increasing with increasing depth ratio.
Values can be initialized for impervious or pervious area by click on the Initialize Impervious or Initialize Impervious buttons. Clicking the Natural Area item fills the grid with
values that are typical of natural areas. Clicking the No Depletion item will fill the grid with all 1's (100%), indicating that no areal depletion occurs. This is the default for new
models.
Adjustments Tab
This tab allows you to define climate adjustments.
[Link] 2025/06/14
Creating Your Model Page 84 of 174
Climate Files
This software can use an external Climate File that contains daily air temperature, evaporation, and wind speed data. The program currently recognizes the following formats:
A DSI-3200 or DSI-3210 file available from the National Climatic Data Center at [Link]/oa/[Link].
A user-prepared climate file where each line contains a recording station name, the year, month, day, maximum temperature, minimum temperature, and optionally,
evaporation rate, and wind speed. If no data are available for any of these items on a given date, then an asterisk should be entered as its value.
When a climate file has days with missing values, SWMM will use the value from the most recent previous day with a recorded value.
For a user-prepared climate file, the data must be in the same units as the model being analyzed. For US units, temperature is in degrees F, evaporation is in inches/day, and
wind speed is in miles/hour. For metric units, temperature is in degrees C, evaporation is in mm/day, and wind speed is in km/hour.
Access this dialog box by selecting Components > SWMM Extensions > Aquifers.
This dialog box contains a toolbar, a list pane on the left that displays all of the aquifers that have been defined in the current model, and the attribute fields on the right that
permit the values to be defined for the aquifer that is currently highlighted in the list pane. The toolbar contains the following buttons:
Delete Deletes the entry that is currently highlighted in the Aquifer List Pane.
Rename Lets you rename the entry that is currently highlighted in the Aquifer List Pane.
Report Lets you generate a preformatted report that contains the input data associated with the entry that is currently highlighted in the Aquifer List Pane.
The attribute fields along the right side of the dialog box include:
Porosity Lets you define the volume of voids / total soil volume for the currently highlighted aquifer.
Wilting Point Lets you define soil moisture content at which plants cannot survive for the currently highlighted aquifer.
Field Capacity Lets you define soil moisture content after all free water has drained off for the currently highlighted aquifer.
[Link] 2025/06/14
Creating Your Model Page 85 of 174
Aquifer Conductivity Lets you define the soil's saturated hydraulic conductivity for the currently highlighted aquifer.
Conductivity Slope Lets you define the slope of conductivity vs. soil moisture content curve for the currently highlighted aquifer.
Tension Slope Lets you define the slope of soil tension vs. soil moisture content curve for the currently highlighted aquifer.
Upper Evaporation Lets you define the fraction of total evaporation available for evapotranspiration in the upper unsaturated zone for the currently
Fraction highlighted aquifer.
Lower Evaporation Depth Lets you define the maximum depth into the lower saturated zone over which evapotranspiration can occur for the currently highlighted
aquifer.
Lower Groundwater Loss Lets you define the rate of percolation from the saturated zone to deep groundwater when water table is at ground surface for the
Rate currently highlighted aquifer.
Elevation (Bottom) Lets you define the elevation of the bottom of the aquifer for the currently highlighted aquifer.
Water Table Elevation Lets you define the elevation of the water table in the aquifer at the start of the simulation for the currently highlighted aquifer.
Unsaturated Zone Lets you define the moisture content of the unsaturated upper zone of the aquifer at the start of the simulation for the currently
Moisture highlighted aquifer.
A user indicates that a control set is to be used in a give scenario by setting "Apply SWMM control set" to True in the Calculation options for that scenario, then picking the
appropriate control set from the drop down list in "SWMM Control Set". The control set must already have been created.
It is best to only specify either a SWMM control set or on/off controls for a model but not both as the two types of controls can conflict.
This dialog box allows you to create, view, and manage SWMM controls. Access it by selecting Components > SWMM Extensions > Control Sets.
This dialog box contains a toolbar, a list pane on the left that displays all of the controls that have been defined in the current model, and a control editor pane on the right that
allows you to enter and edit the currently highlighted SWMM control definition. The toolbar contains the following buttons:
Delete Deletes the entry that is currently highlighted in the Control List Pane.
Rename Lets you rename the entry that is currently highlighted in the Control List Pane.
Report Lets you generate a preformatted report that contains the input data associated with the entry that is currently highlighted in the Control List Pane.
The Control Editor Pane allows you to define SWMM controls. Each control rule is a series of statements of the form:
RULE ruleID IF condition_1 AND condition_2 OR condition_3 AND condition_4 Etc. THEN action_1 AND action_2 Etc. ELSE action_3 AND action_4 Etc. PRIORITY value
where keywords are shown in boldface and ruleID is an ID label assigned to the rule, condition_n is a Condition Clause, action_n is an Action Clause, and value is a priority value
(e.g., a number from 1 to 5).
Only the RULE, IF and THEN portions of a rule are required; the other portions are optional.
Blank lines between clauses are permitted and any text to the right of a semicolon is considered a comment.
When mixing AND and OR clauses, the OR operator has higher precedence than AND, i.e.,
IF A or B and C
is equivalent to
IF (A or B) and C
IF A or (B and C)
The PRIORITY value is used to determine which rule applies when two or more rules require that conflicting actions be taken on a link. A rule without a priority value always has
a lower priority than one with a value. For two rules with the same priority value, the rule that appears first is given the higher priority.
Note: Expected Units for control sets are as follows: Flow: cfs; Length: feet; Time: hours
[Link] 2025/06/14
Creating Your Model Page 86 of 174
Etc.
Etc.
Etc.
PRIORITY value
where keywords are shown in boldface and ruleID is an ID label assigned to the rule, condition_n is a Condition Clause, action_n is an Action Clause, and value is a priority value
(e.g., a number from 1 to 5).
Condition Clauses
Where:
NODE N23 DEPTH > 10 PUMP P45 STATUS = OFF SIMULATION CLOCKTIME = [Link]
The objects and attributes that can appear in a condition clause are as follows:
Action Clauses
An Action Clause of a Control Rule can have one of the following formats:
Where SETTING is the fractional amount that an orifice is fully open or to the fractional amount of the original height between the crest and the top of a weir that remains (i.e.,
weir control is accomplished by moving the crest height up and down).
Only the RULE, IF and THEN portions of a rule are required; the other portions are optional.
Blank lines between clauses are allowed, and any text to the right of a semicolon is considered a comment.
When mixing AND and OR clauses, the OR operator has higher precedence than AND, i.e.,
IF A or B and C
is equivalent to
IF (A or B) and C.
IF A or (B and C)
The PRIORITY value is used to determine which rule applies when two or more rules require that conflicting actions be taken on a link. A rule without a priority value always has
a lower priority than one with a value. For two rules with the same priority value, the rule that appears first is given the higher priority.
Examples
[Link] 2025/06/14
Creating Your Model Page 87 of 174
RULE R1 IF SIMULATION TIME > 8 THEN PUMP 12 STATUS = ON ELSE PUMP 12 STATUS = OFF ;
RULE R2A IF NODE 23 DEPTH > 12 AND LINK 165 FLOW > 100 THEN ORIFICE R55 SETTING = 0.5 RULE R2B IF NODE 23 DEPTH > 12 AND LINK 165 FLOW > 200 THEN ORIFICE R55
SETTING = 1.0 RULE R2C IF NODE 23 DEPTH <= 12 OR LINK 165 FLOW <= 100 THEN ORIFICE R55 SETTING = 0 ;
RULE R3A IF NODE N1 DEPTH > 5 THEN PUMP N1A STATUS = ON RULE R3B IF NODE N1 DEPTH > 7 THEN PUMP N1B STATUS = ON RULE R3C IF NODE N1 DEPTH <= 3 THEN PUMP
N1A STATUS = OFF AND PUMP N1B STATUS = OFF
Note: Expected Units for control sets are as follows: Flow: cfs; Length: feet; Time: hours
Pollutant buildup and washoff on subcatchment areas are determined by the Land Uses assigned to those areas.
Input loadings of pollutants from external and dry weather inflows are supplied through time series data associated with particular nodes of the collection system.
Access this dialog box by selecting Components > SWMM Extensions > Pollutants.
This dialog box contains a toolbar, a list pane on the left that displays all of the pollutants that have been defined in the current model, and the attribute fields on the right that
permit the values to be defined for the pollutant that is currently highlighted in the list pane. The toolbar contains the following buttons:
Delete Deletes the entry that is currently highlighted in the Pollutant List Pane.
Rename Lets you rename the entry that is currently highlighted in the Pollutant List Pane.
Report Lets you generate a preformatted report that contains the input data associated with the entry that is currently highlighted in the Pollutant List
Pane.
The attribute fields along the right side of the dialog box include:
Rain Concentration Lets you define the concentration of the pollutant in rain water for the currently highlighted pollutant.
Groundwater Lets you define the concentration of the pollutant in groundwater for the currently highlighted pollutant.
Concentration
Decay Coefficient Lets you define the first-order decay coefficient for the currently highlighted pollutant.
Co-Pollutant Lets you define the name of another pollutant runoff concentration the current pollutant is dependent on for the currently highlighted
pollutant.
Co-Fraction Lets you define the fraction of the co-pollutant's runoff concentration that contributes to the runoff concentration for the currently
highlighted pollutant.
I & I Concentration Lets you define the concentration of the pollutant in any Infiltration/Inflow.
[Link] 2025/06/14
Creating Your Model Page 88 of 174
18. In the SWMM Extended Data section of the Property Editor, click the Pollutographs field, then click the Ellipses (...) button.
19. In the Pollutograph Collection dialog box, add pollutographs to the pollutograph collection by performing these steps:
20. Click the New button to add a row to the Pollutograph table.
21. Click the down arrow in the first row then select an existing pollutograph. If there are no pollutographs in your model, you can click the Ellipses (...) button to display the
Pollutographs dialog box, where you can create new pollutographs.
22. Repeat Steps a and b for every pollutograph you wish to add to the collection.
23. Press OK to close the dialog box and add the collection to the node.
24. Complete your model, then click the Compute button on the Compute toolbar.
25. When the model has been successfully computed, open the Property Editor for the node the contains the Pollutograph Collection.
26. In the Results section of the Property Editor, click the Ellipses (...) button in the Pollutants field to view pollutant results.
This dialog box contains a toolbar, a list pane on the left that displays all of the pollutographs that have been defined in the current model, and attribute fields on the right that
let you enter values for the pollutograph that is currently highlighted in the list pane.
New Opens a submenu containing the following options: Mass —Lets you create a plot of time vs. mass rate. Concentration —Lets you create a plot of
time vs. concentration.
Delete Deletes the currently-highlighted pollutograph from the list pane.
Report Lets you generate a preformatted report that contains the input data associated with the currently-highlighted pollutograph.
The attribute fields along the right side of the dialog box include:
Pollutant Lets you select the pollutant for the pollutograph. Select the pollutant from the drop-down menu or click the Ellipses (...) button to open the
SWMM Pollutants dialog box, where you can define new pollutants.
New This button adds a new row to the pollutograph table.
Delete This button removes the current row from the pollutograph table.
Report Displays a report of the data in the pollutograph table.
Graph Displays a plot of the data in the pollutograph table.
Mass Conversion Lets you enter a mass conversion factor. . This field is available only for pollutographs using mass as the constituent inflow type.
Factor
Pollutograph Table Lets you define the pollutograph by entering Time vs. Mass Rate points for pollutographs using mass as the constituent inflow type, or Time vs.
Concentration points for pollutographs using concentration as the constituent inflow type.
There is also a status bar located at the bottom of the dialog box that displays any errors and warnings that may occur when you enter data.
• New: Adds a new row to the Pollutograph table. Click in the row to select a pollutograph from the drop-down menu, or click the Ellipses (...) button to create new
pollutographs.
• Delete: Deletes the current row from the table.
• Report: Lets you view a report of the collection.
Pollutograph Table: Displays the pollutographs you have added to the collection. You add a pollutograph to the collection by clicking the New button, then selecting a
pollutograph from the drop-down menu in the table row.
The Pollutants Results dialog box contains a list pane on the left that displays all the pollutants assigned to the selected node, and a two tabs on the right:
Time vs. Concentration Tab Displays a plot of Concentration over Time for each pollutant displayed in the list pane.
Data Tab Displays the time (hours by default) vs. concentration (ppm by default) data points for each pollutant displayed in the list pane.
[Link] 2025/06/14
Creating Your Model Page 89 of 174
You have complete freedom in defining land uses and assigning them to catchment elements. One approach is to assign a mix of land uses to each subcatchment, in which case
all land uses in the subcatchment will have the same pervious/impervious characteristics. If this is not appropriate, the user can create subcatchments that have just a single land
use classification along with a set of pervious/impervious characteristics that reflects the classification.
Access this dialog box by selecting Components > SWMM Extensions > Land Uses.
This dialog box contains a toolbar, a list pane on the left that displays all of the land uses that have been defined in the current model, and three tabs on the right that together
permit the values to be defined for the land use that is currently highlighted in the list pane.
Delete Deletes the entry that is currently highlighted in the Land Use List Pane.
Rename Lets you rename the entry that is currently highlighted in the Land Use List Pane.
Report Lets you generate a preformatted report that contains the input data associated with the entry that is currently highlighted in the Land Use List
Pane.
The buildup is usually given as mass of pollutant per unit area although they may be given as counts (in the case of coliforms) per unit curb length. Therefore B (and C1 in the
functions below) can be given as lbs/acre, kg/hectare, coliform/acre, lbs/ft curb length, etc. Time in the functions refers to the number of antecedent dry days. Buildup is only
used when the exponential washoff function is used to determine quality of runoff quality from catchments.
Three different functions can be used to describe buildup. The functions are all monotonically increasing. The figure below gives their relative shape.
The amount of buildup as a function of days of dry weather can be computed using one of the following functions:
[Link] 2025/06/14
Creating Your Model Page 90 of 174
• Power Function: Pollutant Buildup (B) accumulates proportional to time (t) raised to some power, until a maximum limit is achieved.
B = buildup, mass(count/area(length)
C 1 = maximum possible build-up, mass (count)/area(length)
C 2 = build-up rate
C 3 = time exponent
• Exponential Function: Buildup follows an exponential growth curve that approaches a maximum limit asymptotically.
B = buildup, mass(count)/area(length)
C 1 = maximum possible build-up, mass(count)/area(length)
C 2 = build-up rate constant, 1/day
• Saturation Function: Buildup begins at a linear rate which proceeds to decline constantly over time until a saturation value is reached.
B = buildup, mass(count)/area(length)
C 1 = maximum possible build-up, mass(count)/area(length)
C 2 = build-up rate constant, 1/day
[Link] 2025/06/14
Creating Your Model Page 91 of 174
Column Description
Pollutant This menu contains all of the pollutants that have been defined in the Pollutants dialog box for the current model. Select the one that should be
used for the land use currently highlighted in the list pane.
Max. Buildup This field allows you to define the value of C 1 in the above equations.
Rate Constant This field allows you to define C 2 in the Power and Exponential equations described above.
Buildup Function This menu allows you to specify which of the buildup functions described above will be used for the land use currently highlighted in the list
pane.
Power Constant This field allows you to define C 3 in the Power equation described above.
Half Saturation This field allows you to define C 2 in the Saturation equation described above.
Constant
Normalizer Allows you to specify the method by which pollutant buildup is described for the land use currently highlighted in the list pane. Choices include
Area (mass per unit of subcatchment area) or Curb (mass per unit of curb length).
Buildup Time The name of the Time Series that contains buildup rates (as mass per normalizer per day).
Series
Scaling Factor A multiplier used to adjust the buildup rates listed in the time series.
• Exponential Washoff: The washoff load (W) in units of mass per hour is proportional to the product of runoff raised to some power and to the amount of buildup
remaining.
C 1 = washoff coefficient
C 2 = washoff exponent
q = runoff rate per unit area
B = pollutant build-up in a mass per unit area or curb length
[Link] 2025/06/14
Creating Your Model Page 92 of 174
• Rating Curve Washoff: The rate of washoff W in mass per second is proportional to the runoff rate raised to some power.
C1 = washoff coefficient
C2 = washoff exponent
Q = runoff rate, cfs (m 3 /s)
• Event Mean Concentration (EMC): This is a special case of Rating Curve Washoff where the exponent (C2) is 1.0 and the coefficient C1 represents the concentration of any
and all runoff in mass per liter.
Column Description
Pollutant This menu contains all of the pollutants that have been defined in the Pollutants dialog box for the current model. Select the one that should be
used for the land use currently highlighted in the list pane.
Washoff This menu allows you to specify which of the buildup functions described above will be used for the land use currently highlighted in the list pane.
Function
Washoff This field allows you to define C 1 in the equations described above.
Coefficient
Washoff This field allows you to define C 2 in the Exponential and Rating Curve equations described above.
Exponent
Cleaning The fraction of available buildup for each pollutant removed by cleaning.
Efficiency
Removal Washoff loads for a given pollutant and land use category can be reduced by a fixed percentage by specifying a Removal Efficiency in this field
Efficiency which reflects the effectiveness of any BMP controls associated with the land use.
[Link] 2025/06/14
Creating Your Model Page 93 of 174
New Adds a new row to the Land Uses table. Each row in the table contains a single land use entry.
Delete Deletes the current row from the Land Uses table.
The Land Uses Collection dialog box also contains a table with the following columns:
Column Description
Catchment Land Use Lets you select a land use entry to include in the collection. Click in the row to select a land use entry from the drop-down menu, or click
the Ellipses (...) button to create new land uses.
Percent of Catchment Lets you specify the percent of the catchment area affected by the land.
Area (%)
A treatment expression involves the pollutant concentration of the mixture of all flow streams entering the node (use the pollutant name to represent a concentration), or the
removal of other pollutants (use R_ prefixed to the pollutant name to represent removal).
R = f(P, R_P, V)
or
C = f(P, R_P, V)
Where:
R = fractional removal
C = outlet concentration
R_P = one or more pollutant removals, (add R_ to the front of the pollutant name)
• FLOW for flow rate into node (in user-defined flow units)
• DEPTH for water depth above node invert (ft or m)
• AREA for node surface area (ft2 or m2)
• DT for routing time step (sec)
• HRT for hydraulic residence time (hours)
The result of the treatment function can be either a concentration (denoted by the letter C) or a fractional removal (denoted by R). For example, a first-order decay expression
for BOD exiting from a storage node might be expressed as:
C = BOD * exp(-0.05*HRT)
or the removal of some trace pollutant that is proportional to the removal of total suspended solids (TSS) could be expressed as:
R = 0.75 * R_TSS
Note: Make sure you set the Engine Type to Explicit (SWMM 5) in the Calculation Options for your model before computing results.
1. Add a node to your model or select an existing node, then display the Property Editor for the node (double-click the node or press F4).
2. In the SWMM Extended Data section of the Property Editor, set Apply Treatment? to True. The Treatment field becomes available.
3. Click the Ellipses (...) button in the Treatment field (where "<Collection: 0 items>" is displayed) to display the Treatment Collection dialog box.
4. The Treatment Collection dialog box displays each pollutant and its associated treatment expression as a row in a table. Click the New button to add a row to the table.
5. Click in the Pollutant field, then select an existing pollutant from the drop-down menu, or click the Ellipses (...) button to display the Pollutants dialog box, where you
define pollutants in your model.
6. Type a treatment expression in the Treatment column.
7. Repeat Steps 4 - 6 for each pollutant you wish to add to the treatment collection.
8. Click OK to close the dialog box and add the collection to the node.
The Treatment Collection dialog box lets you add multiple pollutants and their associated treatment expressions to a node for the purpose of removing pollutants in your model.
You access this dialog box from the SWMM Extended Data section of the Property Editor for the selected node.
[Link] 2025/06/14
Creating Your Model Page 94 of 174
New Adds a new row to the Pollutants table. Click in the row to select an existing pollutant from the drop-down menu, or click the Ellipses (...) button to
define new pollutants.
Delete Deletes the current row from the table.
Column Description
Pollutant Lets you add a pollutant to the collection. Click the down-arrow to select an existing pollutant from the drop-down menu, or click the Ellipses (...) button
to define new pollutants.
Treatment Lets you type a valid treatment expression to the pollutant.
LID controls help developed watersheds or sites to retain or enhance pre-development hydrologic characteristics through the use of techniques that conserve natural systems
and hydrologic functions.
A number of government agencies, universities, and other groups publish educational information, research and design guidance for implementing LID and LID controls. Places
to start include:
• U.S. Environmental Protection Agency's Low Impact Development website and fact sheet on Low Impact Development (LID) and Other Green Design Strategies
• Low Impact Development Center
• Low Impact Development (LID) Urban Design Tools Website
[Link] 2025/06/14
Creating Your Model Page 95 of 174
Events allow the user to set up ranges of time, typically the periods of large storms, to run the full hydraulic analysis of the system. With events, the simulation runs much faster
as it skips over the analysis of the system during time periods not explicitly defined.
Users can setup events in the calculation options, when the active solver is the SWMM engine.
Simply select the "Hydraulic Calculation Events" property in the property grid, and click the "…" button.
Note: Only hydraulic calculations are ignored outside the range of specified events. Full hydrologic calculations are performed.
LID controls help developed watersheds or sites to retain or enhance pre-development hydrologic characteristics through the use of techniques that conserve natural systems
and hydrologic functions.
A number of government agencies, universities, and other groups publish educational information, research and design guidance for implementing LID and LID controls. Places
to start include:
• U.S. Environmental Protection Agency's Low Impact Development website and fact sheet on Low Impact Development (LID) and Other Green Design Strategies
[Link] 2025/06/14
Creating Your Model Page 96 of 174
1. Add generic LID controls to the model. This is done in the ”Low Impact Development Controls Manager’.
2. Add LID and catchment elements to the network drawing (see ”Low Impact Development Controls’).
3. Enter element-specific LID control and catchment data in the Properties pane. LID control attributes include designating a Parent Catchment and associating a generic LID
(created in step 1). For additional details, see Low Impact Development Controls.
4. If the LID Control Type include an Underdrain Layer, then select a Underdrain Outflow Element to receive any underdrain flow from the LID.
5. Any excess surface flow from the LID will drain to the Parent Catchment. Option for the LID to send this surface outflow to the Impervious portion of the Parent
Catchment or to the runoff collection point of the catchment.
6. Then continue with the modeling the remainder of the model as normal (e.g., enter remaining network and rainfall data, configure storm data, run the model, review
results).
Implementation Notes
• Low-Impact Development (LID) controls as implemented in the software are based on the calculation methods used in EPA SWMM Version 5.1.012.
• LID elements can only be paired with catchments which use the EPA-SWMM or Time Area Runoff Methods.
• Only the hydrologic performance is modeled-pollutant removal impacts are not considered.
• A LID control element must be associated with a Parent Catchment. The Parent Catchment is the source of stormwater input to the LID control, and also receives
discharge from the LID.
• The effect of a LID control on runoff is seen in the computed hydrograph for the LID control's Parent Catchment.
• Bioretention cells include facilities such as rain gardens, planters, and green roofs. They typically consist of surface storage and vegetation, and an engineered soil layer
with a gravel drainage layer beneath it. The gravel layer may include an underdrain system.
• Infiltration trenches are trenches filled with gravel that can store stormwater in void spaces while it infiltrates into surrounding soils. There may also be an underdrain
system.
• Porous pavement consists of a surface pavement layer (may be continuous porous pavement or block pavers) over a layer of gravel. The porous surface allows
stormwater to enter and be stored in the gravel layer while it infiltrates into surrounding soils. The gravel layer may include an underdrain system.
• Rain barrels are containers that collect runoff from roofs. The captured stormwater can be released at a controlled rate later, or used for irrigation. (Cisterns are also
modeled using the "rain barrel" LID control type.)
• Vegetative swales are channels or depressions covered with vegetation. They allow time for a portion of intercepted stormwater to infiltrate the soil.
See Also
The model performs a moisture balance that tracks how much water moves between the layers and how much is stored within each layer. The figure below illustrates the
processes considered for a bioretention cell or porous block pavement system.
[Link] 2025/06/14
Creating Your Model Page 97 of 174
The physical and performance characteristics of LID controls are defined in the ”Low Impact Development Controls Manager’ on a per-unit-area basis. Thus, the same LID
control design can easily be used in multiple locations in the network, over differently sized areas.
The interaction between Parent Catchment area and LID Control area can be summarized with the following figure:
The design of the control is made on a per-unit-area basis so that it can be placed in any number of subcatchments at different sizes or number of replicates. The editor consists
of a list pane on the left that displays all of the LID controls that have been defined for the model and a tabbed input data area on the right that displays attributes for the
selected LID control.
[Link] 2025/06/14
Creating Your Model Page 98 of 174
New Creates a new inlet definition in the list pane on the left.
Report Lets you generate a preformatted report that contains the input data associated with the currently
highlighted LID control.
Synchronization Options
Clicking this button opens a submenu containing the following commands:
• Browse Engineering Library—Opens the Engineering Library manager dialog, allowing you to browse
the LID control libraries.
• Synchronize From Library—Lets you update a set of LID control definitions previously imported from
one of the LID control libraries. The updates reflect changes that have been made to the library since it
was imported.
• Synchronize To Library—Lets you update one of the existing LID control libraries using current data
that was initially imported but have since been modified.
• Import From Library—Lets you import a LID control definition from one of the existing LID control
libraries.
• Export To Library—Lets you export the current LID control definition to one of the existing LID control
libraries.
• Connect to Library—Lets you create a connection between the LID control definition and the specified
engineering library.
The sections and fields that appear on the Low Impact Development Control tab depend on which control type (see ”LID Control Types’) is chosen. Each section of this tab (e.g.,
Surface, Storage, etc.) corresponds to a layer in the LID control (see ”Hydrologic Model Representation of LID Controls’). The table below summarizes which layers are available
for each LID control:
• Low Impact Development Control Type: Allows you to select the type of LID Control.
• Soil Layer Attributes
The pavement layer attributes are only available when the "Porous Pavement" LID Control Type is selected.
• Pavement Thickness: The thickness of the pavement layer (inches or mm). Typical values are 4 to 6 inches (100 to 150 mm).
• Pavement Void Ratio: The volume of void space relative to the volume of solids in the pavement for continuous systems or for the fill material used in modular systems.
Typical values for pavements are 0.12 to 0.21. Note that porosity = void ratio / (1 + void ratio).
• Impervious Surface Fraction: Ratio of impervious paver material to total area for modular systems; 0 for continuous porous pavement systems.
• Permeability: Permeability of the concrete or asphalt used in continuous systems or hydraulic conductivity of the fill material (gravel or sand) used in modular systems
(in/hr or mm/hr). The permeability of new porous concrete or asphalt is very high (e.g., hundreds of in/hr) but can drop off over time due to clogging by fine particulates
in the runoff.
• Pavement Clogging Factor: Number of pavement layer void volumes of runoff treated it takes to completely clog the pavement. Use a value of 0 to ignore clogging.
Clogging progressively reduces the pavement's permeability in direct proportion to the cumulative volume of runoff treated.
• If one has an estimate of the number of years it takes to fully clog the system (Yclog), the Clogging Factor can be computed as: Yclog * Pa * CR * (1 + VR) * (1 - ISF) / (T *
VR) where Pa is the annual rainfall amount over the site, CR is the pavement's capture ratio (area that contributes runoff to the pavement divided by area of the
pavement itself), VR is the system's Void Ratio, ISF is the Impervious Surface Fraction, and T is the pavement layer Thickness.
• As an example, suppose it takes 5 years to clog a continuous porous pavement system that serves an area where the annual rainfall is 36 inches/year. If the pavement is 6
inches thick, has a void ratio of 0.2 and captures runoff only from its own surface, then the Clogging Factor is 5 x 36 x (1 + 0.2) / 6 / 0.2 = 180.
[Link] 2025/06/14
Creating Your Model Page 99 of 174
• Storage Void Ratio: The volume of void space relative to the volume of solids in the layer. Typical values range from 0.5 to 0.75 for gravel beds. Note that porosity = void
ratio / (1 + void ratio).
• Storage Conductivity: Hydraulic conductivity for the fully saturated soil (in/hr or mm/hr).
• Storage Clogging Factor: Total volume of treated runoff it takes to completely clog the bottom of the layer divided by the void volume of the layer. Use a value of 0 to
ignore clogging. Clogging progressively reduces the Filtration Rate in direct proportion to the cumulative volume of runoff treated and may only be of concern for
infiltration trenches with permeable bottoms and no under drains.
• Surface Layer Attributes
• The surface layer attributes are available for all LID Control Types except Rain Barrel.
• Surface Storage Depth: When confining walls or berms are present this is the maximum depth to which water can pond above the surface of the unit before overflow
occurs (in inches or mm). For LID controls that experience overland flow it is the height of any surface depression storage. For swales, it is the height of its trapezoidal
cross section.
• Vegetative Cover Fraction: The fraction of the storage area above the surface that is filled with vegetation (i.e., volume occupied by leaves, stems, etc.).
• Surface Manning’s n: Manning's n for overland flow over the surface of porous pavement or a vegetative swale. Use 0 for other types of LID controls.
• Surface Slope: Slope of porous pavement surface or vegetative swale (percent). Use 0 for other types of LID controls.
• Swale Side Slope: Slope (run over rise) of the side walls of a vegetative swale's cross section. This attribute is not present for other types of LID controls. If either Surface
Roughness or Surface Slope values are 0 then any ponded water that exceeds the storage depth is assumed to completely overflow the LID control within a single time
step.
• Underdrain Attributes
• An underdrain is available for all LID control types except Vegetative Swale. It is required for Rain Barrels, and optional for other LID controls.
• Drain Coefficient and Drain Exponent: C and exponent n that determines the rate of flow through the underdrain as a function of height of stored water above the drain
height. The following equation is used to compute this flow rate (per unit area of the LID unit):
• where q is outflow (in/hr or mm/hr), h height of stored water (inches or mm), and Hd is the drain height. If the layer does not have an underdrain then set C to 0. A typical
value for n would be 0.5 (making the drain act like an orifice). A rough estimate for C can be based on the time T required to drain a depth D of stored water. For n = 0.5, C
= 2D1/2/T.
• Drain Offset Height: Height Hd of any underdrain piping above the bottom of a storage layer or rain barrel.
• Drain Delay: The number of dry weather hours that must elapse before the drain line in a rain barrel is opened (the line is assumed to be closed once rainfall begins). This
parameter is only available with Rain Barrels.
Notes Tab
This tab contains a text field that allows you to enter descriptive notes that will be associated with the currently highlighted LID control.
Library Tab
This tab displays information about the LID control that is currently highlighted in the list pane. If the LID control is derived from an engineering library, the synchronization
details can be found here. If the LID control was created manually for this model, the synchronization details will display the message Orphan (local), indicating that the LID
control was not derived from a library entry.
LID Validations
Network Connectivity:
LID areas can only link to a single Parent Catchment. A catchment may have its runoff pre-treated by one or many LID Control elements.
Underdrain Connections: LID's Undrain Outflow Element can be the Parent Catchment or its Outflow Element. The underdrain flow can be sent to most nodes, including
boundary nodes and ponds. If not designated, underdrain flow will route along with its surface overflow to the Parent Catchment.
LIDs and Run-On: With the Explicit (SWMM) solver, outflow from LID can run-on to a downstream catchment area via an outfall node element. For the 'Route to Catchment'
attribute of the outfall, select the downstream catchment. Then set the outfall as the 'Underdrain Outflow Element' of the LID. The can also be accomplished with surface runoff
by setting LID to return flow to the catchment's outlet, and declaring the outfall as the parent catchment's outflow element.
Valid Values:
If the values set for the following attributes fall outside the specified valid range, an error or user notification will be generated.
[Link] 2025/06/14
Creating Your Model Page 100 of 174
Catchment Runon
Inflow to a catchment can be in the form of direct runon from another catchment or upstream stormwater subsystem. With the Explicit (SWMM) solver opt to have a link
outflow onto a catchment via the 'Route to Catchment' option on an Outfall element. Alternatively, By simply declaring the Outflow Element of a catchment to be another
catchment, overland flow can runon to a downstream catchment. However, this configuration is only possible amongst two catchments which each utilize the EPA-SWMM
Runoff Method.
• "Adding a Hyperlink"
• "Deleting a Hyperlink"
To use hyperlinks, select Tools > Tools > More... > Hyperlink. The Hyperlink dialog box opens.
The hyperlink tool enables the user to associate a photo, word processing document, spreadsheet or other file with a given model element. Opening the hyperlink opens the file
using its associated program (Picture Manager, Word, Excel, etc.).
The hyperlink can also be opened from the Property grid by picking the Hyperlink property from the grid and clicking the ellipse button which will open the hyperlink tool.
If a model file is moved to a different computer, the hyperlink will no longer work unless the associated file is moved to a comparable path on the same computer.
The Hyperlinks dialog contains a toolbar and a tabular view of all your existing hyperlinks.
New Lets you create a new hyperlink. Launches the Add Hyperlink dialog box.
Edit Lets you edit the currently highlighted hyperlink. Launches the Edit Hyperlink dialog box.
Launch Launches the external file associated with the currently highlighted hyperlink.
Column Description
Element Type Displays the element type of the element associated with the hyperlink.
Element Displays the label of the element associated with the hyperlink.
[Link] 2025/06/14
Creating Your Model Page 101 of 174
Column Description
Link Displays the complete path of the hyperlink.
Description Displays a description of the hyperlink, which you can optionally enter when you create or edit the hyperlink.
Adding a Hyperlink
Editing a Hyperlink
Deleting a Hyperlink
Adding a Hyperlink
To add a hyperlink:
Note: You can add more than one associated file to an element using the hyperlink feature, but you must add the associations one at a time.
1. Click Tools > Tools > More... > Hyperlink. The Hyperlink dialog box opens.
2. Click Add to add a hyperlink. The Add Hyperlink dialog box opens.
3. Select the element to which you want to associate an external file.
4. Browse to the external file you want to use. This might be something like a picture of the element or a movie about the element.
You create new hyperlinks in the Add Hyperlink dialog box. The dialog box contains the following controls:
Element Lets you select an element type from the drop-down list.
Type
Element Lets you select an element from a drop-down list of specific elements from your model. Only those element types selected in the Element Type drop-
down list are displayed.
Link The complete path of the external file you want to associate with the selected element. You can type the path yourself or click the Ellipsis (...) button to
search your computer for the file. Once you have selected the file, you can test the hyperlink by clicking the Launch button.
Description Lets you type a description of the hyperlink.
Editing a Hyperlink
You can edit existing hyperlinks using the Edit Hyperlink dialog box.
To edit a hyperlink:
1. Click Tools > Tools > More... > Hyperlink. The Hyperlink dialog box opens.
2. Select the hyperlink you want to edit.
3. Click Edit to modify a hyperlink. The Edit Hyperlink dialog box opens.
4. Select the element you want to edit.
5. Edit the hyperlink by adding or deleting an associated file.
You edit existing hyperlinks in the Edit Hyperlink dialog box. The dialog box contains the following controls:
Link Lets you edit the complete path of the external file associated with the selected hyperlink. You can type the path yourself or click the Ellipsis (...) button
to search your computer for the file. Once you have selected the file, you can test the hyperlink by clicking the Launch button.
Description Lets you edit an existing description of the hyperlink or type a new description.
Deleting a Hyperlink
To delete a hyperlink:
1. Click Tools > Tools > More... > Hyperlink. The Hyperlink dialog box opens.
2. Select the hyperlink you want to edit.
3. Click Edit to modify a hyperlink. The Edit Hyperlink dialog box opens.
4. Select the element you want to delete.
5. Click Delete.
[Link] 2025/06/14
Creating Your Model Page 102 of 174
Queries Manager
The Queries Manager is a docking manager that displays all queries in the current model, including predefined, shared, and model queries. You can create, edit, or delete shared
and model queries from within the Queries Manager, as well as use it to select all elements in your model that are part of the selected query.
Note that element types that are not used in the current model are marked with an icon
The Queries Manager consists of a toolbar and a tree view, which displays all of the queries that are associated with the current model. The toolbar contains the following
buttons:
New Contains the following commands: Query —Lets you create a new SQL expression as either a model or shared query, depending on which
item is highlighted in the tree view. Folder —Creates a folder in the tree view, allowing you to group queries. You can right-click a folder
and create queries or folders in that folder.
Delete Deletes the currently-highlighted query or folder from the tree view. When you delete a folder, you also delete all of its contents (the
queries it contains).
Rename Lets you rename the query or folder that is currently highlighted in the tree view.
Edit Opens the Query Builder dialog box, allowing you to edit the SQL expression that makes up the currently-highlighted query.
Expand All and Expands or collapses the named views and folders.
Collapse All
Select in Lets you quickly select all the elements in the drawing pane that are part of the currently highlighted query. Once you have selected the
Drawing elements in a selection set using Select In Drawing, you can delete them all at once.
Help Displays online help for the Queries Manager.
Creating Queries
A query is a valid SQL expression that you construct in the Query Builder dialog box. You create and manage queries in the Queries Manager. You also use queries to filter
FlexTables and as the basis for a selection set.
[Link] 2025/06/14
Creating Your Model Page 103 of 174
7. Double-click the field you wish to include in your query. The database column name of the selected field appears in the preview pane.
8. Click the desired operator or keyword button. The SQL operator or keyword is added to the SQL expression in the preview pane.
9. Click the Refresh button above the Unique Values list pane to see a list of unique values available for the selected field. Note that the Refresh button is disabled after you
use it for a particular field (because the unique values do not change in a single query-building session).
10. Double-click the unique value you want to add to the query. The value is added to the SQL expression in the preview pane. You can also manually edit the expression in
the preview pane.
11. Check the Validate box above the preview pane to validate your SQL expression when the query is applied.
12. Click the Apply button above the preview pane to execute the query. If the expression is valid, the word "VALIDATED" is displayed in the lower right corner of the dialog
box.
13. Click OK.
You construct the SQL expression that makes up your query in the Query Builder dialog box. The Query Builder dialog box is accessible from the Queries Manager and from
within a FlexTable.
The top part of the dialog box contains all the controls you need to construct your query: a list pane displaying all available attributes for the selected element type, a SQL
control panel containing available SQL keywords and operators, and list view that displays all the available values for the selected attribute. The bottom part of the dialog box
contains a preview pane that displays your SQL expression as you construct it.
All the dialog box controls are described in the following table.
Fields Lists all input and results fields applicable to the selected element type. This list displays the labels of the fields, while the underlying database
column names of the fields become visible in the preview pane when you add them to the expression. Double-click a field to add it to your SQL
expression.
SQL These buttons represent all the SQL operators and controls that you can use in your query. They include = , > , < , _ , ? , * , <> , >= , <= , [ ] , Like ,
Controls And , and Or . Click the appropriate button to add the operator or keyword to the end of your SQL expression, which is displayed in the preview
pane.
Unique When you click the Refresh button, this list displays all the available unique values selected field. Double-click a value in the list to add it to the end
Values of your SQL expression, which is displayed in the preview pane. If you select a different field, you must click the Refresh button again to update the
list of unique values for the selected field. When you first open the Query Builder dialog box, this list is empty.
Refresh Updates the list of unique values for the selected field. This button is disabled after you use it for a particular field.
Copy Copies the entire SQL expression displayed in the preview pane to the Windows clipboard.
Paste Pastes the contents of the Windows clipboard into the preview pane at the location of the text cursor. For example, if your cursor is at the end of
the SQL expression in the preview pane and you click the Paste button, the contents of your clipboard will be added to the end of the expression.
[Link] 2025/06/14
Creating Your Model Page 104 of 174
Validate Validates the SQL expression in the preview pane. If the expression is not valid, a message appears. When you click this button and your SQL
expression passes validation, the word "VALIDATED" appears in the lower right corner of the dialog box.
Apply Executes the query. The results of the query are displayed at bottom of the Query Builder dialog box in the form “ x of x elements returned.”
Preview Displays the SQL expression as you add fields, operators and/keywords, and values to it.
Pane
1. Create a query to isolate the group of objects. (Go to View > Query > Create a New Query under Query - Hydraulic Model)
2. Query for All Conduits with Diameter>12 inches.
3. Now go to the Conduit Flex Tables.
4. Right Click on any Column and Choose Filter By Query.
5. Choose the Newly Created Query.
6. The Flex Table will now display only the Group of Conduits with Diameter >12 inches.
Controls
Controls in the GVF Solver give the user a way to specify an action for virtually any element in a pressure subnetwork based on almost any property of the system. Controls are
included in a scenario when the control set they are included in is specified in the Operational Alternative. The controls become part of an Operational Alternative when you
specify the name of a Control Set to use in a given Operational Alternative. The default control set is "All control statements".
The Control Manager is the main work center for controls. The Control Manager manages all controls, conditions, actions, and control sets in the system. The Control manager
allows the user to define controls using advanced IF, AND, and OR condition logic, which can trigger any number of THEN or optional ELSE actions.
Controls Tab
Conditions Tab
Actions Tab
Control Sets Tab (GVF-Convex Solver)
Controls in the GVF-Convex Solver
[Link] 2025/06/14
Creating Your Model Page 105 of 174
Controls Tab
The Controls tab allows you to manage all controls defined in the system. Controls can be one of two types: simple or logical. Simple controls are made up of an IF condition and
a THEN action statement. Logical controls are made up of an IF condition, a THEN action, and an optional ELSE action, and can be assigned a priority for resolving potential
conflicts between logical controls.
Controls, Conditions, and Actions are assigned a non-editable application-provided ID (e.g., LC01).
• The pane in the center of the dialog box is the Controls List. This list displays a list of all Logical Controls defined in the system.
• Located above the Controls List is a toolbar with the following buttons:
• New—Creates a new control.
• Delete—Deletes the highlighted control.
• Duplicate—Opens a submenu with the following options:
◦ Duplicate (Full - create new conditions and actions)
◦ Duplicate (Partial - use existing conditions and actions)
• Control Sets—Edits Control Sets. Click the dropdown for additional options:
◦ Control Sets: Opens the Control Sets Editor dialog box.
◦ Edit Control Sets...: Opens the Control Sets Editor dialog box with the table populated by sets that include the currently selected control.
◦ Add/Remove Control Sets: Opens the Add/Remove Control Sets dialog box, allowing you to add, remove, and manage your control sets.
“Edit Control Sets for <selected-controls>”, and “Add/Remove Control Sets.
• Control Wizard—Opens the Control Wizard dialog.
• Import Controls—Allows you to select a control file (.ctl) to import.
• Export Controls—Allows you to export the current controls to a control file (.ctl).
• Report—Generates a summary of the selected control, listing the ID, conditions, actions, and elements incorporated into the control.
• Help—Opens the online help.
• Below the toolbar is a set of filters that allow you to only display controls that meet criteria defined by the filter settings. The following filters are available:
• Type—When a Type filter other than <All> is specified, only controls of that type will be displayed in the Controls list.
• Priority—When a Priority filter other than <All> is specified, only controls of that priority will be displayed in the Controls list.
• Condition Element—When a Condition filter other than <All> is specified, only controls containing the selected Condition element will be displayed in the Controls list. You
can filter the available conditions to include only conditions that are applicable to the element or elements that are currently selected in the drawing pane by selecting the
<Current Selection> option.
• Action Element—When an Action filter other than <All> is specified, only controls containing the selected Action element will be displayed in the Controls list. You can
filter the available actions to include only actions that are applicable to the element or elements that are currently selected in the drawing pane by selecting the <Current
Selection> option.
Note: You can selected one or more controls in the list, and then right-click to “Edit Control Sets for Selected Controls”.
You can edit or create controls consisting of an IF condition, a THEN action, and an optional ELSE action. The lower pane is split into sections:
Note: At calculation time, the priority is used to determine the logical control to apply when multiple controls require that conflicting actions be taken. Logical controls with
identical priorities will be prioritized based on the order they appear in the Logical Control Set alternative. A rule without a priority value always has a lower priority than one
with a value. For two rules with the same priority value, the rule that appears first is given the higher priority.
Relative speed pump patterns take precedence over any controls (simple or logical) that are associated with the [Link] the mouse cursor over a control in the list will
open a tooltip which displays the conditions and actions that make up that [Link] creating a new condition or action for a new control, the condition and action input
fields will be initialized with the data used in the last condition or action that was created. Once created, the Logical Control will be assigned an application generated ID (e.g.,
LC04).
• Description—This area is preset with a default description. There is an option to change the default description. To do so, turn on to activate the description field, and
enter your description in the text box.
• Summary—This area of the dialog box displays a description of the control.
• Status Pane—When one or more filters are active, the lower left corner of the dialog will show the number of controls currently displayed out of the number of total
controls. Additionally, a FILTERED flag is displayed in the lower right corner.
Note: Logical Controls are not executed during Steady State analyses.
Logical controls consist of any combination of simple conditions and simple actions. Controls are defined as:
IFCondition 1 AND condition 2 OR condition 3 AND condition 4, etc., where condition X is a a condition [Link] 1 AND action 2, etc. where action X is an action
[Link] (Optional)Action 3 AND action 4, etc. where action X is an action [Link] (Optional)Priority where priority is a priority value (1 to 5, 5 being the highest
priority).
In addition to the high level of flexibility provided by allowing multiple conditions and actions, the functionality of Logical controls is also enhanced by the range of Condition
types that are available. You can activate the stated actions based on element loads, element hydraulic grade or pressure, system load, clock time, time from start, tank level, or
time to fill or drain a tank.
The user can also create composite conditions and actions that can cause actions to be performed when multiple conditions are met simultaneously, or when one or the other
conditions are met. The user can also activate multiple actions when a single condition is met.
To create a logical control in which a pump (PMP-1) is turned on when the level in a Wet Well (WW-1) falls below a specified value (5 ft.) or when the system loads exceed a
certain level (5000 gpm):
Conditions—Because this control needs to be triggered by multiple conditions, a Composite Condition is chosen. In this instance, the operator OR is chosen to link the
conditions, because the pump should be turned on if either condition is [Link] condition—{WW-1 Level < 5 ft.}OR condition—{System Load > 5000 gpm}Actions—Because this
control has a single desired outcome if one of the conditions is met, a simple action is chosen. The first action in a logical control is always linked to the conditions by a logical
THEN statement. In this instance, an ELSE action will also be used, to keep the pump off if neither of the conditions is [Link] action—{PMP-1 Status = On}ELSE
action—{PMP-1 Status = Off}The finished logical control looks like this:IF {WW-1 Level < 5 ft.} OR {System Load > 5000 gpm} THEN {PMP-1 Status = On} ELSE {PMP-1 Status = Off}
[Link] 2025/06/14
Creating Your Model Page 106 of 174
Use the optional ELSE field to cause actions to be performed when the conditions in the control are not being met. For example, if you are creating a control that states, "If the
level in WW 1 is less than 5 ft., Then turn Pump 1 On," use an ELSE action to turn the pump off if the tank level is above 5 ft.
Note: Logical Controls are not executed during Steady State analyses.
When defining a logical control, you have the option to share conditions and/or actions. In other words, more than one control can reference the same condition or action. Keep
in mind that when you change an underlying condition or action, it will affect all controls that reference that condition or action.
Conditions Tab
Conditions allow you to define the condition that must be met prior to taking an action. The Conditions tab provides a list of all conditions defined in the system. There are two
types of conditions: simple conditions and composite conditions.
• The pane in the middle of the dialog box is the Conditions list. The Conditions list displays a list of all logical controls defined in the system. The list contains three
columns: ID (the application-defined ID, e.g. C01 for simple, CC01 for composite), Type (simple or composite), and description.
• Located above the Conditions list is a toolbar with the following buttons:
◦ New: Create a simple or composite condition.
◦ Duplicate: Copy the selected condition.
◦ Delete: Remove the selected condition.
◦ Refresh: Refreshes the selected condition.
◦ Report: Generates a summary of the selected condition.
• Below the toolbar is a set of filters that allow you to only display controls that meet criteria defined by the filter settings. The following filters are available:
◦ Control Set: When a Control Set is specified, only conditions that are a component of that control set are displayed in the Conditions list.
◦ Type: When a Type filter other than <All> is specified, only conditions of that type will be displayed in the Conditions list.
◦ Condition Element: When a Condition filter other than <All> is specified, only conditions containing the selected Condition element will be displayed in the
Conditions list.
• The controls used to create or edit a condition vary depending on whether the condition is simple or composite.
Note: You can filter the available conditions to include only conditions that are applicable to the element or elements that are currently selected in the drawing pane by
selecting the <Current Selection> option.
Simple Conditions
The input fields for a simple condition change depending on the condition type that is selected in the condition Type field. The Simple Condition Types and the corresponding
input data are as follows:
• Element: This will create a condition based on specified attributes at a selected element. The field available when this condition type is specified is as follows:
◦ Element: The Element field allows you to specify which element the condition will be based upon, and provides 3 methods of choosing this element: the drop-down
list displays elements that have been used in other logical controls; the ellipsis (...) button which opens the Single Element Selection dialog box; and the Select From
Drawing button which allows you to select the element using the graphical Drawing View.
• Attribute: This field displays the available attributes for the element type currently specified in the Element field.
◦ Pressure Junctions: The following attributes are available for use when a Junction is chosen in the Element field:
◾ Demand: This attribute is used to create a condition based on a specified demand at the corresponding junction (e.g., If J-1 has a demand...).
◾ Hydraulic Grade: This attribute is used to create a condition based on a specified hydraulic grade at the corresponding junction (e.g., If J-1 has a hydraulic
grade of...).
◾ Pressure: This attribute is used to create a condition based on a specified pressure at the corresponding junction (e.g., If J-1 has a pressure of...).
◦ Pumps: The following attributes are available for use when a Pump is chosen in the Element field:
◾ Discharge: This attribute is used to create a condition based on a specified rate of discharge at the corresponding pump (e.g., If PMP-1 has a discharge of...).
◾ Setting: This attribute is used to create a condition based on the Relative Speed Factor of the corresponding pump (e.g., If PMP-1 has a relative speed factor
of 1.5...).
◾ Status: This attribute is used to create a condition based on the status (On or Off) of the corresponding pump (e.g., If PMP-1 is On...).
Note: Relative Speed Pump patterns take precedence over any controls (Simple or Logical) that are associated with the pump.
◦ Tanks: The following attributes are available for use when a Tank is chosen in the Element field.
◾ Demand: This attribute is used to create a condition based on a specified demand at the corresponding tank. For tanks, this demand can represent an inflow
or outflow (e.g., If T-1 has a demand...).
◾ Hydraulic Grade: This attribute is used to create a condition based on a specified hydraulic grade at the corresponding tank (e.g., If T-1 has a hydraulic grade
of...).
◾ Pressure: This attribute is used to create a condition based on a specified pressure at the corresponding tank (e.g., If T-1 has a pressure of...). Note that tank
pressure is calculated referenced from the tank base elevation and that the generic elevation field for tanks is not considered. This is done to allow the
modeling of elevated tanks. For non-elevated tanks elevation is the base elevation.
◾ Level: This attribute is used to create a condition based on a specified water level at the corresponding tank (e.g., If the water in T-1 is at a level of...).
◾ Percent Full: This attribute is used to create a condition based on a specified percentage of the tank that is full.
◾ Time to Drain: This attribute is to create a condition based on the amount of time required for the tank to drain (e.g., If T-1 drains in X hours...).
◾ Time to Fill: This attribute is to create a condition based on the amount of time required for the tank to fill (e.g., If T-1 fills in X hours...).
◦ Reservoirs: The following attributes are available for use when a Reservoir is chosen in the Element field:
◾ Demand: This attribute is used to create a condition based on a specified demand at the corresponding reservoir. For reservoirs, this demand can represent
an inflow or outflow (e.g., If R-1 has a demand...).
◾ Hydraulic Grade: This attribute is used to create a condition based on a specified hydraulic grade at the corresponding reservoir (e.g., If R-1 has a hydraulic
grade of...).
◾ Pressure: This attribute is used to create a condition based on a specified pressure at the corresponding reservoir (e.g., If R-1 has a pressure of...).
◦ Pipes: The following attributes are available for use when a Pipe is chosen in the Element field.
◾ Discharge: This attribute is used to create a condition based on a specified rate of discharge at the corresponding pipe (e.g., If P-1 has a discharge of...).
◾ Status: This attribute is used to create a condition based on the status (Open or Closed) of the corresponding pipe (e.g., If P-1 is Open...).
◦ Valves: The following attributes are available for use when a valve is chosen in the Element field:
◾ Discharge: This attribute is used to create a condition based on a specified rate of discharge at the corresponding valve (e.g., If PRV-1 has a discharge of...).
Note: The Setting attribute is not available when a GPV is selected in the Element field.
◾ Setting: This attribute is used to create a condition based on the setting of the corresponding valve. The type of setting will change depending on the type of
valve that is chosen. The valves and their associated setting types are as follows:
PRV: Choosing the Setting attribute in conjunction with a PRV will create a condition based on a specified pressure at the PRV (e.g., If PRV-1 has a
pressure of...).
[Link] 2025/06/14
Creating Your Model Page 107 of 174
PSV: Choosing the Setting attribute in conjunction with a PRV will create a condition based on a specified pressure at the PRV (e.g., If PSV-1 has a
pressure of...).
PBV: Choosing the Setting attribute in conjunction with a PRV will create a condition based on a specified pressure at the PRV (e.g., If PBV-1 has a
pressure of...).
FCV: Choosing the Setting attribute in conjunction with a PRV will create a condition based on a specified rate of discharge at the PRV (e.g., If FCV-1
has a discharge of...).
TCV: Choosing the Setting attribute in conjunction with a PRV will create a condition based on a specified headloss coefficient at the PRV (e.g., If TCV-1
has a headloss of...).
◾ Status: This attribute is used to create a condition based on the status (Closed or Inactive) of the corresponding valve (e.g., If PRV-1 is Inactive...).
• System Demand: This will create a condition based on the demands for the entire system. The fields available when this condition type is selected are:
◦ Operator: This field allows you to specify the relationship between the Attribute and the target value for that attribute. The choices include Greater Than (>),
Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal To (<=), Equal To (=), or Not Equal To (<>).
◦ System Demand—This field lets you set a system-wide demand.
• Clock Time: This will create a condition based on the clock time during an extended period simulation. If the extended period simulation is for a period longer than 24
hours, this condition will be triggered every day at the specified time.
◦ Operator: This field allows you to specify the relationship between the Attribute and the target value for that attribute. The choices include Greater Than (>),
Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal To (<=), Equal To (=), or Not Equal To (<>).
• Time From Start: This will create a condition based on the amount of time that has passed since the beginning of an extended period simulation. The following fields are
available when this condition type is selected.
◦ Operator: This field allows you to specify the relationship between the Attribute and the target value for that attribute. The choices include Greater Than (>),
Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal To (<=), Equal To (=), or Not Equal To (<>).
• Target Value: This field's label will change depending on the attribute that is chosen. The value entered here is used in conjunction with the operator that is chosen to
determine if the condition has been met.
• Description: This area of the dialog box is preset with a default description. There is an option to change the default description. To do so, click the check box to activate
the description field, and enter your description in the text box. Additionally, the description field supports the following expandable masks:
◦ %# - ID
◦ %e - Element
◦ %a - Attribute
◦ %o - Operator
◦ %v - Value
◦ %u - Unit
Note: Click the description list box to select one of the predefined masks.
Aside from reducing the amount of data input, using these masks provides the additional benefit of automatically updating the corresponding information when changes are
made to the various condition components.
Summary: This area of the dialog box displays an automatically updated preview of the expanded description.
Composite Conditions
When a Composite Condition is being defined or edited, the lower part of the dialog box is comprised of a two column table and two buttons. The buttons are as follows:
• Operator: This column allows you to choose the way in which the related Condition logic will be evaluated. The available choices are If, And, and Or.
Note: The first condition in the list will use the If operator. Any additional conditions will allow you to choose between AND and OR.
Note: Any combination of AND and OR clauses can be used in a rule. When mixing AND and OR clauses, the OR operator has higher precedence than AND. Therefore, "IF
A or B and C" is equivalent to "IF (A or B) and C". If the interpretation was meant to be IF A or (B and C), this can be expressed using two Logical Controls: Logical Control 1:
"IF A THEN..." and Logical Control 2: "IF B AND C THEN..."
• Condition: The drop-down list allows you to choose a condition that was already created beforehand.
Description: This area of the dialog box is preset with a default description. There is an option to change the default description. To do so, click the check box to activate the
description field, and enter your description in the text box. Additionally, the description field supports the following expandable masks:
• %# - ID
• %v - Value
Aside from reducing the amount of data input, using these masks provides the additional benefit of automatically updating the corresponding information when changes are
made to the various condition components.
Note: Click the description list box to select one of the predefined masks.
Summary: This area of the dialog box displays an automatically updated preview of the expanded description.
Actions Tab
Actions allow you to define what should be done to an element in the system in response to an associated control condition. The Actions tab provides a list of all actions defined
in the system. There are two types of actions: simple actions and composite actions. Actions have an application-provided non-editable ID (e.g., A01 for simple, AA01 for
composite).
• The Actions List displays a list of all logical actions defined in the system. The list contains four columns: ID (the application defined ID, e.g., A01 for simple, AA01 for
composite), Type (simple or composite), description, and references (logical control references).
• Located above the Conditions List is a toolbar with the following buttons:
◦ New—Opens the New Logical Action dialog box, where you can create a new logical action.
◦ Edit—Depending on whether a simple or composite action is highlighted, this button opens the Simple Logical Action or Composite Logical Action dialog box, which
allows you to edit the highlighted action.
◦ Delete—Deletes the highlighted action. You will be prompted to confirm this action.
[Link] 2025/06/14
Creating Your Model Page 108 of 174
◦ Find—Opens the Find Logical Action dialog box, which allows you to find a particular action based on a variety of criteria.
◦ Report—Generates a summary of the highlighted action.
• Below the toolbar is a set of filters that allow you to only display controls that meet criteria defined by the filter settings. The following filters are available:
◦ Control Set—When a control set is specified, only actions that are a component of that control set are displayed in the Actions list.
◦ Type—When a Type filter other than <All> is specified, only actions of that type will be displayed in the Actions list.
◦ Action Element—When an Action Element filter other than <All> is specified, only actions containing the selected Element will be displayed in the Actions list. You
can filter the available actions to include only actions that are applicable to the element or elements that are currently selected in the drawing pane by selecting
the <Current Selection> option.
The controls used to create or edit an action vary depending on whether the action is simple or composite.
Simple Actions
• Element—The Element field allows you to specify which element the action will be based upon and provides three methods of choosing this element. The drop-down list
displays elements that have been used in other logical controls, the Ellipsis (…) button, which opens the Single Element Selection box, and the Select From Drawing
button, which allows you to select the element using the graphical Drawing view.
• Attribute—This field displays the available attributes for the element type specified in the Element field. Not all attributes are available for all element types. The available
attributes include:
• Status—This attribute is used to change the status of a pipe, pump, or valve when the related conditions are met. The available choices are dependant on the element
type.
• Setting—This attribute is used to change the settings of a pump or valve when the related conditions are met. The setting type varies depending on the type of element.
• Pump Hydraulic Grade (Target)— This attribute is available for variable speed pumps or batteries to modify the target head of a parallel VSP group (the change can apply
to one of the pumps belonging to a parallel VSP group) or of a VSPB.
• Pump Pressure (Target)— This attribute is available for variable speed pumps or batteries to modify the target pressure of a parallel VSP group (the change can apply to
one of the pumps belonging to a parallel VSP group) or of a VSPB.
Note: Pipes can only utilize the Status Attribute, Pumps and all Valves except for the GPV can utilize either the Status or Setting Attribute. GPVs can only use the Status Attribute.
Note: For all valves except for the GPV, there is no explicit Active status with which to base a control upon—the status choices are Inactive or Closed. After a control sets a valve
to Inactive or Closed, to reactivate the valve another control must be created with a Setting attribute. This is because a valve cannot be set to Active, but must have specific
input data to work with. For GPVs, there is no Inactive setting. GPVs can only be set to Active or Closed. If the GPV is not closed, the valve will always produce the headlosses
associated with it through the Head-Discharge Points table.
Note: Pipes can be set to Open or Closed, Pumps can be set to On, Off, or have their relative speed factors increase or decrease. GPVs can be set to Active or Closed. All other
valves can be set to Inactive, Closed, or have their respective settings changed, depending on the Valve type.
Description—This area of the dialog box is preset with a default description. There is an option to change the default description. To do so, click the check box to activate the
description field, and enter your description in the text box. Additionally, the description field supports the following expandable masks:
%# ID
%e Element
%a Attribute
%o Operator
%v Value (and Unit, if applicable)
Aside from reducing the amount of data input, using these masks provides the additional benefit of automatically updating the corresponding information when changes are
made to the various control components.
Note: Click the description list box to select one of the predefined masks.
Summary—This area of the dialog displays an automatically updated preview of the expanded description.
Composite Actions
When a Composite Action is being defined or edited, the lower section of the dialog box is comprised of a single column table and two buttons. The Table contains a list of the
Actions to be used. Each row is a drop-down list that allows you to choose an action that was already created beforehand.
Description—This area of the dialog box is preset with a default description. There is an option to change the default description. To do so, click the check box to activate the
description field, and enter your description in the text box. Additionally, the description field supports the following expandable masks:
%# ID
%v Value
Aside from reducing the amount of data input, using these masks provides the additional benefit of automatically updating the corresponding information when changes are
made to the various control components.
Note: Click the description list box to select one of the predefined masks.
Composite logical actions consist of multiple simple logical actions. These actions are linked with an AND statement.
Summary—This area of the dialog box displays an automatically updated preview of the expanded description.
[Link] 2025/06/14
Creating Your Model Page 109 of 174
A Control Set is made up of one or more control statements (called Controls) of the form: If (condition) then (action) else (action). The actions and conditions are defined under
the Conditions or Actions tab under control.
• New—Opens the Logical Control Set editor dialog box. From this window, you can add previously created logical controls to the new control set.
• Edit—Opens the Logical Control Set editor dialog box, which allows you to edit the highlighted control set.
• Duplicate—Prompts for a name, then opens the Logical Control Set editor to allow you to add or remove controls from the control set.
• Delete—Deletes the highlighted control set. You will be prompted to confirm this action.
• Rename—Allows you to rename the highlighted control set.
• Report—Generates a summary of the highlighted control set, listing the ID, conditions, actions, and elements for all of the logical controls contained within the control
set.
The left pane, labeled Available Items, contains a list of all of the logical controls that have been created in the current model. To add controls to the Selected Items pane on the
right, highlight the desired controls and click the [>] button under Add. To add all of the controls to your Logical Control set, click the [>>] button under Add. To remove a control
from the Selected Items pane, highlight it and click the [<] button under Remove. To remove all controls from the Selected Items pane, click the [<<] button under Remove.
Note: Priority is based upon the order that the controls appear in this dialog box. The first control in the control set has the highest priority, and so on. Any control with a set
priority will overrule any control with no set priority.
[Link] 2025/06/14
Creating Your Model Page 110 of 174
Alternatively, the user can set the Ignore On and off Elevation? attribute in the Operational section of the pump properties grid to True.
Note: The user data does not affect the hydraulic model calculations. However, their behavior concerning capabilities like editing, annotating, sorting and database connections
is identical to any of the standard pre-defined attributes.
User data extensions exhibit the same characteristics as the predefined data used in and produced by the model calculations. This means that user data extensions can be
imported or exported through database and shapefile connections, viewed and edited in the Property Editor or in FlexTables, included in tabular reports or element detailed
reports, annotated in the drawing, color coded, and reported in the detailed element reports.
Note: The terms "user data extension" and "field" are used interchangeably here. In the context of the User Data Extension feature, these terms mean the same thing.
You define user data extensions in the User Data Extensions dialog box.
[Link] 2025/06/14
Creating Your Model Page 111 of 174
Note that element types that are not used in the current model are marked with an icon:
Import Lets you merge the user data extensions in a saved User Data Extension XML file (.[Link] or .xml) into the current model. Importing a User Data
Extension XML file will not remove any of the other data extensions defined in your model. User data extensions that have the same name as
those already defined in your model will not be imported.
Export to Lets you save existing user data extensions for all element types in your model to a User Data Extension XML file (.[Link]) for use in a different
XML model.
New Lets you create a new user data extension for the currently highlighted element type.
Sharing Lets you share the current user data extension with another element type. When you click this button, the Shared Field Specification dialog box
opens. For more information, see "Sharing User Data Extensions Among Element Types"-411.
Delete Deletes the currently highlighted user data extension
Rename Lets you rename the display label of the currently highlighted user data extension.
Expand All Expands all of the branches in the hierarchy displayed in the list pane.
Collapse Collapses all of the branches in the hierarchy displayed in the list pane.
All
Alphabetized Displays the attribute fields in the Property Editor in alphabetical order.
Categorized Displays the attribute fields in the Property Editor in categories. This is the default.
and the following fields, which define your new user data extension:
Attribute Description
General
Name The unique identifier for the field. The name field in the Property Editor is the name of the column in the data source.
Label The label that will appear next to the field for the user data extension in the Property Editor for the selected element type. This is also the column
heading if the data extension is selected to appear in a FlexTable.
Category The section in the Property Editor for the selected element type in which the new field will appear. You can create a new category or use an existing
category. For example, you can create a new field for manholes and display it in the Physical section of that element’s Property Editor.
Field Order The display order of fields within a particular category in the Property Editor. This order also controls the order of columns in Alternative tables. An
Index entry of 0 means the new field will be displayed first within the specified category.
Field The description of the field. This description will appear at the bottom of the Property Editor when the field is selected for an element in your model.
Description You can use this field as a reminder about the purpose of the field.
Alternative Lets you select an existing alternative to extend with the new field.
Referenced Displays all the element types that are using the field. For example, if you create a field called "Installation Date" and you set it up to be shared, this
By field will show the element types that share this field. So for example, if you set up a field to be shared by manholes and catch basins, the Referenced
By field would show "Manhole, Catch Basin".
Units
Data Type Lets you specify the data type for the user data extension. Click the down arrow in the field then select one of the following data types from the drop-
down menu: Integer —Any positive or negative whole number. Real —Any fractional decimal number (for example, 3.14). It can also be unitized with
the provided options. Text —Any string (text) value up to 255 characters long. Long Text —Any string (text) up to 65,526 characters long. Date/Time
—The current date. The current date appears by default in the format month/day/year. Click the down arrow to change the default date. Boolean
—True or False. Enumerated —When you select this data type, an Ellipses button appears in the Default Value field. Click the Ellipses (...) button to
display the Enumeration Editor dialog box, where you can add enumerated members and their associated values. For more information, see
Enumeration Editor Dialog Box. Real (Formula) —Allows you to define a formula to populate the data value.
[Link] 2025/06/14
Creating Your Model Page 112 of 174
Attribute Description
Default The default value for the user data extension. The default value must consistent with the selected data type. If you chose Enumerated as the data type,
Value click the Ellipses (...) button to display the Enumeration Editor.
Dimension Lets you specify the unit type. Click the drop-down arrow in the field to see a list of all available dimensions. This field is available only when you select
Real as the Data Type.
Storage Unit Lets you specify the storage units for the field. Click the drop-down arrow in the field to see a list of all available units; the units listed change depending
on the Dimension you select. This field is available only when you select Real as the Data Type.
Numeric Lets you select a number format for the field. Click the drop-down arrow in the field to see a list of all available number formats; the number formats
Formatter listed change depending on the Dimension you select. For example, if you select Flow as the Dimension, you can select Flow, Flow - Pressurized
Condition, Flow Tolerance, or Unit Load as the Numeric Formatter. This field is available only when you select Real as the Data Type.
You construct the formula using the available fields, operators, and functions. All the dialog box controls are described in the following table.
Lists all input and results fields applicable to the selected element type. This list displays the labels of the fields while the underlying database column
Fields names of the fields become visible in the preview pane when you add them to the formula. Double-click a field to add it to your formula.
Operators These buttons represent all of the operators that can be used in the fomula. Click the appropriate button to add the operator to the end of your
formula , which is displayed in the preview pane. Besides the common options for options for adding, subtracting, multiplying and dividing values ,
there are also ( ) which allows for more complex formulas, and the caret (^) which is used for raising a value to the power of a value
Available Math Lists mathematical functions that can be used in the formula. If you hover over a function it will describe the number of requied parameters and a
Functions brief description of what the function does.
Copies the entire formula displayed in the preview pane to the Windows clipboard.
Copy
Pastes the contents of the Windows clipboard into the preview pane at the location of the text cursor. For example, if your cursor is at the end of the
Paste formula in the preview pane and you click the Paste button, the contents of your clipboard will be added to the end of the formula.
Checks that the forumla is valid.
Validate
Preview Pane Displays the formula as you add fields, operators, and functions to it.
[Link] 2025/06/14
Creating Your Model Page 113 of 174
The icons displayed next to the user data extensions in the User Data Extensions dialog box change depending on the status of the field:
Indicates a user data extension that has been saved to the data source.
•
Indicates a user data extension that is shared among multiple element types but has not been applied to the data source.
•
Indicates a user data extension that is shared among multiple element types and that has been applied to the data source. Fields with this icon appear in the Property
Editor for any elements of the associated element types that appear in your model.
• You can select any number of element types with which to share the field. The list is limited to element types that support the Alternative defined for the Field. For
example, the Physical Alternative may only apply to five of the element types. In this case, you will only see these five items listed in the Alternative drop-down menu.
• You cannot use the sharing feature to move a field from one element type to another. Validation is in place to ensure that only one item is selected and if it is the same as
the original, default selection. If it is not, a message appears telling you that when sharing a field, you must select at least two element types, or select the original
element type.
• To unshare a field that is shared among multiple element types, right-click the user data extension you want to keep in the list pane, then select Sharing. Clear all the
element types that do not want to share the field with and click OK. If you leave only one element type checked in the Shared Field Specification dialog box, it must be the
original element type for which you created the user data extension.
• You can also unshare a field by using the Delete button or right-clicking and selecting Delete. This will unshare and delete the field.
1. Open the User Data Extensions dialog box by clicking Home > Tools > Other Tools > User Data Extensions.
2. In the list pane, create a new user data extension to share or select an existing user data extension you want to share, then click the Sharing button.
3. In the Shared Field Specification dialog box, select the check box next to each element type that will share the user data extension.
4. Click OK.
5. The icon next to the user data extension in the list pane changes to indicate that it is a shared field.
Select element types to share the current user data extension by selecting the check box next to the element type. Clearing a selection if you no longer want that element type
to share the current field.
For example, suppose you want to identify conduits in a model of a new subdivision by one of the following states: Existing, Proposed, Abandoned, Removed, and Retired. You
can define a new user data extension with the label "Pipe Status" for conduits, and select Enumerated as the data type. Click the Ellipses (...) button in the Default Value field in
the Property Editor for the user data extension to display the Enumeration Editor dialog box. Then enter five members with unique labels (one member for each unique pipe
status) and enumeration values in the table. After you close the User Data Extensions dialog box, the new field and its members will be available in the Property Editor for all
conduits in your model. You will be able to select any of the statuses defined as members in the new Pipe Status field.
You can specify an unlimited number of members for each user data extension, but member labels and values must be unique. If they are not unique, an error message appears
when you try to close the dialog box.
• New: Lets you add a new row to the table. Each row in the table represents a unique enumerated member of the current user data extension.
• Delete: Deletes the current row from the table. The enumerated member defined in that row is deleted from the user data extension.
You define enumerated members in the table, which contains the following columns:
• Enumeration Member Display Label: The label of the member. This is the label you will see in where ever the user data extension appears (Property Editor, FlexTables,
etc.).
• Enumeration Value: A unique integer index associated with the member label. The software uses this number when it performs operations such as queries.
External Tools
[Link] 2025/06/14
Creating Your Model Page 114 of 174
Use the External Tool Manager to manage custom menu commands, which are then located in the Tools menu for quick accessibility.
Click Tools > Tools > More... > Customize External Tools to create a custom menu command from any executable file. Executable file types include:
• .exe
• .com
• .pif
• .bat
• .cmd
• External Tool List Pane--This pane lists the external tools that have been created. All of the tools listed in this pane will be displayed in the Tools > External Tools menu.
• New--Creates a new external tool in the list pane.
• Delete--Deletes the currently highlighted tool.
• Rename--Allows you to rename the currently highlighted tool.
• Command--This field allows you to enter the full path to the executable file that the tool will initiate. Click the ellipsis button to open a Windows Open dialog to allow you
to browse to the executable.
• Arguments--This optional field allows you to enter command line variables that are passed to the tool or command when it is activated. Click the > button to open a
submenu containing predefined arguments. Arguments containing spaces must be enclosed in quotes. The available arguments are:
• Hydraulic Model Directory--This argument passes the current model directory to the executable upon activation of the tool. The argument string is %(ProjDir).
• Hydraulic Model File Name--This argument passes the current model file name to the executable upon activation of the tool. The argument string is %(ProjFileName).
• Hydraulic Model Store File Name--This argument passes the current model datastore file name to the executable upon activation of the tool. The argument string is %
(ProjStoreFileName).
• Working Directory--This argument passes the current working directory to the executable upon activation of the tool. The argument string is %(ProjWorkDir).
• Initial Directory--Specifies the initial or working directory of the tool or command. Click the > button to open a submenu containing predefined directory variables. The
available variables are:
• Hydraulic Model Directory--This variable specifies the current model directory as the Initial Directory. The variable string is %(ProjDir).
• Working Directory--This variable specifies the current working directory as the Initial Directory. The variable string is %(ProjWorkDir).
Test--This button executes the external tool using the specified settings.
The user first selects the name of the scenario for which the hydraulic reviewer will be performed using a drop down list of scenarios. The calculation of the scenario must
already have been run and the output file should not have been deleted.
Once the scenario has been selected, the user chooses between two tabs
The Storage Element Volume Balance tab determines the overall balance of flows at any node which can have storage which can include
• Wet Wells
• Catch basins
• Manholes
• Ponds
The user can also use a drop down list of any previously created selection set of node elements on which to perform the review. The default is All Active Nodes.
Picking the green Go arrow starts the calculation which for each node determines the inflow, outflow and overflow volumes over the course of the runs and the percent
deviation from perfect flow balance as
Deviation (system) = 100% (In - out - over - change in storage)/Total System Inflow
The results are presented in decreasing order based on Error. Any column can be sorted, filtered or have the display format changed as with any other flex table.
[Link] 2025/06/14
Creating Your Model Page 115 of 174
On some occasions the Deviation (node) may appear large but this is primarily due to the inflow volume being very small. Users may want to discount the importance of any
errors at nodes where the inflow rates (and deviations) are on the order of 0.1 cfs or less.
The Pipe flow statistics tab provides an indication of the change of flow rates from one time step to the next.
To use this tab, the user can chose All Pipes (the default) or any selection set of pipes. The calculation is run by picking the green Go arrow. It will display a table like the one
below, sorted in order of decreasing Maximum Deviation.
High values for Maximum Deviation do not necessarily indicate that the model contains errors or is unstable. Some pipe links have very large changes in flow from one time step
to another such as in the case of a pump cycling on an off. In some cases, numerical models can overshoot the calculated flow when the flow rate changes abruptly. This effect
usually dies out after one or two time steps. Nevertheless, the Maximum Deviation can serve as an indicator of locations with possible stability issues.
Once the calculations have been performed, the user can export the values to a previously created User Defined Property so that the values can be used in color coding, flex
tables, etc. Click on Export to Model to reach the dialog below and select Export to actually export the numerical values.
If the user defined property doesn't exist, the user can create one by picking the ellipse button and following the instructions for user data extensions. Note that the user defined
property the data will be exported to must use the following settings
Dimension: Percent
[Link] 2025/06/14
Creating Your Model Page 116 of 174
New Contains the following commands: Named View --Opens a Named View Properties box to create a new named view. Folder --Opens a Named
Views Folder Properties box to enter a label for the new folder.
Delete Deletes the named view or folder that is currently selected.
Rename Rename the currently selected named view or folder.
Go to View Centers the drawing pane on the named view.
Shift Up and Shift Moves the selected named view or folder up or down.
Down
Expand All or Expands or collapses the named views and folders.
Collapse All
Help Displays online help for Named Views.
Navigation
• Ribbon Navigation (Stand-Alone, AutoCAD): View > Zoom and View > Named Views
• Menu Navigation (MicroStation, ArcGIS): View > Named Views
TRex Wizard
The TRex Wizard steps you through the process of automatically assigning elevations to specified nodes based on data from a Digital Elevation Model or a Digital Terrain Model.
The data source file, the Bentley SewerGEMS CONNECT model, and the features to which elevations will be assigned are specified.
• Data Source Type--This menu allows you to choose the type of file that contains the input data you will use. Supported data source types include: Bentley .tin,
Bentley .dtm, Bentley .fil, .dwg point, .dxf point, .dwg contour, .dxf contour,LandXML .xml, and Esri .shp.
• File--This field displays the path where the data source file is located. Use the browse button to find and select the desired file.
• Spatial Reference (ArcGIS Mode Only)--Click the Ellipsis (...) next to this field to open the Spatial Reference Properties dialog box, allowing you to specify the spatial
reference being used by the elevation data file.
• Select Elevation Field--Select the elevation unit.
• X-Y Units--This menu allows the selection of the measurement unit type associated with the X and Y coordinates of the elevation data file.
• Z Units--This menu allows the selection of the measurement unit type associated with the Z coordinates of the elevation data file.
• Clip Dataset to Model--In some cases, the data source contains elevation data for an area that exceeds the dimensions of the area being modeled. When this box is
checked, TRex will calculate the model’s bounding box, find the larger dimension (width or height), calculate the Buffering Percentage of that dimension, and increase
both the width and height of the model bounding box by that amount. Then any data point that falls outside of the new bounding box will not be used to generate the
elevation mesh. If this box isn’t checked, all the source data points are used to generate the elevation mesh. Checking this box should result in faster calculation speed and
use less memory.
• Buffering Percentage--This field is only active when the Clip Dataset to Model box is checked. The percentage entered here is the percentage of the larger dimension
(width or height) of the model’s bounding box that will be added to both the bounding box width and height to find the area within which the source data points will be
used to build the elevation mesh.
[Link] 2025/06/14
Creating Your Model Page 117 of 174
• Spatial Reference (ArcGIS Mode Only)--Click the Ellipsis (...) next to this field to open the Spatial Reference Properties dialog box, allowing you to specify the spatial
reference being used by the Bentley SewerGEMS CONNECT model file.
• Also update inactive elements--Check this box to include inactive elements in the elevation assignment operation. When this box is unchecked, elements that are marked
Inactive will be ignored by TRex.
• All--When this button is selected, TRex will attempt to assign elevations to all nodes within the Bentley SewerGEMS CONNECT model.
• Selection--When this button is selected, TRex will attempt to assign elevations to all currently highlighted nodes.
• Selection Set--When this is selected, the Selection Set menu is activated. When the Selection Set button is selected, TRex will assign elevations to all nodes within the
selection set that is specified in this menu.
Note: If the Bentley SewerGEMS CONNECT model (which may or may not have a spatial reference explicitly associated with it) is in a different spatial reference than the
DEM/DTM (which does have a spatial reference explicitly associated with it), then the features of the model will be projected from the model’s spatial reference to the spatial
reference used by the DEM/DTM.
The results of the elevation extraction process are displayed and the results can be applied to a new or existing physical alternative.
• Results Preview Pane--This tabular pane displays the elevations that were calculated by TRex. The table can be sorted by label by clicking the Label column heading and by
elevation by clicking the Elevation column heading. You can filter the table by right-clicking a column in the table and selecting the Filter...Custom command. You can also
right-click any of the values in the elevation column to change the display options.
• Use Existing Alternative--When this is selected, the results will be applied to the physical alternative that is selected in the Use Existing Alternative menu. This menu allows
the selection of the physical alternative to which the results will be applied.
• New Alternative --When this is selected, the results will be applied to a new physical alternative. First, the currently active physical alternative will be duplicated, then the
results generated by TRex will be applied to the newly created alternative. The name of this new alternative must be supplied in the New Alternative text field.
• Parent Alternative--Select an alternative to duplicate from the menu, or select <None> to create a new Base alternative.
• Export Results--This exports the results generated by TRex to a tab or comma-delimited text file (.TXT). These files can then be re-used by Bentley SewerGEMS CONNECT
or imported into other programs.
• Click Finish when complete, or Cancel to close without making any changes.
Customization Profiles can be created for a single model or shared across models. There are also a number of predefined profiles.
New This button opens a submenu containing the following commands: Folder: This command creates a new folder under the currently highlighted
node in the list pane. Customization: This command creates a new customization profile under the currently highlighted node in the list pane.
Delete This button deletes the currently highlighted folder or customization profile.
Rename This button allows you to rename the currently highlighted folder or customization profile.
Duplicate This button allows you to create a copy of the currently highlighted customization profile.
Edit Opens the Customization Editor dialog allowing you to edit the currently highlighted customization profile.
[Link] 2025/06/14
Creating Your Model Page 118 of 174
You can turn off any number of properties and/or entire categories of properties in a single customization profile.
Note that element types that are not used in the current model are marked with an icon.
Bentley SewerGEMS fills in elevation data such that the slopes of pipes being inferred are constant along a reach and uses the downstream pipes as the basis for inferring
missing values for pipe properties. In the drawing below, the elevations are interpolated between the known elevations and the physical properties of the downstream pipe are
used to fill in the properties of the missing pipes. However, if the user has manually entered some of the physical properties manually, these values will not be overridden.
Loading information (sanitary load/infiltration rate) and head loss type (AASHTO, HEC-22) are not inferred but are taken from the manhole prototype.
Where:
• Gu = upstream ground
• Gd = downstream ground
• Zu = upstream invert
• Zd = downstream invert
• N = number of additional manholes
• D = diameter (rise) of downstream pipe
In Bentley SewerGEMS , element property inferencing is only available for gravity elements.
1. Layout new manholes - In this case, the user knows the elevations of the manholes at the beginning and end of a run and the physical properties of the downstream
conduit but has not yet placed the intervening manholes and pipes. The user indicates the number of manholes that will be places in the gap and they will automatically
be inserted. This is useful in laying out new systems.
2. Follow existing path - In this case, the user has laid out the manholes and the conduits between them. The user employs this tool to assign properties to the elements
between the upstream and downstream nodes. This is more useful in filling in details of the system when the path is already determined whether for a new or existing run
of conduits.
Note: This tool also works on Cross Section nodes that are connected to Channel links.
[Link] 2025/06/14
Creating Your Model Page 119 of 174
• Layout Type: Identify whether the inferencing tool should Layout New Elements or Follow Existing path.
• Upstream Node and Downstream node: Pick the upstream and downstream nodes between which element properties are to be inferred. Click on the Ellipse (…) button to
select the element from the drawing. Picking the element automatically returns control to this dialog. It is important that all data for the upstream and downstream
elements already be entered when opening this dialog. If for example ground elevations are missing from a node, then the user should close this dialog and enter that
data before opening this dialog.
• Downstream Link: Field is automatically filled in when the user picks the Downstream Node. If the user has attached more than a single downstream link to the
downstream node, an error is generated.
• Interpolate ground elevations, Interpolate invert elevations and Overwrite pipe properties: If checked, the inference tool will overwrite default values in the nodes and
pipes between the upstream and downstream nodes. However, if the user has manually assigned properties to these elements, those properties will be retained. These
check boxes are only available when Follow Existing Path has been selected because for new elements (Layout New Elements), the user has no choice but to accept
inferred values. The default elevation is 0 and default pipe size is 12 in. (300 mm). If the ground elevation has been set to 512 ft (156 m) and the pipe size set to 18 in. (450
mm), then the inference tool will only interpolate invert elevations for those elements.
• Number of New Nodes: This field is only available when the user has selected "Layout New Elements." If the user sets this value to N, the inference tool will place N nodes
and N+1 conduits (of equal length) in a straight line between the upstream and downstream nodes. For example, if the distance is 1376 ft (419 m) and the user wants 2
new elements, then the inferencing tool will add two manholes and three pipes each 459 ft (140 m) long.
• Create new scenario: If the user checks this box, the tool will prompt for the name and the parent scenario for the scenario being created. If the user does not check this
box, then the new elements and properties will be placed in the current scenario.
• When a new scenario is created and the Parent Scenario is set to None, the alternatives that make up the scenario are selected based on the first scenario listed in the
Scenario Manager, usually the Base scenario. After the Element Property Inferencing tool creates a scenario, ensure that the other alternatives in the new scenario are set
up properly (double-check active topology, inflows, initial setting, etc.).
• Parent scenario: Name of parent scenario if new scenario is being created.
• New scenario label: Name of new scenario if new scenario is being created.
• Override alternative label: When a new scenario is being created, the user can check this box if the user wants to control the name of the new physical alternative being
created. If not, then the default new name is used.
• New alternative label: if the "Override alternative label" box is checked, then the user provides the new name here.
• Interpolate: Starts the inferencing calculations.
• Close: Closes this dialog. Inferencing settings are saved for the model session. Once the model is closed, all settings are lost. However, the user can open the dialog, setup
the reach and close this dialog if additional input information is required. When the user reopens the dialog (as long as the model was not closed), the settings will be
restored.
• Help: Opens this Help.
Note: Note that no new Active Topology alternative is created by this tool. This is not an issue for the Follow Existing Path option since no new elements are created, but can be
for the Layout New Elements options. In the latter case, the user should consider whether it is more desirable to create a new active topology alternative before running the
inferencing tool.
Note: This tool also works on Cross Section nodes that are connected to Channel links.
It is advisable to have all elements created and property data entered before opening this tool. New data cannot be entered when this dialog is open.
Example
Given the system below, and the values in the inferencing dialog, two new manholes are created between MH-3 and MH-5.
[Link] 2025/06/14
Creating Your Model Page 120 of 174
[Link] 2025/06/14
Creating Your Model Page 121 of 174
If on the other hand, the system was already laid out with no elevation data for MH-7 and MH-8 and only default pipe sizes (12 in., 300 mm) for CO-6, CO-7 and CO-8, the profile
would initially look like this.
After running, Follow Existing Path, the profile looks like this with correct elevations and pipe size set to 20 in. based on the downstream conduit properties.
[Link] 2025/06/14
Creating Your Model Page 122 of 174
i-Models
The term "i-models" is used to describe a type of Bentley file (container) which can be used to share data between applications. The formal definition of an i-model is:
An immutable container for rich multi-discipline information published from known sources in a known state at a known time. It is a published rendition in a secure read-only
container. It is a portable, self-describing and semantically rich data file.
i-models can be thought of as similar to shapefiles in that they provide ways to share data. They are immutable in that they cannot be modified (they are read-only). They reflect
the state of the model file at the time the i-model was created.
i-model support is built on Bentley technology and is not automatically installed with SewerGEMS V8i or other hydraulic products. The software to use i-models is installed with
Microstation and other Microstation based products (versions 08.11.07 or later). If a user attempts to create an i-model and the support for i-model creation is not installed, an
error message to download and install the necessary files is issued. The i-model files can be installed from the Bentley SELECTdownload site.
An i-model can contain all the elements and their properties for a model for a given scenario and time-step or the information can be filtered so that only a fraction of the
elements and their properties are incorporated in the i-model.
An i-model is generally much smaller than the .mdb file for the hydraulic model even though it does contain results.
For details on publishing and viewing i-models, see ”Publishing an i-model’ and ”Viewing an i-model’.
Publishing an i-model
Viewing an i-model
Publishing an i-model
To create an i-model, select File > Export > Publish i-model once the desired scenario and time-steps have been selected.
The following dialog opens with the defaults set so that all elements and properties are included in the i-model.
[Link] 2025/06/14
Creating Your Model Page 123 of 174
The top left pane is a summary of this element types are to be included in the i-model. If a box by the element type is checked, that element type is included. The
Table/Properties column reflects the selections on the right side of the dialog in terms of which elements and properties are included.
The bottom left portion of the dialog is used to identify which elements are to be included in the i-model. This can be specified individually for each element type.
If the "Publish a subset of elements based on the Flex Table filters" box is checked, only those elements that are in the filtered flex table will be included in the i-model.
If the "Exclude topologically inactive elements" box is checked, only active elements (Is active? = True) are included in the i-model.
If the "Publish imodel to Personal Share" box is checked, the i-model will be published to your Personal Share.
The user will usually not need to include all element properties in the i-model. The right side of the dialog is to identify which properties of the elements are going to be included
in the i-model. The default is "all properties". If the user wants to only include a subset of properties, the user should create a flex table with only those properties and select
that flex table from the drop down list. Because it is possible to have multiple flex tables with the same name (e.g. Pipe Table can be a predefined table or a Model table), the
user can explicitly state the table path (e.g. Tables - Predefined or Tables - Model). If the flex table is filtered, the filter is displayed in the Filter box and in the left pane, the Is
Filtered column is set to True for that element type. Note that element types that are not used in the current model are marked with an icon
The Properties box on the right side of the dialog shows the properties that are imported for that element type.
If the box for "Publish model elements in 3D" is selected, the elements will be published in 3D.
The main motivation behind allowing publishing geometries in 3D is to enable clash-detection. That feature is expected to be more important for gravity hydraulic products, but
it is included with pressure-based applications as well. The basic functionality regarding this topic can be summarized as:
Node cells' z-coordinates are assigned according to their elevation values, at their cell's insertion point.
When all settings are established for all element types, the user picks OK.
Upon starting the publishing, the user is asked for the file name for the .dgn file that will contain the i-model. The user names the file and path as with any other Windows
application.
Cell Libraries
Seed Files
Cell Libraries
Two cell libraries are used during i-model publishing, one for 2D and one for [Link] cell libraries are installed with the product and these can be customized by the user. The
files are [Link] and [Link], and can be found in the Bentley\SewerGEMS8 directory.
If no cell library is found, default cells are used (e.g. a circle in 2D and a sphere in 3D).
Seed Files
[Link] 2025/06/14
Creating Your Model Page 124 of 174
Users may want to customize the seed-file that will be used for the publishing of an i-model. In that case, one or more of the following files need to be created in the
Bentley\SewerGEMS8 directory:
Seed Files
If the appropriate user-customized seed file is not found, a default one will be used.
Viewing an i-model
It is anticipated that numerous applications will be able to view and use i-models. Initially, i-models can be view using:
• Bentley View
• ProjectWise Navigator
• Microstation
In all of these applications, it is possible to open an i-model by browsing to the i-model when the ap starts and opening the file.
If the model is not visible, pick the "Fit View" button. This should make the model visible. From this view, it is possible to use other commands such as zooming and panning to
navigate around the drawing.
To view the properties of individual elements, pick the Element Information button or pick Edit > Information in Bentley View or Review > Information in ProjectWise Navigator.
The user can then select and element and its properties will be displayed.
In Microstation and Navigator, it is also possible to view tabular element data for each element type by selecting File > Item browser. This opens the Items browser for element
types as shown below:
Double clicking on one of the element types or picking the "Show Details" button from the top of the dialog, opens a table for that element type.
If the tree is expanded before selecting Show Details and an individual element is selected, the user will see properties for the selected element.
Automatic Design
StormCAD allows you to design many parts of the sewer network, including gravity piping and structures. The design is flexible enough to allow you to specify the elements to be
designed, from a single pipe size to the entire system.
Pipes and structures are designed to consider several constraints, such as allowable ranges of slope, velocity, and cover. In general, the design algorithm attempts to minimize
excavation, which is typically the most expensive part of installing sewer piping and structures.
Changes suggested to the model by an automatic design calculation will be saved to the Physical Alternative that you specify. This Physical Alternative should be uniquely
created just for the automatic design to avoid overwriting the data in your other Physical Alternatives.
Bentley SewerGEMS CONNECT can automatically size conduits, set node invert elevations and determine the size of inlets to pass a design storm while meeting user-specified
constraints. To use this feature: set up the model for analysis, specify which elements are to be sized and the sizes available for use in the design, indicate the constraints to be
met, and set the scenario's Calculation Type (found in the calculation options) to Design as opposed to Analysis.
Note: Automated conduit sizing only relates to closed conduits such as circular and elliptical pipes and box conduits, not open channels.
1. Create a Bentley SewerGEMS model with all the elements to be designed. Make initial estimates of the decision variables such as conduit size and invert elevations. Run
the model to make sure that it is complete and will calculate without fatal errors.
2. Create a list of candidate conduit section sizes in the Conduit Catalog (click Components > Catalog > Conduit Catalog). These candidate conduits should have the same
conduit shape and material as the pipe in the original model. There must be at least one conduit in the Conduit Catalog with the same shape (e.g. circular) and material
(e.g. PVC) as the conduit being designed. While the user can construct this list manually, it is generally recommended to build it using the Import from Library command
and then picking the shape and material from the list in the library, then deleting those sizes that should not be considered in design.
[Link] 2025/06/14
Creating Your Model Page 125 of 174
3. In the case of inlet sizing for catch basins, Bentley SewerGEMS can automatically design the inlet opening length for the inlet at any catch basin element in the network.
However, there are three different Inlet Types in Bentley SewerGEMS : Percent Capture, Maximum Capacity and Catalog Inlet. Of these, only Catalog Inlets have a
configurable opening length, therefore, in order for Bentley SewerGEMS to design opening length, the Inlet Type must be set to Catalog Inlet, and an Inlet must be
selected. It may be necessary to add a new inlet to Inlet Catalog (click Components > Catalog > Inlet Catalog), or import one or more from the Engineering Libraries.
Bentley SewerGEMS will select an opening length for a particular inlet from the list of Design Lengths associated with that inlet in the Inlet Catalog. The Design Lengths
may be viewed or edited by clicking on the Design tab in the Inlet Catalog. The design algorithm will determine the minimum available inlet length that meets the design
constraints. Bentley SewerGEMS will not select a different Catalog Inlet during the design run, it will only select a different opening length for the inlet specified.
4. Go to the Design Alternative (click Home > Alternatives) and set up the options for the run. There are three decisions that need to be made for conduits in terms of which
properties should be adjusted during design: Design Conduit?, Design Start Invert?, and Design End Invert?. Checking any of these boxes means that these properties will
be adjusted during design. ("Design Conduits" means the software should determine the size of the conduit.) Unchecking them means that the values set in the initial
model will be maintained. For nodes, the choices are: Design Structure Elevations? and Allow Drop Structure?. If you do not want to the Start (Upstream) and/or Stop
(Downstream) invert elevations to change during the design, you must set the Design Start Invert? and/or Design Stop Invert? property to False. For catch basin inlets, the
choice is Design Inlet Opening?
5. Next set up the design constraints. For conduits, if you pick Simple as the type, the Minimum and Maximum Velocity need to be specified (or the defaults kept). If Table is
selected, you can vary the constraints based on pipe Rise. If you do not want to use velocity constraints, set the Minimum to zero and Maximum to a large number. For
inverts, decide whether to match Inverts or Crowns or specify an offset through the structure. For inlets, specify the Maximum Spread in Sag and the maximum Depth in
Sag. If you set up constraints under Default Design Constraints (click Analysis > Default Design Constraints), these constraints will be used for any new Design Alternative
as well as the alternative associated with the current scenario.
You can modify the constraints for just an individual element by checking Specify Local Pipe (Inlet) Constraints box associated with that element.
1. You can specify some additional options under the Extended Design portion of the alternative manager. In some cases, the pipes must be designed to carry the design
flow at less than 100% full (100% Full is the default). You can check Partly Full Design and specify the design percent as either a constant (Simple) or a tabular list as a
function of conduit rise. The design percentage is defined as a percentage of full depth. You can also allow for multiple parallel pipe barrels or limit the maximum section
size by specifying maximum rise.
2. Create a new calculation option (click Analysis > Calculation Options) with the Calculation Type set to Design (as opposed to Analysis).
3. Create a new scenario using the desired Design Alternative and Calculation Options. Make that scenario the current scenario and start the design by picking Compute.
4. When the design starts, it will indicate the (current) Physical Alternative in which the results will be stored. If the user wants the results stored there, pick Yes. If the user
wants the new design properties stored in another Physical Alternative, this is the place to specify that alternative by picking No. That Physical Alternative is associated
with the current scenario.
The Default Design Constraints dialog is divided into the three following tabs:
• Gravity Pipe
• Node
• Inlet
The Gravity Pipe tab allows you to enter default constraints to be used for the design of pipes when performing a calculation run in design mode. The dialog is divided into the
following sections:
• Default Constraints
• Extended Design
In this section, there is a Velocity tab, a Cover tab, a Slope tab, and a Tractive Stress tab. You can specify the following default constraints to be used for the design of gravity
pipes:
This section lets you specify if the following design parameters are to be used. If they are to be used, you can also specify the associated default value. The Extended Design
section is split into three tabs:
• Part Full Design Tab: The Part Full Design tab consists of the following controls:
◦ Is Part Full Design?–When checked, allows you to specify the Percent Full target to be used by the design algorithm.
[Link] 2025/06/14
Creating Your Model Page 126 of 174
◦ Percent Full Constraint Type–Allows you to specify how the Percent Full constraints are defined. When Simple is chosen, a single Percentage Full value is selected.
When Table is chosen, you can specify multiple Rise vs Percent Full points in tabular format.
◦ Percentage Full–Specify the Percent Full value to be used when the Is Part Full Design? box is checked. This control is only availble when the Percent Full Constraint
Type is set to Simple.
• Number of Barrels Tab: The Number of Barrels tab consists of the following controls:
◦ Allow Multiple Barrels?–When checked, allows the design algorithm to use more than one identical section in parallel, up to the specified Maximum Number of
Barrels.
◦ Maximum Number of Barrels–The maximum number of identical sections allowed to be used in parallel when the Allow Multiple Barrels? box is checked.
• Section Size Tab: The Section Size tab consists of the following controls:
◦ Limit Section Size?–When checked, limits the pipe section height to the specified Maximum Rise value during the design process. There may be situations in design
where it is desired to limit the size of the designed pipe. This may be done to avoid conflicts with obstructions or other utilities, for example. For these situations,
The program enables you to limit the maximum section rise that will be selected. A smaller size will be used if possible. If none of the available design sections have
a small enough rise, the smallest one will be used.
◦ Maximum Rise–The maximum rise a section height is allowed to be used in the design when the Limit Section Size? box is checked.
Node Tab
This tab lets you specify the design constraints to be used by default for all gravity structures when performing calculations in design mode. During an automatic design, the
program will adjust the elevations of the pipes adjacent to the structure according to the structure's matching constraints. The two choices for matching are Inverts and Crowns.
Additionally, the downstream pipe can be offset from the upstream pipe(s) by a specified amount. This value is called the Matchline Offset. Optionally, the program supports the
design of drop structures. In some situations, drop structures can minimize pipe cover depths while maintaining adequate hydraulic performance.
Inlet Tab
This tab lets you specify the design constraints to be used for all inlets when performing a calculation run in design mode. During an automatic design, the program will adjust
the length of the inlet in order to meet the design constraints.
• For an inlet in sag, the Default In Sag Design Constraints consist of maintaining the gutter spread and water depth under a given value.
• For an inlet on a grade, the Default on Grade Design Constraints consist of ensuring that at least a given percentage of the gutter flow is intercepted.
This section lets you specify the design constraints to be used for all inlets located in sag when performing calculations in design mode. During an automatic design, the program
will adjust the length of the inlet in order to meet both design constraints:
• Maximum Spread in Sag–The maximum allowed spread of water at the inlet, measured from the curb.
• Maximum Gutter Depth in Sag–The maximum depth of water allowed at the inlet.
This section lets you specify the design constraints to be used for all inlets located on a grade when performing a calculation run in design mode. During an automatic design, the
program will adjust the length of the inlet in order to meet a minimum inlet efficiency, or percentage of gutter flow intercepted by the inlet, that you specify in the minimum
Efficiency on Grade field.
Note: The predefined templates are Read-Only files. Do not modify the read-only setting on these files.
You may also create new Templates and use those in future models. To create a new template, populate the inlet and conduit catalogs with the desired data and save the model
to the template folder. To use the new template, simply open it and save it as a new file name to use it for a new model.
Design Priorities
Unfortunately, it is not always possible to automate a design that meets all desired constraints. With this in mind, there are certain priorities that are considered when the
automated design is performed. These priorities are in place to try to minimize the effect on existing portions of the system while providing appropriate capacity in the designed
pipes.
While this sequence does not go into complete detail regarding the design process, it does indicate the general priorities for the automated design. The priorities, of course, only
deal with elements that are being designed. If a pipe has fixed inverts or is not to be designed at all, some or all of these criteria obviously do not apply.
If a pipe connects to an existing structure, the pipe rise should be completely within the existing structure. The only time this may be violated is if there are no available section
sizes that would not violate that condition (i.e., the existing structure height is so small that all available pipes have rises too big). In this very unlikely condition, the smallest
available section size will be selected, with the invert elevation placed at the bottom of the structure.
A Designed Pipe Should Not Have a Crown Above an Adjacent Designed Structure
Where pipe inverts are fixed, it is possible that the required section size would cause the pipe crown to be higher than the top elevation of an adjacent designed structure. If all
available pipe section rises are greater than the depth of the pipe invert, the smallest pipe size will be chosen.
Note: This situation will only be encountered in situations where the structure's top elevation is set equal to the ground elevation - otherwise, the structure will be designed
with a higher top elevation.
[Link] 2025/06/14
Creating Your Model Page 127 of 174
If the pipe is not limited by adjacent structures, the pipe should be sized such that the design capacity is greater than the calculated discharge in the pipe. The design capacity
may be based on one or more pipes, flowing full or part-full, depending on user-set design options. If site restrictions or available section limitations result in a situation where
no sections meet the required capacity, the largest available size and number of barrels will be chosen.
Designs typically avoid sizing downstream pipes smaller than upstream pipes, regardless of differing slope and velocity requirements. One of the primary reasons for this is
debris that passes through the upstream pipe could become caught in the connecting structure, clogging the sewer.
Whenever possible, the designed pipe should have its downstream invert set such that the pipe meets the matching criteria, such as matching inverts or crowns. Note that
because of higher design priorities, such as the pipe fitting within existing structures, the matching criteria may not always be met.
Pipe inverts should be set such that the upstream and downstream crowns of the pipe are below the ground elevation by at least the amount of the minimum cover. Note that
higher design priorities, such as existing structure locations and matching criteria, may prevent the minimum cover constraint from being met.
The upstream invert of the designed pipe should be set to meet the matching criteria of the upstream structure. Higher design priorities, such as minimum cover constraints,
may result in a pipe that does not match upstream as desired.
Wherever possible, the designed pipe should not exceed the desired maximum slope. In some situations, elevation differences across the system may result in a case where a
drop structure can be used to offset pipes. This is used instead of a pipe that is too steep, or instead of upstream piping that would require much more excavation. Note that the
maximum slope constraint may be violated if higher priority design considerations, such as existing structure location or pipe matching criteria, governs.
There are many degrees of freedom when designing a piping system. Several constraints that are not mentioned above, such as minimum velocity constraints and minimum
slope constraints, may also result in adjustments to the designed pipe. Other constraints may be too limiting, such as maximum cover constraint and maximum velocity, resulting
in designed pipes that could violate too many other constraints.
This wide range of choices and priorities emphasizes the need for careful review of any automated design by a professional. It is not always possible to meet every desired
condition, so it is very much the responsibility of the engineer to make final judgments and decisions regarding the best design for the client.
Inlet Design
The length of any inlet can be automatically designed. The available design lengths (standard lengths) for a given inlet are defined in the inlet library, and can easily be changed.
The design algorithm uses the same equations used in analysis to determine the minimum available inlet length that meets the design constraints.
[Link] 2025/06/14
Creating Your Model Page 128 of 174
Since gutter width and spread are independent of the inlet characteristics, inlets on grade are designed simply to meet the minimum efficiency. If the minimum efficiency cannot
be met with any of the lengths, the software will choose the largest of the available lengths.
When designing inlets in sag, the objective is to keep gutter spread and depth below desired maximum levels. the software will choose the minimum available inlet length that
meets these constraints. In a case where the constraints cannot be met with any of the available lengths, the software will choose the largest inlet length possible.
Design Steps When Conduit Flow Travel Time Is Considered (StormCAD Only)
After including conduit flow travel time in design (set in the Calculation Options), the design steps for one pipe in design from upstream to downstream will be the following:
1. Calculate flow travel time of non-design pipe if including flow travel time is selected
2. Conduit discharge calculation (Include flow travel time in system Tc calculation)
3. Get conduit minimum size
4. Get conduit maximum size
5. Adjust upstream invert to match upstream minimum cover
6. Adjust upstream invert to match upstream structure (to match matchline offset)
7. Adjust downstream invert to match downstream minimum cover
8. Adjust downstream invert to match minimum slope
9. Adjust downstream invert to match downstream fixed structure
10. Adjust upstream invert to match maximum slope
11. Adjust upstream invert to match fixed structure
12. Adjust downstream invert to match minimum slope
13. Adjust downstream invert to match fixed structure
14. Adjust conduit size for Capacity to match discharge (Calculate conduit flow travel time if including flow travel time is selected)
15. Adjust downstream invert to match minimum velocity
16. Adjust both ends to match Upstream structure (to match matchline offset)
17. Adjust both ends to match upstream minimum cover
18. Adjust downstream invert to match downstream minimum cover
19. Adjust upstream invert to match maximum slope
20. Adjust upstream invert to match fixed structure
21. Adjust downstream invert to match minimum slope
22. Adjust downstream invert to match fixed structure
After designing all pipes from upstream to downstream, we design all pipes from downstream to upstream. For each conduit, we run the following main steps:
Design Considerations
As with any automated design, the program's design is intended only as a preliminary step. It will select pipe sizes and pipe invert elevations based on the input provided, but no
computer program can match the skills that an experienced engineer has. The modeler should always review any automated design, and should make any changes required to
adjust, improve, and otherwise polish the system.
Using PondMaker
PondMaker is a feature that streamlines detention pond design by guiding you step-by-step through this process. PondMaker also assists by keeping track of information such as
target outflows, pond volume estimates, outlet structure design trials, peak pond outflows, and maximum water surface elevations for multiple storm events and/or multiple
ponds. With the click of a button, the numbers in this spreadsheet update automatically.
Note: A PondMaker worksheet contains the design data for multiple design trials of a single pond. If you have more than one pond in your system and wish to use PondMaker,
you will need to set up a separate worksheet for each.
The PondMaker dialog box helps organize and reduce pond design iterations by systematically guiding you through the following iterative pond design sequence:
1. Set up predevelopment and postdevelopment scenarios and alternatives. This step should be completed before you open PondMaker.
2. Create PondMaker worksheet and enter design scenario configuration to establish target outflow rates.
3. Estimate Pond Storage Requirements.
4. Create Pond Dimensions.
5. Outlet Design and Analysis.
6. Routing Analysis.
[Link] 2025/06/14
Creating Your Model Page 129 of 174
[Link] 2025/06/14
Creating Your Model Page 130 of 174
[Link] 2025/06/14
Creating Your Model Page 131 of 174
[Link] 2025/06/14
Creating Your Model Page 132 of 174
[Link] 2025/06/14
Creating Your Model Page 133 of 174
[Link] 2025/06/14
Creating Your Model Page 134 of 174
[Link] 2025/06/14
Creating Your Model Page 135 of 174
[Link] 2025/06/14
Creating Your Model Page 136 of 174
[Link] 2025/06/14
Creating Your Model Page 137 of 174
[Link] 2025/06/14
Creating Your Model Page 138 of 174
[Link] 2025/06/14
Creating Your Model Page 139 of 174
[Link] 2025/06/14
Creating Your Model Page 140 of 174
[Link] 2025/06/14
Creating Your Model Page 141 of 174
[Link] 2025/06/14
Creating Your Model Page 142 of 174
[Link] 2025/06/14
Creating Your Model Page 143 of 174
[Link] 2025/06/14
Creating Your Model Page 144 of 174
[Link] 2025/06/14
Creating Your Model Page 145 of 174
[Link] 2025/06/14
Creating Your Model Page 146 of 174
[Link] 2025/06/14
Creating Your Model Page 147 of 174
[Link] 2025/06/14
Creating Your Model Page 148 of 174
[Link] 2025/06/14
Creating Your Model Page 149 of 174
[Link] 2025/06/14
Creating Your Model Page 150 of 174
SCADAConnect Overview
SCADAConnect is the name given to several types of features aimed at better integrating hydraulic models with operational data. This is sometimes referred to as "Live
Modeling" or "Real Time Modeling" but since it often involves a SCADA (Supervisory Control and Data Acquisition) system, the name SCADAConnect is used in Bentley products.
Several different groups of features are covered by the SCADAConnect name including:
1. Ability to import field data from SCADA systems, data loggers and other external data sources for use in modeling.
2. Ability to run hydraulic analyses from a simplified user interface developed for operations personnel who are not full-time modelers.
3. Ability to display model results in a SCADA Human Machine Interface (HMI).
4. Ability to establish alarms and alerts to help review model runs.
The users can connect the model to external data using a SCADA element which the user places in the model and connects between a model element and a value in an external
data source (see SCADA Element) to enable the model to import data from an external source. Each of these SCADA elements represents an individual signal (tag). In the SCADA
element, the user defines the model element (e.g. J-22) and property (field) (e.g. Pressure) associated with the SCADA signal. At the same time, the user identifies the external
signal under Components > SCADA signals (see SCADA Signals Setup). This involves identifying the data source and whether it is some type of data file or a direct connection to a
SCADA OPC server. The user then identifies which signals (tags) from the data source are to be made available to the SCADA element in the model.
Once the link between the model elements and the external data sources have been established, the user can use external data for a variety of purposes including:
The user can run a hydraulic model from a simplified user interface such that someone can get started using models without detailed knowledge of all the software's features.
This is intended for use by operators or engineers who are not regular model users. The user can access this SCADAConnect Simulator by picking Analysis > SCADA >
SCADAConnect. To use this feature, a SCADA Baseline scenario must already have been set up. The user can then make changes to demands, override controls, simulate a fire
event or simulate a pipe break and start a run which can be based on initial conditions from the baseline scenario, some historical point in time or current (Live) conditions (see
SCADAConnect Simulator).
When the user hits the Compute button the model runs and the user can view the results through a wide range of features (tabular, color coding, annotation, profiles) and
perform additional calculations such as energy use. If the user has set up the features to publish results to a SCADA HMI, then the model results can be viewed in the HMI (see
below).
1. Create baseline SCADAConnect scenario and set up symbology, named views, etc.
2. Open SCADAConnect Simulator and pick the adjustments to the baseline scenario.
3. Run the adjusted scenario and view results.
SCADAConnect enables users to view model results using a SCADA HMI. This is oriented toward users who are operators and are accustomed to working with the HMI. To use
this feature, the user must have set up an OPC server to receive data from the model and HMI screens to display the values from the OPC server. Usually the user will not need
to set up the server and the HMI from scratch but use the existing server and HMI as a starting point with modifications to reflect additional data than can be made available
from the model which is not available from the normal SCADA system.
The user sets up the mappings from the model to the OPC server using a simple SCADA Results Publishing table which identifies the connection between the model properties
and tags in the OPC server (see Displaying Model Results in SCADA Human Machine Interface (HMI)-Overview). To view values in the HMI, the user need only pick the time in the
Time Browser (Analysis > Time Browser) to choose the time for which data are to be displayed.
The user can also create alarms and alerts within SCADAConnect. Alarms are settings assigned to SCADA elements which, when triggered, produce messages. (For example,
Alarms can also be set on tank elements based on level.) Alerts are similar but are set up in an Alerts manager and are associated with model hydraulic elements, not SCADA
elements (See Alarms and Alerts).
SCADAConnect Toolbar
SCADA Signals Dialog
SCADA Database Source Dialog
Database Connection Dialog
Database Select Signals Dialog
Initial Setting Import Dialog
Real-time OPC Source Dialog
Historical OPC Source Dialog
[Link] 2025/06/14
Creating Your Model Page 151 of 174
SCADAConnect Toolbar
When the user selects Analysis > SCADA > SCADAConnect, the following toolbar becomes available:
The first button opens the SCADA signals dialog which can also be reached from Components > SCADA Signals. This is where connections and signal mappings are created (see
“SCADA Signals Dialog”-618).
The second button opens the SCADA flex tables which can also be opened from View > Flex Tables. It enables the user to view SCADA and model values in the same table.
The third button opens the initial setting dialog which enables the user to select a time and import values of certain properties into the initial conditions alternative such as wet
well and pump status (see“Initial Setting Import Dialog”-626).
The fourth button creates a SCADAConnect log which enables the user to view what SCADAConnect did and is helpful in debugging problems.
New enables uses to create a new Database or OPC data source. See help topics on Database Source Dialog and Real Time or Historical OPC Source Dialog for details.
Edit enables the users to view and modify previously defined database or OPC sources by opening the detailed dialogs.
Rename allows the user to rename the selected data source or signal.
The behavior of the right pane depends on whether the user has selected a data source or a signal in the left pane.
If a datasource has been selected, the right pane will display a list of signal names.
[Link] 2025/06/14
Creating Your Model Page 152 of 174
If a signal has been selected, the right pane will display a preview of the data for that signal. To ensure that the data are current, the user can pick Refresh button or Auto
Refresh check box.
The first step is to establish a database connection which initiated by pick the Edit button, in the Connection field (see “Database Connection Dialog”-623)..
Once the Connection to the file has been established, the user can further refine the connection. For example in an Excel file or an Access database, the user can specify which
table is to be used for the connection. If multiple tables are used, each one must have its own connection.
The user must pick from one of two data source formats: One value per row or Multiple values per row.
In the "One value per row" format, each row/record must contain the signal name field (e.g. Pressure Main St.), the value field (e.g. 60) and a time stamp filed (e.g. 2/4/2015
14:30). Optionally, the user may also specify if there is a field indicating the quality of the data, Questionable Field (e.g. Missing). There may be other fields on each record but
these are ignored. The order of the fields doesn't matter. The Time Stamp Field must include a recognized Windows data/time value. A typical row might include:
In Multiple values per row, there must be a field/column header with the signal name and there may be multiple fields in a single row. A typical first row and subsequent row
may include:
Date/time Pressure Main St Flow Main St. Temperature Tank Level South
Within a Database source, there are two ways that time is used. The user selects these under Options. In "Historical", the values can be read for any time for which data are
available. For "real time", only the most recent value is read and then, only if it is within the time tolerance specified by the user. This is used for importing initial conditions for
starting a run or viewing the latest value that has been placed in the datasource file. The time is based on the clock in the computer running the model.
The "Time Tolerance" field is used because the time stamp on a SCADA signal may not correspond exactly to the time for which data are called for from the model. For example,
the model may require a value at 5/16/2015 [Link] am but the closest value in the SCADA system may be 5/16/2015 [Link] am. If the difference is greater than the tolerance,
no value is obtained. It is best to set a wide tolerance initially which can be reduced as higher quality information is required. If multiple values are available within the tolerance,
the value closest to the required time is used.
To select which signals from the SCADA system are to be mapped to the SCADA signal element, the user picks "Select SCADA Signals" (see “OPC Select Signals Dialog”-628).
[Link] 2025/06/14
Creating Your Model Page 153 of 174
The units for an imported value are assumed to be the display units in the model. If there is a chance that the units may be different in the SCADA file than in the model, the user
can override the units by selecting the units tab and entering the "Storage units".
Once the Data Source type has been selected, the user can pick the ellipse button in the Database Connection dialot to navigate to the data source file. Once the file has been
selected, the user should pick Test Connection to check that the file matches the Data Source Type and is in a valid format.
If the Advance button is selected, the user can set up the prefix and suffix for SQL type queries of the data source.
[Link] 2025/06/14
Creating Your Model Page 154 of 174
To select signals, pick the signal from the available signals in the left pane and pick the Add button (>) to move it to the right pane. Alternatively, a user can Add all the signals
(>>) and Remove (<) the few that are not needed.
The user selects whether to use a Historical or Real Time datasource. The mapping between the SCADA system and the hydraulic model must be created before the initial
condition can be imported. If a Historical data set is selected, the user must pick a time for which values are imported. If a real time datasource is selected, the most recent
values are used.
If "Ignore inactive elements" is checked, only values for active elements are imported. This can help speed up imports.
[Link] 2025/06/14
Creating Your Model Page 155 of 174
The Host field is used to identify the computer hosting the OPC server on the network. The refresh button to the right of the field searches the network for the server. If
unchecked, it is assumed that the server is on the computer running the hydraulic model.
The OPC Server is the name of the server since there can be several servers on a computer.
The Select SCADA Signals button opens the dialog to select signals as described in the Select Signal (OPC) help topic. [xref Select Signals (OPC)]
The real time OPC signal values can be viewed in the SCADA Signals dialog as shown below:
The Host field is used to identify the computer hosting the OPC server on the network. The refresh button to the right of the field searches the network for the server.
The OPC Server is the name of the server since there can be several servers on a computer.
The Select SCADA Signals button opens the dialog to select signals as described in the Select Signal (OPC) help topic (see “OPC Select Signals Dialog”-628).
Connection Manager
The Connection Manager is used to create a new SCADA connection and to edit the existing SCADA connection. SCADA connection is basically an item of the Connection
Manager in which information like, the data source, type of connection used, method of connection are provided. You can also specify the server location, user name, password
etc. depending upon the selected connection method. Two generic types of connections can be established.
[Link] 2025/06/14
Creating Your Model Page 156 of 174
Database Connection
Database Connection
SCADAConnect can read data from a variety of sources. The Database Connection method helps to establish a communication to a SCADA file. A file can be accessed (or opened)
using different methods (or drivers) such as ODBC, OLEDB or SQL. To simplify this to a general hydraulic modeler, SCADAConnect offers two additional methods where modeler
can simply specify a file such as Excel or These direct file methods also uses OLEDB method. Following are the methods you can select to provide information about your SCADA
data.
1. Access File
2. Access 2.0
3. Access 2003/2002/2000 (4.0)
4. Access 2007 (12.0)
5. Access 97/7.0(3.0)
6. Excel File
7. Excel 2003/ XP /2000/97 (8.0)
8. Excel 2007 (12.0)
9. Excel 3.0
10. Excel 4.0
11. Excel 95/5.0 (5.0)
12. ODBC Source
13. More options are available under Connection Properties
14. OLEDB Source
15. More options are available under Connection Properties
16. SQL Connection
17. More options are available under Connection Properties
Note: The Browse button will show a Connection Properties window when selected data source type is, ODBC Source or, OLEDB Source or, SQL Connection.
Note: If you receive any message other than "Connection Succeeded" like "Could not open connection" then make sure you made the right selection or provided the right
options. If you are still not getting the "Connection Succeeded" message, check the log file. Go to Enable Advanced Logging for more details.
When setting up a database connection, the user should pick the Test Connection button before leaving the database source setup. When an error occurs, a common source for
the error is a mismatch between a 32-bit database engine and a 64-bit hydraulic model or vice versa. The user can either select the version of the hydraulic model that matches
the database or modify the database engine to match the hydraulic model.
When opening a 64-bit database file from 32-bit model, the message is:
"This file type requires the Microsoft Access Database Engine 2010 (32-bit) to be installed. Please contact your system administrator."
When opening a 32-bit database file from a 64-bit model, the message is:
"This file type requires the Microsoft Access Database Engine 2010 (64-bit) to be installed. Please contact your system administrator."
[Link] 2025/06/14
Creating Your Model Page 157 of 174
To check on the bitness of the hydraulic model, the use should open the Welcome dialog (File > Help > Welcome dialog) and the bitness is displayed at the bottom of the dialog.
In general, the 64-bit version of the Bentley hydraulic model opens by default. The 32-bit version can be opened from:
To obtain a different version of the Microsoft database engine, go to the "Microsoft Access Database Engine" from [Link].
This issue also affects ModelBuilder imports. The user can obtain more details from the following wiki article:
[Link]
engine-2010-64-bit-is-required-to-access-this-data-source
Database Source
Custom Queries
Database Source
The Database Source option will allow defining the Table Name and related fields for SCADA connection created on Connection Manager. If there are more than one table where
the SCADA information are stored then multiple database sources need to be created.
For example: If SCADA stores instantaneous data on a table called "LiveData" and the historical data are stored or backed up on a table called "HistoricalData" then two database
source connections are required to communicate with each table.
It's always a good idea to label the database source connection with the Table Name as this database source connection will be referred at other locations.
There isn't any restriction on the order of any column or any limitation on number of rows in any data table. There are two formats for database files:
1. Each row contains one value and a column should store one type of information, such as Date should only store date vales. Each row must contain the Data/Time, tag
(label) and value for the signal. It may also contain information as to whether the values are questionable. The following screen is just an example where the highlighted
columns can be mapped to SCADAConnect. For more details about signal mapping go to Signal Mapping.
2. Each row can contain multiple values. Each row must contain a data/time identified and multiple signal values associated with that time. The tags associated with each
column must be placed in the first row of the table.
[Link] 2025/06/14
Creating Your Model Page 158 of 174
4. If the source is a database, from the Connection drop down, select your connection that has been created on Connection Manager. If the drop down is not listing any
items, go to the Connection Manager and create a Database Connection as needed.
5. The Connection Ellipsis button (..) will open the Connection Manager directly.
6. If the source is an OPC server, the user must identify the computer on which the OPC server is located. This may be the computer running the model in which case, the
user would select "Local Machine". If it is a networked computer, it must contain the network location in the form //computer name. Because a computer may have
several OPC servers on it, once the computer is selected, the user must indicate which OPC server is to be used.
7. From the Table Name drop down, select the table which contains the SCADA data. In other words, you need to select the table where the SCADA is storing the data. It
could be historical data table or a real-time data table.
8. If Table Name drop down is not listing any items then make sure you have right connection is selected in connection drop down.
9. The Table Name Ellipsis Button will allow advanced user to provide custom queries. This is often used when the table provided in Table Name needs filtering or additional
manipulation. Custom queries can be applied to any database sources. For more details visit custom queries.
10. Example of a custom Table Name query: SELECT [ElementName], [ScadaDataValue], [FullDate] FROM ScadaDataTable;
11. Source format. The user must select from the two formats:
12. - One value per row
13. - Multiple values per row.
14. If the user selects One value per row the following steps apply:
15. From the Name drop down, select the field (or column) where the SCADA signal name that corresponds to hydraulic element are stored.
16. For example: The column which stores the "LakewoodTank" or "MainStreetBooster". These "LakewoodTank" or "MainStreetBooster" are like a tag name used by SCADA
to store the data. These "Lakewood Tank", "MainStreetBooster" tags will later be mapped to the Lakewood Tank and Main Street Pump element of the hydraulic model.
The name of the SCADA tag does not need to be the same as the name of the hydraulic model element. For example, Lakewood Tank may be mapped to T-7.
17. If the Name drop down is not listing any items then make sure you have right Table Name and/or right connection is selected in connection drop down.
18. From the Value drop down, select the field (or column) where the data read by SCADA are stored. These values (or numbers) will be imported to the hydraulic model.
These valves could be imported to different location in hydraulic model, such as Initial Settings, Darwin Calibrator etc.
19. If the Value drop down is not listing any items then make sure you have right Table Name and/or right connection is selected in connection drop down.
20. Check the Time Stamp Supported. If you SCADA data contains a field that stores date then check box. Without checking this box, the Time Stamp drop down will not be
editable and you will not be able to provide the date or time field and if Time Stamp is not provided, later, when importing the data from SCADA to the hydraulic model,
SCADAConnect will not be able to filter your SCADA data based on any 'From Date Time' and 'To Date Time' In other words, you must provide this to take full advantage of
SCADAConnect.
21. From the Time Stamp drop down, select the field (or column) where the time is stored. This Time Stamp field in SCADA data must have the full time such as 4/28/80
[Link] AM. If time and date are stored in separate field (or column), use custom queries or edit the SCADA time and date field.
22. If SCADA stores any attribute and flags the validity of the recorded data then it's a good idea to check the Questionable Supported box. If you SCADA does not flag a read
yet you want to create some logic and filter those reads then that is doable in SCADAConnect. For example, any flow value below 30 units can be disregarded. For more
details see ”Custom Queries’.
23. From the Questionable drop down, select the field (or column) where the data are stored. This field must be a Boolean type . If the Questionable data equals True, we can
ignore such data when viewing or importing any data to the hydraulic model. In other words you need to select a field (or column) where SCADAConnect stores the
flagged information.
24. If your SCADA does not flag a read yet you want to create some logic and filter those reads then that is doable in SCADAConnect. For example, any flow value below 30
units can be disregarded. For more details go to custom query.
25. Click the OK button in Data Source Manager.
If the user selects the Multiple values per row format, the following steps apply. (If the user selects Multiple values per row, it is not possible to use the Questionable field.)
First the Computer name combo box shows the accessible computer names. If the OPC server is installed on the current machine, the host name will be shown as "Local
machine" (Default for a new OPC source).
To choose the associated OPC-server a list of accessible OPC Data Access server available on the selected computer is shown in the combo box.
First the Computer name combo box shows the accessible computer names. If the OPC server is installed on the current machine, the host name will be shown as "Local
machine" (Default for a new OPC source).
To choose the associated OPC-server a list of accessible OPC Historical Data Access server available on the selected computer is shown in the combo box.
Custom Queries
Use Custom Queries to create a customized, intermediate data table that SCADAConnect can read. The query can add new fields based on available field values in the data
source, allowing data to be translated from a specific user format to the SCADAConnect format. It can also be used to add validation of the SCADA data.
For example, if the signal data supports a timestamp field, SCADAConnect expects the data to be presented in a single Date/Time field. However, if the timestamp in the data
source is stored in two separate fields, a custom query can be written to present the two fields to SCADAConnect as a single DateTime field.
This will generate an intermediate data table with all the fields from the table plus a new calculated field called TimeStamp that contains the Date/Time values. This TimeStamp
field is the field name that should be entered in the Time Stamp of Data Source Manager dialog.
Another example would be to use a query that will add extra data validation to remove errors. If signal values are known to always be within a certain range, the following query
could be written to mark those signals as Questionable and then allow SCADAConnect to skip those values.
[Link] 2025/06/14
Creating Your Model Page 159 of 174
This will generate a field called Questionable that can be used in the Questionable of Data Source Manager dialog. When the data is read by SCADAConnect, data records with
values outside this range will have the Questionable field set to TRUE, and SCADAConnect will discard the value.
Note: When custom queries are entered, they should have valid SQL syntax for the data source being used. Custom queries are sent to the database provider and therefore the
Advanced Options of the Connection Manager do not apply to these queries.
Signal Mapping
Signal mapping is a process of particularizing assigning a SCADA signal (or SCADA tag or name) to a hydraulic element. Options like selecting a Data source, specifying the target
of imported data such as Calibration field datasets, Element Initial Settings, Element User Data Extensions, etc. are available in Signal Mapping Editor.
Within SCADAConnect, right click on any element type and select Add Signal. For example, right click on Junction - 0 signal(s) and select Add Signal.
If a signal already exists then right clicking on that signal will provide options to Delete Signal or Edit Signal. Clicking on Edit Signal will launch the SCADA Signal Editor.
1. Provide custom label: In Provide custom label, you can specify a user supplied custom name to mapped signal. This option is particularly helpful when the signal name is
cryptic and long, which make navigation less comfortable.
2. Check this Provide custom label box to provide a custom label which will be displayed in SCADAConnect main window. If this box is not checked then signal name in
SCADAConnect window will automatically be generated based on the options selected under Signal/Element mapping group.
3. Signal/Element mapping: Main mapping of SCADA signal to a hydraulic model element goes in this group. Signal mapping is a process of saying, for example, my ABC
attribute in the Name field of my SCADA data corresponds to XYZ of a hydraulic model. First select the data source from which the signal should be read. From the SCADA
signal name drop down, select the signal (or SCADA tag name) that you intend to map with a hydraulic element, for example, "LakewoodTank Level" or
"MainStreetBooster flow rate ". If the SCADA data contains two or more type of attributes corresponding to the same hydraulic element, two or more number of signals
need to be mapped in SCADAConnect. For example: SCADA stores information about flow as well as pressure out of the "MainStreetBooster" then corresponding to each
attribute, one for the flow and one for the pressure, needs to be mapped.
[Link] 2025/06/14
Creating Your Model Page 160 of 174
4. Click on the Target Element Ellipsis button. The Find window will open and type in the element ID or label that you wish to map to, for example, Lakewood Tank or Main
Street Pump or 420. Click on Find [ICON] button. This will search and list all the available element(s) that matched the search criteria.
5. Select the interested element and click OK on the Find window.
If Calibration field data sets is checked under the Data Destinations group of SCADA Signal Mapping window, you will be able to import the data to the Darwin Calibrator.
Specifying the correct SCADA Signal Data Sources are equally important as well, otherwise data may get imported from an unintended database source.
Before loading any data to the hydraulic model, make sure the units are correctly specified. For more information, go to XREF units.
There are four different ways to utilize/visualize the imported SCADA data.
When Real-time option is selected, SCADAConnect will import the latest data stored by the SCADA system. If a SCADA System is storing data at every 15 minute interval, say at
1:00 AM, 1:15 AM, 1:30 AM and so on, and SCADAConnect is used to load the real-time data at 1:35AM, it will import the data stored at 1:30AM.
1. Within in SCADAConnect window, click on Tools > Load to Calibrator Field Dataset.
[Link] 2025/06/14
Creating Your Model Page 161 of 174
1. Within the SCADAConnect window, click on Tools > Load to Initial Settings.
2. The Load Initial Settings dialog opens.
Options under Load Initial Settings are categorized under following groups:
• Import Option: Specify whether data from Historical database source or Real-time database source should be used while fetching the SCADA data.
• Target Scenario: When an existing scenario is provided in the Existing Scenario drop down, initial settings data of the hydraulic model will be overwritten by the fetched
SCADA data.
• A new scenario can also be created by selecting New Scenario option. Specify the name of the newly created scenario and the Parent Scenario of this new scenario. If
<None> is selected, a new base scenario will be created.
• Target Alternative: Similar to Target Scenario, specify whether the imported SCADA data should overwrite the existing data or create a new alternative. To overwrite the
existing hydraulic data, select Existing Alternative and select the desired alternative from the drop down. Accordingly, to create a new alternative, select New Alternative,
provide a name and then select the Parent Alternative. If <None> is selected, a new base alternative will be created.
• Selection Set: A selection set, containing elements whose data were imported will be created when Create a selection-set of elements having SCADA signals is checked.
This method is particularly helpful to double check the updated elements attribute.
Once the data is in a field of a hydraulic model, you can access the data of that field in Flex Table, Graph, Color-coding, Annotations, etc.
[Link] 2025/06/14
Creating Your Model Page 162 of 174
3. There are four major options group available under Load Extended Data.
4. Import Option: Specify whether data from Historical database source or Real-time database source should be used while fetching the SCADA data.
5. Target Scenario: When an existing scenario is provided in the Existing Scenario drop down, initial settings data of the hydraulic model will be overwritten by the fetched
SCADA data.
6. A new scenario can also be created by selecting New Scenario option. Specify the name of the newly created scenario and the Parent Scenario of this new scenario. If
<None> is selected, a new base scenario will be created.
7. Target Alternative: Similar to Target Scenario, specify whether the imported SCADA data should overwrite the existing data or create a new alternative. To overwrite the
existing hydraulic data, select Existing Alternative and select the desired alternative from the drop down. Accordingly, to create a new alternative, select New Alternative,
provide a name and then select the Parent Alternative. If <None> is selected, a new base alternative will be created.
8. Selection Set: A selection set, containing elements whose data were imported will be created when Create a selection-set of elements having SCADA signals is checked.
This method is particularly helpful to double check the updated elements attribute.
9. Once the information are provided on above four options, Click OK on Load Extended Data dialog box to complete the import process.
• Graph
• Graph with Questionable Values
• Create Time Series
• Create Time Series with Questionable Values
To view the SCADA data, signal mapping, providing database source and providing the connection gateway are necessary. During the entire process of viewing SCADA data, data
are temporarily loaded to the SCADAConnect directly from the SCADA data source, none of the data displayed here are loaded or imported to the hydraulic model element.
Note: Only SCADA signals that are associated with elements that are active in the current scenario are updated.
[Link] 2025/06/14
Creating Your Model Page 163 of 174
Graph
Graph
To view a graph of any mapped signal follow the steps described below. However, to learn more about graphing, see ”Graphs’.
[Link] 2025/06/14
Creating Your Model Page 164 of 174
Since the graph is displayed on Standard User Interface of the hydraulic model, native command of graph window can be utilized.
For example, if a pressure SCADA data are viewed in graph, then from Add to Graph button of the Graph you can add any desired element from a Bentley SewerGEMS EPS run
and compare the data directly.
Note: If SCADA data contains Questionable value = TRUE, then such data will be discarded and not be displayed in the Graph.
• Graph with Questionable Values: When this option is selected, the SCADAConnect will not filter any data on Questionable field (or column) and will display all the
attributes in the graph.
• Create Time Series: To create ”Time Series Field Data’ using the SCADA Data, right click on any mapped signal in the SCADA Data window and select Create Time Series.
• A message box confirming the creation of the Time Series Field Data will be displayed. To check the newly exported data go to Components > Time Series Field Data.
• Create Time Series with Questionable Values: When this option is selected, the SCADAConnect will not filter any data on Questionable field (or column) and will export all
the attributes in the Time Series Field Data.
Demand Inversing
Demand inversing is a method to adjust the assigned pressure junction demands in the water model to accurately match the real world demands. To calculate the real demands,
Demand inversing requires the user to identify the boundaries of each zone, the inflow and outflow points, the tanks signals, and the SCADA tag associated with each value
needed.
With this information, and SCADA data for a full day, the real world total daily demands of each zone can be calculated. The application can then find a multiplication factor that
can be applied to each pressure junction's demand field in the model to make the simulated zone demand equal to the real world demand for that day.
Note: To run this tool, you must have one or more Zones defined in your model.
1. Open Demand Inversing tool. (Within SCADAConnect, Tools > Demand Inversing).
2. Update all the tabs (Calculations, Reference Consumption, Flow Signals and Tank Signals) as necessary. See ”Demand Inversing Dialog Box’. Make sure that the zones for
which demands are being calculated have been selected in the "Reference Consumption" tab.
3. Go the Compute menu and execute Estimate Zone Flow or Demand Multiplier. The Estimate Zone Flow command will compute the model over a 24-hour period and
calculate the Estimated Daily Zone Demand Volume value in the "Reference Consumption" tab. This can be useful if the daily zone demand of the physical system is
known and you want to manually compute a user-defined demand multiplier that can be applied to the demands. More often the Demand Multiplier command is used,
which computes the Estimated Daily Zone Demand Volume value as described above, but also reads the SCADA data from a given day and calculates the Daily Zone
Demand Volume from SCADA data value. It then does a simple calculation between the estimated daily flow and the measured SCADA daily flow to come up with a
Demand Multiplier.
4. To have SCADAConnect create or update a demand alternative, go to Update and click on Write Demands. This will update the demand alternative by applying the
Demand Multiplier to every input demand value in the selected zone of the model, make the simulation's demand usage match the data gotten from the physcial system.
If no errors are encountered in the process SCADAConnect will and issue a message "Demand Alternative <name> Successfully Created." If the demand alternative does
not show up in the alternative manager, click to Expand All in the alternative docking manager to force a refresh of the tree and see it.
[Link] 2025/06/14
Creating Your Model Page 165 of 174
Tabs:
• Calculations: In calculation tab, you can provide the destination alternative of the calculated demand. Demand can either be overwritten or a new demand alternative can
be created.
• To overwrite an existing demand alternative, select the desired alternative from the drop down. And, to create a new alternative, select the Create New Alternative and
provide a name. If you want this alternative to be a child of an existing alternative, select the alternative from Parent Alternative.
• Reference Consumption: In this section, information about the demand (or consumption), the zone and the scenario needs to be populated and therefore the hydraulic
model must have zone(s) specified otherwise Demand inversing tool will not run. The Reference Consumption tab looks like this:
• Zone Name: Select and configure each zone that was selected to calculate in Reference Consumption tab.
[Link] 2025/06/14
Creating Your Model Page 166 of 174
• Zone Name: Select and configure each zone that was selected to calculate in Reference Consumption tab.
Menu Items:
Options
SCADAConnect includes customization Options, divided into the following tabs:
”Advanced’
[Link] 2025/06/14
Creating Your Model Page 167 of 174
For example, if flow is stored in L/s in SCADA system, then select L/s unit for Flow. These can be different from the units for that attribute in the hydraulic model.
Note: Units must be set to the units of the SCADA data. Units that are set in the hydraulic model do not matter.
Advanced
Time tolerance: SCADA data may not be available at the time that the user requests it depending on the polling interval of the SCADA system. In order not to miss a valid data
point because it does not fall exactly at the requested time, the user can specify a Tolerance. Specify the time tolerance for retrieval of historical data from the SCADA database.
Time tolerance refers to the intervals centered about the specified time for the historical data query. The time tolerance should be large enough to cover the full range of signals
to be retrieved. This is defined by the SCADA polling interval.
For example, if the time of a field data set for a historical data import is [Link], then a time tolerance of three (3) minutes specifies a time span of six (6) minutes, from
[Link] to [Link]. This time span defines the query made against the SCADA system historical data by SCADAConnect and thus defines the range of valid time stamps for data
loaded from the SCADA system into the model field data set.
Note: The time tolerance should be set to the smallest value possible that captures a full snapshot of SCADA data. Avoid unnecessarily large settings. Only whole numbers can be
entered.
Note: The time tolerance only applies for a historical import in which historical data from the SCADA system are returned for the specified time span.
Enable Advanced Logging: When this check box is checked, the hydraulic model maintains a text log file. This log file will specially be helpful when you are not able to import the
data and want to figure out what is occurring. Sometime this file may content technical terms which are beyond the normal hydraulic modeler. After looking at this log file, if you
could not resolve the issue, contact Bentley Technical Support.
Generally the default location to this log file is at the following location:
[Link] 2025/06/14
Creating Your Model Page 168 of 174
”Annotating’
Color-coding
Annotating
SCADA Signals in Network Navigator
Importing Historical Control Overrides with SCADAConnect
Color-coding
In order to color-code the elements in the drawing, the SCADA data must be imported to User Data Extension (UDX). To import the SCADA data into a UDX field follow the steps
provided in Load Extended Data.
Steps to color-code:
Annotating
In order to annotate the elements in the drawing, the SCADA data must be imported to User Data Extension (UDX). To import the SCADA data into a UDX field follow the steps
provided in Load Extended Data.
[Link] 2025/06/14
Creating Your Model Page 169 of 174
For example, a pump may normally be turned on and off in the model using control statements based on a tank water level. However, on a given day, an operator may have
decided to override those settings and turn the pump off at 3:15 pm and turn it back on at 5:25 pm regardless of control settings. Historical overrides can be used to extract
those pump switches from historical SCADA data and use those times rather than the control statements in the model.
There must be a SCADA signal element for each value to be imported and the SCADA connections must be set up before attempting to import. [see SCADA Signals]
The user picks Analysis > SCADA Connect Simulator. Historical overrides are imported to the Current Scenario, not the baseline scenario.
Using Historical Overrides is useful in calibrating EPS models where a user wants to focus on values like demand patterns and intends to force the pumps to perform exactly as
they did during the time that calibration data were collected.
The user then picks the Import Historical Overrides button from the ribbon CONFIGURE.
This opens the Import Historical Overrides Dialog: In the example below, the pump is turned on at 3:45 and off at 9:45 regardless of control statements in the scenario.
[Link] 2025/06/14
Creating Your Model Page 170 of 174
The filter section on the top of the dialog allows the user to choose the time period for the import of historical overrides for settings type import (e.g. pump speed), to specify a
tolerance for excluding small value changes from the overrides import and to select if signal values marked as "Questionable" should be use for the import.
Below the filter section on the left side a list of SCADA elements suitable for creating control overrides from historical SCADA data is shown. Right of this list a preview data table
and graph of the selected SCADA element in the list is shown. Only SCADA elements with a status or settings field and an assigned historical signal with available SCADA values
for the selected time period are shown.
The Refresh button enables the user to preview the changes in the filter section and cause an update of the preview data table and graph. The preview table and graph are also
updated on selecting a SCADA element in the SCADA element list, using the current input data in the filter section.
After reviewing the SCADA elements the user can press the Import button to start the import of new control overrides for the current scenario. The import time stamp is stored
in the Notes attribute of the control overrides and the complete import is undoable.
SQL Statements
Bentley SewerGEMS automatically provides SQL queries for obtaining the information it needs from the historian database (e.g. the list is available signal names, the data
associated with those signals, etc).
The provided SQL statements will often work as is, but we do offer the ability to provide custom SQL statements for your historian database. This allows you to take advantage of
optimizations and/or syntax that is specific to your particular historian.
Tip: Your historian will very likely provide a tool for viewing and querying historian data. You can use that tool to refine and test your custom SQL Statement to ensure it is
returning the appropriate results before entering it into Bentley SewerGEMS .
The customizations available to you will vary depending on whether you are querying Real-Time or Historical data, or the format of your data (e.g. one-value or many-values per
row).
To specify custom SQL statements, check the "Customize SQL Statements" checkbox (located at the top of the SQL Statements dialog).
If your source format is one-value-per-row, using historical-data, you can specify three custom queries:
1. Available Signals SQL Statement: This statement queries the database in a way to return the unique signals to use for the data source. Any valid SELECT statement is
allowed.
2. Signal Data SQL Statement - Historical, One Value per Row: This statement returns the signal data for a given date range.
3. Date/Time Range SQL Statement: This statement will return the date range to use for the signal data.
If your source format is multiple-values-per-row, using historical-data, you can specify two custom queries:
1. Available Signals SQL Statement: This query is not applicable in this case.
2. Signal Data SQL Statement - Historical, Multiple Values per Row: This statement returns the signal data for a given date range.
3. Date/Time Range SQL Statement: This statement will return the date range to use for the signal data.
If your source format is one-value-per-row, using real-time data, you can specify two custom queries:
1. Available Signals SQL Statement: Returns the list of unique signals from the data source.
2. Signal Data SQL Statement - Real-time, One Value per Row: This statement returns the signal data.
If your source format is multiple-values-per-row, using real-time data, you can specify a single custom query.
1. Available Signals SQL Statement: This query is not applicable in this case.
2. Signal Data SQL Statement - Real-time, Multiple Values per Row: Returns the signal data.
Note: When custom queries are entered, they should have valid SQL syntax. Be sure to test them against your historian first (as described above). If things do not appear to be
working as expected, review the SCADA log (from the SCADA Signals dialog) for warnings.
Note: The Advanced Options of the database connection do not apply to these queries.
[Link] 2025/06/14
Creating Your Model Page 171 of 174
Change Log
The change log is used to review changes to your model as you make them. The log entries include those for adding, deleting, restoring and modifying modeling elements. In
addition to modeling elements, entries are logged for adding, deleting, duplicating, and merging of alternatives.
By default, change tracking is disabled. You can control when tracking is enabled for new and existing hydraulic models.
To access the change tracking options, click the command button in the bottom-right corner of the Review group on the Review tab of the ribbon.
The change tracking options include options for both new and existing hydraulic models. The default for new hydraulic models is "Prompt". With this option, you are prompted
whether you want change tracking enabled or disabled.
You also have the option of “Track” and “Do Not Track”. If you select “Track”, then all new hydraulic models will have change tracking on by default. If you select “Do Not Track”
then all new hydraulic models will have change tracking disabled by default.
For existing models, the default is “Always Prompt”. You will only be prompted about change tracking for an existing model if it is not already tracked. You also have the option
of “Track” and “Do Not Track”. If you select “Track”, then all existing models you open that are not already being tracked will be tracked. If you select “Do Not Track” then all
existing models will continue to have tracking disabled.
The final option for existing models is “Prompt Once (for older models)”. This option applies to models saved in a previous release and not yet saved in the current release. You
are prompted whether you want change tracking enabled or disabled.
The prompt you get for either new or existing hydraulic models is the following:
The change log is a SQLite database with an extension of [Link] and is part of each individual project. This file is managed whether logging is enabled or disabled.
If you answer Yes, then the change lot is opened. If you click No, the change log is not opened.
When logging is enabled, and changes are made to your model, each change is logged.
This includes adding, deleting or restoring elements or making changes to individual properties of an element. This also includes using ModelBuilder when executing a synch-in
or global editing a column in a FlexTable. Each individual change is recorded in the log.
The change log shows you what those changes are in a tabular view.
When the change log is opened, the log file is automatically read and loaded into the table. You can stop the read at any time. The latest changes are displayed first in the table.
[Link] 2025/06/14
Creating Your Model Page 172 of 174
Column Description
Time Stamp This is the date/time when the action was added to the log file. The date/time in the table is in Local Time. The stored date/time is in Unix
UTC.
ID This is the ID of the element.
Type The type of element.
Label The current label of the element for the row. If the ID is no longer available (removed after a compact) the label shown as <deleted>. If the
element is deleted but the ID still available, the label is shown as <deleted: [label]>.
Change Type This is the change made to the element. Change types include added, deleted, restored and modified.
Context The context used for the change. This includes, but is not limited to, ModelBuilder, LoadBuilder, Skelebrator, general editing and undo/redo.
Field The label of the field that was changed.
NewValue The new value set to the field.
Scenario The label of the scenario.
Alternative Type The label of the alternative type.
Alternative ID The ID of the alternative for the change.
Alternative The label of the alternative.
User The username at the time of the change. This is either the Windows username (if NOT logged into CONNECTION Client) or the username of
the CONNECTED user.
Refresh The refresh button retrieves the latest log entries from the SQLite database. Uses the time stamp of the last log entry as the starting
point.
Copy The copy toolbar button copies the current table selection to the clipboard. The drop-down menu provides an option to include headers
when copying to the clipboard.
Filter Opens the filter dialog to allow filtering of the change log.
Zoom Zooms in the drawing the element of the selected row if the element still exists.
Find Opens the find dialog to search for text in the change log. The text in italic gray text is not searchable.
Select In Drawing Selects in the drawing the selected rows in the change log. Other options include add to selection, remove from selection, select within
current selection, open on selection and open on all rows.
Help Opens change log help.
For some log entries, you may notice gray italic text instead of standard text. This is special text notifying you of certain conditions.
<added> The text <added> shows in the following columns: Field, Scenario, Alternative Type and Alternative. The NewValue and Alternative ID columns
are blank. Only appears for the change type "Added".
<deleted> The text <deleted> shows in the following columns: Field, Scenario, Alternative Type and Alternative. The NewValue and Alternative ID columns
are blank. Only appears for the change type "Deleted".
<modeling> The text <modeling> shows in the following columns: Scenario, Alternative Type and Alternative. Only appears when modifying the fields Label,
Notes, GIS-IDs and GIS-IDs (Delimited) when the change type is "Modified".
<restored> The text <restored> shows in the following columns: Field, Scenario, Alternative Type and Alternative. The NewValue and Alternative ID columns
are blank. Only appears for the change type "Restored".
The text <restored> shows in the following columns: Field, Scenario, Alternative Type and Alternative. The NewValue and Alternative ID columns are blank. Only appears for the
change type "Restored".
[Link] 2025/06/14
Creating Your Model Page 173 of 174
Element (ID) A list of the unique IDs in the change log. ElementID IN (30,31,32)
Element Type A list of the unique [element] types in the change log. If you select one or more ElementTypeLabel IN ('PRV')
element types in the list, it will also filter down the unique values for the "Element
(ID)" and "Element (Label)" filters as well to include only those IDs and Labels that
are of the specified types.
Element (Label) A list of the unique [element] labels in the change log. ElementLabel IN ('PMP-1','PMP-2')
Change Type A list of the unique change types in the change log. ChangeType IN ('Modified','Restored')
Context A list of the unique contexts in the change log. ContextLabel IN ('ModelSize500Pipe')
Field A list of the unique fields modified in the change log. FieldLabel IN ('Start Node')
Scenario A list of the unique scenarios in the change log. ScenarioLabel IN ('Base')
Alternative Type A list of the unique alternative types in the change log. AlternativeTypeLabel IN ('Topology')
Alternative A list of the unique alternatives in the change log. AlternativeLabel IN ('Base Topology')
User A list of the unique users in the change log. User IN ('[Link]','Kristopher Culin')
If you turn on multiple filters the WHERE clause will combine the individual pieces into a single filter. For example, if you filter by “Element Type”, “Element (Label)” and “Change
Type” you get the combined WHERE clause:
Once the WHERE clause is put into the text field at the bottom of the change log dialog you can manually modify it. If you do not want to use “IN” (which looks for rows that
includes the following list) you can change it to “NOT IN” which will exclude rows that use the items.
The above change will look for entries that have types of PRV, Reservoir and Tank and labels of “Reservoir” but change types that are NOT Added.
Filter Behaviors
For the Element (ID) and Element (Label) filters, manual loading of the unique values is required. The number of unique IDs and Labels can be very large and this process may
take some time to complete. It is best to filter down your log first before loading the unique values for these two filters.
All other filters have a smaller refresh button in the upper-right corner. The default behavior refreshes the filter to show the unique values based on the current view of the
change log. You can also retrieve all unique values based on the entire change log by using the drop-down button and clicking "Get All Available Unique Values" menu item.
[Link] 2025/06/14
Creating Your Model Page 174 of 174
To open the Network Connectivity Reviewer tool, click Tools > More > Network Connectivity Reviewer.
• Generate Disconnected Subnetworks: Click to build the network and generate disconnected sub networks. The generated subnetworks and the number of links
(conduits and channels) are show in the list view.
• Zoom To And Select Elements: Select a subnetwork in the list and click this button to zoom to and select the elements in the subnetwork. You can also double-click an
subnetwork in the list to zoom to it and select the elements.
• Highlight Disconnected Subnetworks: Click to display adjacent subnetworks in different colors. Disconnected subnetworks with overlapping area and adjacent
subnetworks have different colors.
• Show Link Directions From Link Start Nodes To Stop Nodes: Click to show link direction as indicated by arrows in the drawing view. The link directions are from link
start nodes to stop nodes.
• Trace Upstream Using Link Direction From Link Start Nodes To Stop Nodes: Click to find and display upstream elements from a node or link. For an upstream trace, the
flow direction is assumed to be from the link start node to stop node. After a start element is selected, the upstream elements are selected and highlighted in the drawing
view.
• Trace Downstream Using Link Direction From Link Start Nodes To Stop Nodes: Click to find and display downstream elements from a node or link. For a downstream
trace, the flow direction is assumed to be from the link start node to stop node. After a start element is selected, the upstream elements are selected and highlighted in
the drawing view.
• Show Connected Elements: Click to find all of the elements in the subnetwork that are connected to the start element. The connected elements in the subnetwork are
selected and highlighted on the drawing view.
• Opens the online help for the Network Connectivity Reviewer.
Single isolated elements are not treated as subnetworks, so they are not shown in the Network Connectivity Reviewer dialog. Single isolated elements can be found by running
the Orphaned Nodes search in Network Navigator.
Only the following element types are supported for Trace Upstream, Trace Downstream, and Show Connected Elements operations:
• Manhole
• Catchbasin
• Pressure Junction
• Transition (Junction Chamber)
• Cross-section
• Pump
• Outfall
• Pond Outlet Structure
• Headwall
• Conduit
• Channel
• Pressure Pipe
• Gutter
[Link] 2025/06/14