WaterGEMS CONNECT Edition Help

Modeling Capabilities

Use the LINK format to set an initial concentration of a wall species within a particular pipe.
The initial concentration of a bulk species within a pipe is assumed equal to the initial concentration at the downstream
node of the pipe.
All initial concentrations are assumed to be zero unless otherwise specified in this section.
Models with equilibrium equations will require that reasonable initial conditions be set so that the equations are
solvable. For example, if they contain a ratio of species concentrations then a divide by zero condition will occur if all
initial concentrations are set to zero.
Examples:
[QUALITY]
;Set concentration of bulk species Cb to 1.0 at all nodes
GLOBAL Cb 1.0
;Override above condition for node N100
NODE N100 Cb 0.5
[PARAMETERS]
Purpose: Defines values for specific reaction rate parameters on a pipe by pipe or tank by tank basis.
Formats:
PIPE: pipeID paramID value
TANK: tankID paramID value
Definitions:
pipeID: the ID label of a pipe link in the network
tankID: the ID label of a tank node in the network
paramID: the name of one of the reaction rate parameters listed in the[COEFFICIENTS] section
value: the parameter's value used for the specified pipe or tank.
Remarks:
Use one line for each pipe or tank whose parameter value is different than the global value

Criticality Analysis

WaterGEMS CONNECT provides the user with a unique and flexible tool to evaluate a water distribution system and
identify the most critical elements.
There are two general types of criticality analysis:
1. Pipe/Segment study in which each selected pipe or system segment is isolated and the effect of the effect of that
shutdown is analyzed.
2. Valve study in which each valve is treated as inoperable and open and the effect on a shutdown in the segment
containing that valve is analyzed.
Criticality Analysis can be started by picking Analysis > Criticality from the ribbon.

1
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The user can shut down individual segments of the system and the results on system performance are determined.
Rather than having to do this through the scenario manager, the user will be able to simulate a set of outages in a single
run. This set can vary from a single element to each possible segment in a large system.
WaterGEMS CONNECT reports a variety of indicators for each outage during a criticality analysis. Depending on the
type of run, criticality analysis can report the flow shortfall, volume shortfall or pressure shortfall in the distribution
system for each segment outage.
Before being able to conduct a criticality analysis, WaterGEMS CONNECT must identify the segments to be removed
from service. Once the options have been set in a Criticality Studies level of the Segmentation and Criticality manager,
the user decides which scenario is to be used for the analysis and sets the rules for use of valving in the options tab.
In order to use criticality analysis, the user must make several decisions on the way that WaterGEMS CONNECT
performs the analysis. Each of those is described below.
Segments vs. Individual Pipes
When a distribution system outage occurs, the portion of the system that is taken out of service is referred to as a
“segment”. A “segment” or “Network segment” is the smallest portion of a distribution system that can be isolated by
valving.
The user must decide which elements will be used to identify segments. This is done under the options tab under
criticality studies. See the Segmentation (on page 508) section in the documentation for procedural details.
There are two general approaches to isolating portions of the system. The more correct way is to place all the isolating
valves on pipe elements. In this way WaterGEMS CONNECT can accurately identify which system elements are out of
service during an outage. In some cases however, the user does not have sufficient data on the location of isolating
valves. In this case, WaterGEMS CONNECT assumes that each pipe element can be isolated and each distribution
segment consists of a single pipe (not including the nodes at each end). The user identifies if isolating valves are to be
used in the analysis by checking the box next to “Consider Valves?” on the Options tab of the Criticality Studies level.
(Related to this is the ability of the user to identify if a valve is to be considered the boundary of a segment all of the
time, only when it is closed in the selected scenario, or never.)
The figure below shows the segments that are identified if “Consider valves?” is checked. Note that the various colors
assigned to elements by the program are not representative of any network attribute but are only used to differentiate
adjacent segments.

The figure below shows the segments that are identified when the “Consider valves?” box is unchecked.

2
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The user then picks the scenario to be used in the analysis by clicking New and picking the scenario from the list of
available scenarios. Depending on the scenario selected, the criticality analysis will be either a steady state or extended
period simulation and will use or not use pressure dependent demands (PDD). (If a fire flow analysis scenario is
selected, it is treated as a steady state and if a water quality scenario is selected, it is treated as an EPS.)
In the scenario picker dialog, you can select one of two study types. The default is “Critical Pipes/Segments”. The
second option is “Critical Valves”. In order to use the critical valves study type, you must use valves in your model,
either control valves or isolation valves (recommended). You can create a study of each type (Pipes/Segments or
Valves) for the same scenario but you cannot create more than one study type for a single scenario. i.e. You cannot
create two “Critical Pipes/Segments” studies for the scenario “Base”. You can create one “Critical Pipes/Segments”
study and one “Critical Valves” study.

3
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Once the scenario has been selected for segmentation, the user can then decide if segments should be identified for the
entire network or a subset of the network in the tab called “Segmentation scope”. If the scope of the segmentation
analysis is a Subset of the system, an ellipse (…) button becomes available. By clicking this button, the user can decide
on the elements to include using boxes, queries, polygons, or picking individual elements. Including any element in the
Segmentation Scope means that the segment containing that element will be included in the segmentation and
subsequent criticality analysis. Boundary elements between segments are not used if they are included in the
Segmentation Scope. When done, the user right clicks and returns to segmentation scope. With the name of the scenario
highlighted, clicking the GO arrow will start the segmentation. To delete the list of elements from the Segmentation
Scope selection, pick the ellipse button and then pick the Clear button (last one on right).

Outage Segments
When a segment is taken out of service in a looped or multi-source system, virtually all of the other segments remain in
service. However, in tree shaped systems, removing one segment from service also takes downstream segments out of
service. These downstream segments are referred to as “Outage Segments”. To determine outage segments, highlight
the Outage Segments level of the left pane and click the Go arrow. This will identify all outage segments.
Viewing and zooming to outage segments is similar to these operations in regular network segments. Segments must be
identified before outage segments can be identified. In most cases in looped systems, the isolating segments usually
contain no elements. However, there may be some surprises which can provide some insights into the adequacy of
valving in a system.
The figure below shows the network segment that is being isolated in blue and the corresponding outage segment in
red. Note that the various colors assigned to elements by the program are not representative of any network attribute but
are only used to differentiate adjacent segments.

This system which at first looks as if it has adequate valving and parallel piping has a serious problem because of
valving in the blue segment results in a large outage segment.
Determining the outage segments for a critical valve study works the same as critical pipe/segment studies. The only
difference is that the valve being closed is highlighted in green. Also note that the segments are determined differently
than critical pipe/segments. In the screen capture below, ISO-4 is closed. The corresponding segment is shown in blue
and the elements affected by this outage is highlighted in red.

4
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Running Criticality Analysis

After segments have been identified (not necessary to run outage segments), WaterGEMS CONNECT can calculate the
performance of the system when each segment is taken out of service. This is done by clicking on the Criticality button
and hitting the Go arrow.
An important consideration in running criticality is whether the criticality is based on a full hydraulic analysis or simply
the connectivity of the system. If the user checks the box labeled “Run hydraulic engine”, WaterGEMS CONNECT
will calculate the shortfall in the system based on a full hydraulic analysis. The type of run (steady vs. EPS; PDD vs.
non-PDD) is determined by the calculation options of the selected scenario.
If the box is unchecked, WaterGEMS CONNECT calculates shortfall based on connectivity. In that case, if a node is
connected back to a source, it is assumed the demand is met. If the node is isolated for the source, it is assumed that it is
not.

Understanding shortfalls
The criticality analysis works by identifying the shortfalls that occur when a segment is taken out of service. Depending
on the type of analysis, different indicators of shortfall (i.e. drop in system performance) are used. The types of
indicators of shortfall for each type of analysis are summarized in the table below.

Run with Hydraulic PDD? Steady State/EPS Flow Results Pressure Results
Engine

No N/A N/A No flow if not N/A

connected

Yes No EPS No flow if not Max Pressure Drop

connected

Yes No Steady State No flow if not Max Pressure Drop

connected

Yes Yes EPS Volume reduction Max Pressure Drop

Yes Yes Steady State Flow Reduction Max Pressure Drop

5
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Criticality Results
Criticality results give an indication of the importance of the shutdown of a segment in terms of the amount of demand
met. There are several different indicators depending on the type of analysis selected.
In some cases, especially when EPS runs are being made, the system that results during a segment shutdown may be
one that can't be solved hydraulically because large numbers of nodes are disconnected from the system. In that case,
the Is Balanced check box will not be checked. Users should look carefully at those segments to determine the
importance of such an outage.
The key indicator of the importance of shutting down a segment is the System Demand Shortfall (%). When it is large
(and the system is balanced), outage of the segment will have serious impacts. The results will be different depending
on the type of analysis and:
• Whether the scenario uses Pressure Dependent Demand (PDD) or non-PDD calculation options
• Whether the results are based on connectivity only (Run hydraulic engine not checked), a steady state scenario or an
EPS scenario
It is generally advisable to use PDD-based scenarios for criticality. Otherwise demands will be met regardless of the
pressure as long as the pressure exceeds Minimum Pressure Required to Meet Demand (displayed at the top of the right
pane). With PDD, a continuous relationship between demand met and pressure is used.
While actual water users are located along pipes, the model represents them as being located at nodes. Segments which
are located entirely within a single pipe element in a looped system will have no shortfall even though there may be
water users along the pipe.
The user-defined Maximum Allowable Demand Shortfall field is used to indicate whether the System Demand
Shortfall criteria are satisfied. When Maximum Allowable Demand Shortfall is larger than the System Demand
Shortfall, and Minimum Pressure to Supply Demand is smaller than Pressure Supplied at Worst Node, the "Are all
demands met?" property will be checked (True).
Interpretation of results also depends on the type of run:
• Connectivity only - In this case, demand will not be met only when the nodes are isolated from the source.
Otherwise it is assumed that demand is met when a node is connected.
• Steady-State run - With steady-state runs, the shortfall is based on calculated pressure and is useful for identifying
the results of outages which are not particularly long (such that the tanks drain). The shortfall includes demands that
are not met because the nodes are isolated plus demands that are not fully met because pressure drops.
• EPS runs - With EPS runs, the effects of tanks draining are also determined. With EPS runs it is much more likely
to have nodes that become disconnected such that the hydraulic calculations will not balance. While the
connectivity only and steady state runs are snapshots which give shortfall in flow units (e.g. gpm), the EPS runs
give results in volume units (e.g. gallons).
To compare between scenarios, the user should pick the Criticality Studies level of the left pane and view the bottom
half of the right pane. The Average System Shortfall is a good indicator for comparisons but is based only on segments
for which the hydraulic calculations are balanced.
Individual values in the criticality results are described below (in general, results from a steady run will be given as
Flow while results from an EPS run will be given as Volume; hence Flow/Volume is listed below):
• Are all demands met? - This is checked (True) only if the percent demand shortfall for this segment is less than the
Maximum Allowable Demand Shortfall in %. This will generally be unchecked because most segments will have
a node with a demand and the node is isolated from the system. When the default value for Maximum Allowable
Demand Shortfall is 0, then any segment that sees any drop in supply when closed will fail to meet demands (and

6
WaterGEMS CONNECT Edition Help
Modeling Capabilities

hence this box will be unchecked). This property may be checked if the demand inside the segment is 0 or if the
Maximum Allowable Demand Shortfall is set greater than 0. If the pressure at the node with the lowest pressure is
below the Minimum Pressure to Supply Demand, then "Are All Demands Met" will be unchecked.
• Is balanced? - This is checked if the hydraulic calculations are solved. For some segments, removing the segment
may affect the network so severely (e.g. disconnecting all the sources) that the calculations cannot be run. These are
usually segments that seriously affect the reliability of the network and the user should inspect these manually. If "Is
balanced?" is not checked, many of the results fields are N/A (not applicable.
• Maximum allowable demand shortfall (%) - This value defaults to 0%. However, for non-PDD runs, the user can
override this value by entering a value in the "Maximum allowable demand shortfall" field.
• System Demand (Full)/System Demanded Volume - This is the total of system demands when there are no segment
outages. It is given in flow units for steady runs and volume units for EPS runs.
• System Demand (Met)/System Supplied Volume - This is the total water supplied when the segment is out
of service in flow units for steady runs and volume units for EPS runs.
• System Demand Shortfall (%) - This value is calculated as 100%*[1-(Supplied/Demanded)].
• Node with Largest Percent Demand/Volume Shortfall - This is the node label for the node with the maximum
percent demand shortfall defined below. If there are no nodes with a shortfall, then this value and the next field are
set to (N/A).
• Flow/Volume Demanded at Worst Node - Demand - Supplied at node from previous field.
• Flow Supplied at Worst Node - Flow supplied at node identified in the previous field.
• Node with Largest Pressure Shortfall - Node with largest value of ("Min Pressure to Supply Demand" - Pressure).
This field is only used for non-PDD runs because pressure is handled differently in PDD. When the scenario calls
for PDD, the "Minimum Pressure to Supply Demand" property is ignored. If the value of Min Pressure to Supply
Demand is 0, then this value is not calculated and is set to (N/A).
• Pressure Demanded at Worst Node - Minimum pressure to supply demand at the worst node.
• Pressure Supplied at Worst Node - Actual pressure at Node with Largest Shortfall at the worst node.
In the case of non-PDD demands for steady runs, there are two situations for a given node that fails to meet demands.
1. Nodes that are disconnected by the segment outage in which case the demands are not included in the simulation.
2. Nodes that fail to meet minimum pressure in which case the demands are included in the simulation.
For the case of an EPS with Non-PDD demands, when choosing to "run hydraulic engine", the program checks the
pressure at each node at each time step, and identifies nodes that fall below the desired minimum pressure at any given
time. For criticality purposes, the program then assumes these nodes supply zero demand. Without PDD, the program
cannot determine the exact shortfall. However, the criticality results in this case will still be useful, as they will identify
nodes that have insufficient pressure.
In the criticality results, the "Node with largest percent demand shortfall" and "Node with largest volume shortfall" will
show the node that had the highest demand during the time when the pressure was below the desired minimum
pressure.

Segmentation
A distribution network segment is defined as the smallest portion of a distribution system that can be isolated.
Segments are used in the WaterGEMS CONNECT criticality analysis as the basic element of a system that can be
isolated so that the effects of an outage can be evaluated.
WaterGEMS CONNECT allows a user to set up two types of segments:
1. Using valves - A segment is created when valves are closed to isolate a portion of a distribution system. If the user
has entered isolating valves and these valves are assigned to pipes, then WaterGEMS CONNECT automatically
identifies segments. These segments can consist of a portion of a single pipe or several pipes and their

7
WaterGEMS CONNECT Edition Help
Modeling Capabilities

interconnecting node elements. The user selects this type of segment by checking the "Consider valves?" box in the
Options tab of the Criticality Studies manager.
2. Pipe-by-pipe - In some cases a user wants to conduct a criticality analysis but does not have information on the
location of isolating valves. In this case, WaterGEMS CONNECT will create segments such that there is one pipe
link in each segment. The nodes at the end of the pipe links are not part of the segment when this method is used.
The user selects this type of segment by unchecking the "Consider valves?" box in the Options tab of the Criticality
Studies manager. This type of analysis is less accurate than that using valves but still can provide insights in terms
of reliability.
3. Valve-by-valve – in some cases a user wants to analyze the effect of having an inoperable valve on the size of a
segment and the resulting shortfalls if one of these larger segments. This is useful for prioritizing valves which need
exercising and maintenance. . In this analysis each selected valve is treated as inoperable in the open position and
the resulting new segment is created and its properties determined. The segment is bounded by the elements that
need to be closed in order to isolate the valve. The new segments created based on the inoperable valve are labeled
using the label of the inoperable valve.

Note: The option "Consider Valves in Critical Pipe/Segment Analysis" is only applied for critical pipe/segment
studies. For a valve-by-valve analysis, valves are always considered.

The first figure below shows a simple pipe network with valves:

8
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If the "Consider valves?" Option is selected, then the segments (identified by color) are created based on valves that can
be closed. The segments are identified by color in the figure below. Note that the various colors assigned to elements by
the program are not representative of any network attribute, but are only used to differentiate adjacent segments.

9
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If on the other hand, "Consider valves?" is unchecked, then each segment consists of one and only one pipe as shown
below.

10
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If you are analyzing critical valves, then the segments are determined differently.

Note: With critical valves, you cannot highlight all segments at once. You can highlight only one segment at a
time as segments generally overlap each other.

The option where valving is considered is a much more accurate reflection of the portion of the system that is out of
service during a shutdown. Using the pipe-by-pipe segments can be misleading in come cases. For example if pipe P-8
is removed from the system, then by considering valving, the user can see that all downstream customers are out of
service. However, in the pipe-by-pipe case, J-1 and J-6 are still in service and it looks as if downstream customers can
be served.
Of course, to consider valves in the system, the isolating valves must be part of the pipe network. Adding isolating
valves is explained in topic "Valves - Isolating."
Depending on the approach used by the modeler, elements such as PRVs and General Purpose Valves may also be used
to isolate segments. For each of these types of elements, the user can indicate whether they should be used to isolate the
system. For each type of element, the user has three options:
• Always use (default) - valve is treated as an isolating valve for segmentation
• Use when closed - status of closed if assigned in initial conditions for that scenario

11
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Do not use - does not use valve as boundary to segment

There are several buttons on top of the middle pane in the segmentation manager that are used to control the display of
segments in the drawing and use of segmentation results.
The first button enables the user to Create a Selection Set including all of the elements from a specific segment. When
the user picks this button, the user is given an opportunity to name the selection set. Hitting OK creates the selection
set. The set includes pipes that are only partly in that segment. The user can also add the elements in the segment to a
selection set or remove them from a selection set.
The second button Zooms to the selected segment and highlights the elements in that segment. If a pipe is only partly in
that segment, the entire pipe is highlighted.
The Find in Drawing button is used to pick an element from the drawing and determine which segment it lies in. When
the user picks Find, he is given a "Select from Drawing" prompt and must pick an element. The segment that the user
picks is then highlighted in the middle pane list of segments and the details are given in the right pane. If a segment
boundary valve is picked, then the segments on both sides of the valve are highlighted.
The Highlight Segments button color codes the drawing such that each segment has a different color. If All Segments is
selected in the middle pane, then all segments are color coded and if one is selected, only that segment is color coded.
Repeating this selection toggles off this color coding. This color coding is not a property of the element and as such is
not handled by the Element Symbology tool and if an element is moved after this color coding, the color coding is not
moved. It is usually advisable to minimize the segmentation dialog when viewing color coding.

For criticality valve studies, you must select a single segment for highlighting. If you select “All Segments” then only
the first segment in the list is highlighted. This is because segments are generally overlapped when analyzing critical
valves where critical pipes normally do not have overlapping segments.
The next button is the standard Refresh button which refreshes the drawing if needed.
The next button is the Report button which generates a report for printing.

12
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Segmentation Results
The results of a segmentation analysis are shown in the right panes of the Criticality manager. The top half contains one
line for each segment.
The segmentation results can be used to find segments which will become maintenance problems during a shutdown.
To find troublesome segments, it is best to sort the segmentation results by right clicking on the appropriate column and
choosing Sort Descending.
To find segments that require a large number of valves to be shut in order to isolate the segment, sort the Isolation
Elements column. Then pick the segments that have the highest number of isolation elements and zoom to them to see
where problem segments might exist.
To find the segments that are most likely to put a large number of customers out of service or are most likely to break,
sort based on the length of pipe in the segment. If segments have a relatively even break rate, then the longest ones will
have the most breaks and the longest ones are most likely to have the most customers out of service.
Sorting by Fluid Volume in the segment will give an indication of the amount of water that must be drained from the
segment in order to de-water the pipe for repair.
The bottom half of the right pane gives details about the nodes included in each segment, the pipes involved in each
segment and the isolating nodes needed to shut down each segment. In this portion of the results, there is one line for
each element as opposed to the top half where there is one line for each segment. Usually this is best used by picking an
individual segment from the middle pane and viewing the details of that segment.
To compare segmentation results between scenarios, the user should pick the Criticality Studies level at the top of the
left pane. The top of the associated summary right pane (Segmentation Results Summary) gives overall statistics for
each scenario. Usually the results are similar between scenarios unless they use different topologies in terms of valves.

Note: By default, affected elements are included when highlighting one or more segments. To exclude affected
elements from the highlight, click the Highlight Segments button and then untick “Include Affected Elements in
Highlight”. If you already have highlight on, this will automatically refresh the drawing. If highlight is off, the next
time you turn on highlighting it will not highlight affected elements.

Note: By default, affected customer meters are included when highlighting one or more segments. To exclude
affected customer meters from the highlight, click the Highlight Segments button and then untick “Include
Affected Customer Meters in Highlight”. If you already have highlight on, this will automatically refresh the
drawing. If highlight is off, the next time you turn on highlighting it will not highlight affected customer meters.

Note: The highlight toolbar button is on the toolbar above the list of segments.

Outage Segment Results

The outage segment results give an indication of which segments will be placed out of service when an upstream
segment is shut down. In highly looped systems with multiple sources, there will be very few non-zero length outage
segments, while in tree shaped segments with a single source, there will be numerous large outage segments.
The outages segment list may be sorted based on Outage Set Length. Large outage segments usually indicate portions
of the system where a single break or shutdown can place large numbers of customers out of service.
Use the zoom button on top of the middle pane to view the details of the individual outage segment sets and evaluate
approaches to improve the system.

13
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Note: By default, affected elements are included when highlighting an outage segment. To exclude affected
elements from the highlight, click the Highlight Outage Segment button and then untick “Include Affected
Elements in Highlight”. If you already have highlight on, this will automatically refresh the drawing. If highlight is
off, the next time you turn on highlighting it will not highlight affected elements.

Note: By default, affected customer meters are included when highlighting an outage segment. To exclude
affected customer meters, click the Highlight Outage Segment button and then untick “Include Affected Customer
Meters in Highlight”. If you already have highlight on, this will automatically refresh the drawing. If highlight is
off, the next time you turn on highlighting, it will not highlight affected customer meters.

Note: The highlight toolbar button is on the toolbar above the list of outage segments.

Calculation Options

Calculations depend on a variety of parameters that may be configured by you.

Choose Analysis > Calculation Options, Alt+3, or click the Calculation Options button to open the Calculations
Options dialog box.
The dialog contains the following controls:
• New: Creates a new calculation option.
• Duplicate: Makes a copy of the selected calculation option.
• Delete: Deletes the selected calculation option. The base calculation option cannot be deleted.
• Rename: Renames the selected calculation option.
• Help: Displays online help for the Calculation Options.
To view the Steady State/EPS Solver properties of the Base Calculation Options
Select Base Calculation Options under Steady State/EPS Solver and double click to open the Properties dialog box.
The following calculation option parameters are available for user configuration:
• Friction Method—Set the global friction method.
• Output Selection Set—Select whether to generate output for All Elements (the default setting) or only the
elements contained within the chosen selection set.
• Calculation Type—Select the type of analysis to perform with this calculation options set.
• Consider Pumps and Valves in Min. System Pressure Constraints?— If True the pressures at pumps and valves will
be considered.
• Demand Adjustments—Specify whether or not to apply adjustment factors to standard demands.
• Active Demand Adjustments—The collection of demand adjustments that are applied during the analysis.
• Unit Demand Adjustments—Specify whether or not to apply adjustment factors to unit demands.
• Active Unit Demand Adjustments—The collection of unit demand adjustments that are applied during the analysis.
• Roughness Adjustments—Specify whether or not to apply adjustment factors to roughnesses.
• Active Roughness Adjustments—The collection of roughness adjustments that are applied during the analysis.
• Display Status Messages?—If set to true, element status messages will be stored in the output and reported.
• Display Calculation Flags?—If set to true, calculation flags will be stored in the output and reported.
• Display Time Step Convergence Info?—If set to true, convergence/iteration data for each time step will be stored in
the output file and displayed in the calculation summary.
• Simulation Start Date—Select the calendar date on which the simulation begins.

14
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Time Analysis Type—Select whether the analysis is extended period or steady-state.

• Use simple controls during steady state?—When True, simple controls will be active during steady state analyses,
else they will not be used. Note that logical controls are never used during steady state analysis.
• Is EPS Snapshot?—If True then an EPS snapshot is run instead of a regular steady state run. An EPS snapshot is a
steady state run, but it considers the starting date and time of analysis and applies the appropriate pattern multipliers
for that time. Note that since an EPS is not run, attributes such as tank levels are derived from the same initial
conditions as a steady state run.
• Equivalent Hydraulic Time Step—In order that the pattern multipliers used in an EPS snapshot run exactly match
those in an equivalent EPS run, specify the hydraulic time step of the EPS run that you wish to match.
• Start Time—Select the clock time at which the simulation begins. Duration—Specify the total duration of an
extended period simulation.
• Hydraulic Time Step—Select the length of the calculation time step.
• Override Reporting Time Step?—Specify if you want the Reporting Time Step to differ from the Hydraulic Time
Step.
• Reporting Time Step—Data will be presented at every reporting time step. The reporting time step should be a
multiple of the hydraulic time step.
• Set Water Quality Time Step?—If set to True the Water Quality Time Step can be adjusted, otherwise it is
computed by the calcuation engine. It is not recommended that you set this to True.
• Water Quality Time Step—Time interval used to track water quality changes throughout the network. By default,
this value is computed by the numerical engine and is equivalent to the smallest travel time through any pipe in the
system.
• Engine Compatibility—This field allows you to choose which engine compatibility mode you want to run in.
Choose WaterGEMS CONNECT 2.00.12 to get all of the latest engine improvements and fixes made by Bentley
and an engine mode that is based upon EPANET 2.00.12. This is the default setting for new models. Choose
WaterGEMS 2.00.10 to maintain compatibility with previous version of WaterGEMS CONNECT (V8i
SELECTseries 1 and earlier), where the computational engine is based on EPANET 2.00.10. This is the default for
upgraded models. If you select one of the EPANET modes, any enhancements, calculation corrections, and bug
fixes made by Bentley will be disabled in order to match EPANET version results. Imported EPANET models will
default to the appropriate EPANET version.
• Use Linear Interpolation for Multipoint Pumps?—If set to true the engine will use linear interpolation to interpret
the pump curve as opposed to quadratic interpolation.
• Convergence Check Frequency—This option sets the number of solution trials that pass during hydraulic balancing
before the status of pumps, check valves, flow control valves, and pipes connected to tanks are updated. The default
value is 2, meaning that status checks are made every other trial. A value equal to the maximum number of trials
would mean that status checks are made only after the system has converged (whenever a status change occurs the
trials must continue since the current solution may not be balanced). The frequency of status checks on pressure
reducing and pressure sustaining valves is determined by the Damping Factor calculation option.
• Convergence Check Cut Off—This option is the number of solution trials after which periodic status checks on
pumps, check valves, flow control valves, and pipes connected to tanks are discontinued. Instead, a status check is
made only after convergence is achieved. The default value is 10, meaning that after 10 trials, instead of checking
status at every trial indicated by the Convergence Check Frequency setting, status is checked only at convergence.
• Damping Limit—This is the accuracy value at which solution damping and status checks on PRVs and PSVs should
begin. Damping limits all flow changes to 60 percent of what the would otherwise be as future trials unfold. The
default of 0 indicates that no damping should be used and that status checks on control valves are made at every
iteration. Damping might be needed on networks that have trouble converging, in which case a limit of 0.01 is
suggested (relative to the default calculation hydraulic accuracy of 0.001).
• Trials—Unitless number that defines the maximum number of iterations to be performed for each hydraulic
solution. The default value is 40.

15
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Accuracy—Unitless number that defines the convergence criteria for the iterative solution of the network hydraulic
equations. When the sum of the absolute flow changes between successive iterations in all links is divided by the
sum of the absolute flows in all links and is less than the Accuracy, the solution is said to have converged. The
default value is 0.001 and the minimum allowed value for Accuracy is 1.0e-5.
• Emitter Exponent—Emitters are devices associated with junctions that model the flow through a nozzle or orifice.
In these situations, the demand (i.e., the flow rate through the emitter) varies in proportion to the pressure at the
junction raised to some power. The constant of proportionality is termed the discharge coefficient. For nozzles and
sprinkler heads the exponent on pressure is 0.5 and the manufacturer usually states the value of the discharge
coefficient as the flow rate in gpm through the device at a 1 psi pressure drop.
• Liquid Label—Label that describes the type of liquid used in the simulation.
• Liquid Kinematic Viscosity—Ratio of the liquid's dynamic, or absolute viscosity to its mass density.
• Liquid Specific Gravity—Ratio of the specific weight of the liquid to the specific weight of water at 4 degrees C
or 39 degrees F.
• Minimum Possible Pressure—Lowest physically possible pressure. Should be based on vapor pressure of liquid at
temperature of interest. Pressure below this value will result in a warning message.
• Use Pressure Dependent Demand?—If set to true the flows at junctions and hydrants will be based on pressure
constraints.
• Age Tolerance—If the difference between two parcels of water is equal to or less than the value specified in this
field, the parcels are considered to be of equal age.
• Constituent Tolerance—If the difference between two parcels of water is equal to or less than the value specified in
this field, the parcels are considered to possess an equal concentration of the associated constituent.
• Trace Tolerance—If the difference between two parcels of water is equal to or less than the value specified in this
field, the parcels are considered to be within the same percentile.
To view the Base properties of the Transient Solver Calculation Options
Select Transient Solver Base Calculation Options and double click to open the Properties dialog box.
The following calculation option parameters are available for user configuration:
• Initial Flow Consistency—Flow changes that exceed the specified value are listed in the output log as a location at
which water hammer occurs as soon as simulation begins. The default value is 0.02 cfs.
• Initial Head Consistency—Head changes that exceed the specified value are listed in the output log as a location at
which water hammer occurs as soon as simulation begins. The default value is 0.1 ft.
• Friction Coefficient Criterion—For pipes whose Darcy-Weisbach friction coefficient exceeds this criterion, an
asterisk appears beside the coefficient in the pipe information table in the output log. The default value is 0.02.
• Report History After—Set the time at which reporting begins. The default value is 0.02.
• Show Extreme Heads After—Sets the time to start output of the maximum and minimum heads for a run. You can
set these to show beginning at time = 0 (right away), after the first maximum or minimum, or after a specified time
delay.
• Transient Friction Method—Select Steady, Quasi-Steady, or Unsteady friction method to be used for transient
calculations.
• Generate Standard Output Log?—Toggles the standard output file.
• Show Pocket Opening/Closing—Toggles whether the list of vapor pockets open and close times will be appended
to the output text file.
• Generate Detailed Reports?—Toggles the generation of ASCII output text files on or off. These can become
voluminous for simulations with many time steps and they are not required for the operation of the FlexTables or
graphics. Some users prefer to set this setting to False.
• Report Point History Type—Select All to generate point histories for all points in the text reports, or Only if On
Path to generate report Histories only for those points that lie on a path.
• Report Points—Choose the report points type from the following:

16
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• No Points—No report points are defined.

• All Points—All nodes in the model are report points.
• Selected Points—Selecting this option makes the Report Points Collection field active, allowing you to define
the report points.
• Report Points Collection—Clicking the ellipsis button in this field opens the Report Points Collection dialog,
allowing you to choose the report points from the list of available points, or select them in the drawing.
• Report Times—Choose whether to report Periodically, At Specific Times, At No Times, or At All Times.
• Report Period—Specify the equal intervals of time (default) at which reports are generated. This option is only
available when the Report Times property is set to Periodically.
• Report Times Collection—Opens the Report Times Collection dialog, allowing you to specify the times step to be
reported. This option is only available when the Report Period property is set to At Specific Times.
• Is User Defined Time Step?—Selects whether the time step is user-defined or automatically estimated.
• Time Step Interval— This option is only available when the Is User Defined Time Step? property is set to True.
• Run Duration Type—Selects whether the run duration is measured in time or time steps.
• Run Duration—Period of time simulated by the model.
• Pressure Wave Speed—Speed for the liquid being conveyed, the pipe material selected and its dimension ratio
(DR), bedding, and other factors.
• Vapor Pressure—Pressure below which a liquid changes phase and become a gas (steam for water), at a
given temperature and elevation.
• Wave Speed Reduction Factor—The low pressure wave speed reduction factor.
• Decrease Time—The time for the wave speed to decrease from its normal value to the reduced value at vapor
pressure.
• Increase Time—The time for the wave speed to increase from its reduced value to the normal value at vapor
pressure.
• Generate Animation Data—Set this property to True to generate animation data for selected report paths and points.
• Calculate Transient Force—Set this property to True to calculate transient forces.
• Run Extended CAV—Toggles the standard or extended Combination Air Valve (CAV) sub-model. The vacuum
breaker component of CAV admit air into the pipeline during low transient pressures that is subsequently expelled
at the outlet orifice(s). The extended model tracks momentum more accurately.
• Flow Tolerance—Flows below this value are assumed to be zero when running the transient calculations. This
option is generally used to filter out insignificant flows that could otherwise cause numerical problems during the
calculation. See Flow Tolerance for more details.
• Round Pipe Head Values?—Specifies whether pipe head values should be rounded or not. This option is
generally used to filer out insignificant differences that could otherwise cause numerical problems during the
calculation.
• Initialize Transient Run at Time—If the "Specify Initial Condition" field is set to True, the transient simulation is
initialized using results from a steady-state or extended period simulation. Enter a time here to initialize the
transient simulation using results from the corresponding EPS time step.
• Specify Initial Conditions?—If set to True, you can manually specify the initial conditions for a transient
simulation.
To create a new calculation option
1. Choose Analysis > Calculation Options and the Calculation Options dialog box opens.
2. Choose New.
3. Double-click on the newly created calculation option to open the Calculation Options Properties dialog box.
4. Set the fields for this calculation.
5. Close the properties box.
6. Close the Calculations Options box.

17
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Controlling Results Output

You can limit the output data that is written to the result file from the WaterGEMS CONNECT engine. Limiting the
reported results in this way will produce a smaller result file, thereby improving performance when copying results files
during open and save operations. It also conserves hard disk space.
By default, the Reporting Time Step Type calculation option is set to <All>. Under this setting, all results for all time
steps are written to the results file.
To limit the output results to a specific interval (such as every 2 hours, every 4 hours, etc) set the Reporting Time Step
Type calculation option to Constant. The Reporting Time Step calculation option will become available. Enter the
constant interval at which output results should be written to the results file in this field.
To limit the output results to specific time steps, set the Reporting Time Step Type calculation option to Variable. The
Reporting Time Steps calculation option will become available. Click the elipsis (...) button in this field to open the
Reporting Time Steps dialog.

Report Points Collection Dialog Box

This dialog allows you to specify which of the available points in the model will be report points.
Click the [>] button to add a highlighted point from the Available Items list to the Selected Items list.
Click the [>>] button to add all Available Items to the Selected Items list.
Click the [<] button to remove a highlighted point from the Selected Items list, returning it to the Available Items list.
Click the [<<] button to remove all report points from the Selected Items list, returning them to the Available Items list.
Click the Select From Drawing button to choose points from the drawing pane.

Flow Tolerance
The transient calculation requires that there is not excessive friction in the pipelines. In some cases when the initial flow
and headloss along a pipe are both very small, HAMMER will compute large friction factors for these pipes (generally
because very low velocities result in small Reynolds number values, which results in high friction factors under laminar
flow). This prompts an error message which prevents the model from running. To prevent this, it is possible to specify a
Flow Tolerance value below which any flow is rounded down to zero. This prevents the friction factor error, because
the friction factor for pipes with zero initial flow is based solely on the roughness parameter entered for the pipe.
However, if the Flow Tolerance is adjusted, it is suggested that the 'Round Pipe Head Values?' parameter is set to 'True'
and the pipe heads are rounded to a similar level of accuracy as the flows. This helps ensure that the head at either end
of a pipe with zero initial flow is the same.
Note however, that in the majority of cases it is suggested that the default value is used for these parameters.

Determining the Transient Run Duration

Run duration is measured either in seconds or as a number of time steps. HAMMER determines the length of each time
step automatically. Time steps typically range from a few hundredths of a second to a few seconds, depending on the

18
WaterGEMS CONNECT Edition Help
Modeling Capabilities

system and the pressure wave speeds. The run duration has a direct effect on the modeling computation time, along
with the time step selected for the simulation.
For simple systems or if the time required to compute the HAMMER model is not a concern, it is ideal (but not always
necessary) to set run durations long enough to allow a final steady state to be achieved once all transient energy
attenuates. This is quite manageable in many cases, such as for the sample file sample02.wtg, which requires about 30
to 40 seconds to reach a final steady state. Each system requires a different amount of time to reach a final steady state.
Transient Tip: Every pipe system has a characteristic time period, T = 2 L/a, where L is the longest possible path
through the system and a is the pressure wave speed. This period is the time it takes for a pressure wave to travel the
pipe system's greatest length two times. It is recommended that the run duration equal or exceed T. Another factor to
consider when determining run duration is to allow enough time for friction to significantly dampen the transient
energy. If in doubt, run HAMMER for a longer duration and examine the resulting graphs and time histories.
For larger systems, you can use the following guidelines to decide on the most appropriate run duration:
First run HAMMER for only a few time steps to identify the sources of transients (remember to output every time step
using the Report Times attribute of the Calculation Options). You can also check for input errors by clicking the
Validate button. Finally, click Compute to run the model, and then look for errors in the steady-state model or other
initial transients in the comments at the end of the output file (.out).
Run HAMMER again for a duration of T=4 L/a (or greater) to verify that your simulation includes the maximum and
minimum transient heads (Change the duration in the Calculation Options). These normally occur within this time
frame. A longer run duration may be required if air pockets form or if a gas vessel or surge tank is installed, due to the
persistence of oscillations in the system.
Run HAMMER again for a duration of T=20 L/a or greater, whatever is enough to allow friction to attenuate the
transient energy and, consequently, to let the system approach or achieve a final steady state. See Selecting the
Transient Friction Method (on page 522).
The preceding procedure increases the likelihood that you will correctly simulate the key aspects of the hydraulic
transient event for your system. However, remember that L is only a characteristic length which may not be directly
applicable to branched or looped networks or plants. Always use sound engineering judgment in reviewing HAMMER
results and interpreting the output.

Convergence Improvements for Control Valves

With WaterGEMS CONNECT version SS2, some improvements have been made to the numerical solver to increase
the stability of the solutions when control valves exist in the model. If the control valves are allowed to change status
with each iteration, then it is possible to have oscillating solutions that may not converge. With this version, users have
a much greater control over convergence in some situations with complicated control logic, especially those where
control valves can interact with one another.
An easy first step when a convergence problem exists is to increase the number of "Trials" (iterations) for each
solution. A default value of 40 is provided, but for systems with many complicated control valves, it may be necessary
to increase this value to permit the other valves described above a chance to achieve a solution. A value of 200 or more
is not unreasonable for problematic models. Since this is a global value it needs to be set high enough to cover the most
tricky time steps in the model. There is no adverse effect of having this value too high.
To prevent oscillations in solutions, the numerical solver can be allowed to make several iterations before it changes the
status of pumps, check valves, flow control valves and pipes connected to tanks. While this may mean that it takes
more iterations to reach a final solution, it tends to make the solution process more stable. The default value of this
parameter (called "Convergence Check Frequency" - see Calculation Options) is set to 2 but if there are multiple
control valves in the system and convergence problems are being encountered, this number can be increased. It should
be substantially less than the total number of allowable trials or else controls will not be allowed to find their correct

19
WaterGEMS CONNECT Edition Help
Modeling Capabilities

status. A representative increase in value from the default of 2, might be 10. Note that when "Convergence Check
Frequency" is increased it is likely necessary to make a corresponding increase in Convergence Check Cut Off. This
particular option is discussed below.
Once the status of valves has stabilized, the numerical solver can quickly converge to the solution. After a certain point,
it is not productive to check the status of pumps and valves. This number of iterations is called the "Convergence Check
Cut Off" and by default is set to 10. In models with complicated controls, it may be necessary to increase this value to
enable the controls to reach a stable set of values before their status becomes fixed. To do this, the convergence check
cut off should be increased to a number that is still less than or equal to the number of trials. An increase in this value
may be, but is not necessarily, accompanied by an increase in the previously described "Convergence Check
Frequency" value.
In order for the solution to not overshoot the correct values, the changes made in each iteration are controlled by
damping the size of changes. Usually the parameter "Damping Limit" is set to 0 by default which indicates that no
damping is needed. However, when numerical solutions have difficulty converging, this limit can be increased to
something roughly an order of magnitude larger than the flow "Accuracy" which is set to 0.001 by default. With that
default, a value for Damping limit of 0.01 should help to dampen out oscillations. With a value of 0.01 set it means that
when convergence of the solution comes to within an accuracy value of 0.01 (as opposed to the tighter 0.001 value)
damping will start by relaxing flow adjustments to 60% of the value they would be otherwise. Increasing the damping
limit even higher than 0.01 may help in particularly difficult cases since damping will be initiated earlier. In all cases
the damping limit needs to be relative to and higher than the calculation "Accuracy" value or 0 (damping off).
Another setting that can be modified to improve convergence that existed in the previous version of WaterGEMS
CONNECT is the "Accuracy" value. This value defines the measure by which the solution method determines whether
the hydraulic calculations are balanced. The default value is 0.001 which means the sum of the flow changes in all the
links from the previous trial to the current one is less than 0.1% of the sum of the flows in all the links in the system.
i.e., the numerical solution has converged to within a tight tolerance. This is a very conservative value. In some cases
for models that have many pipes with small or no flow, it may be necessary to increase the hydraulic accuracy value
(make the model slightly less accurate) to account for this relative measure of convergence.
There is a tradeoff between speed and stability in these numerical solutions. The default values are set with an emphasis
on performance and are good for typical systems. As these above options to dampen solutions are implemented, they
tend to slow the convergence. However, when working with systems with multiple interacting control valves, it may be
necessary to sacrifice performance for stability and change the numerical values described above.

Vapor Pressure
A liquid's vapor pressure limit is defined as the absolute pressure below which it flashes into its gas phase (vapor or
steam for water) for the fluid temperature at which the system is operating. Vapor pressure is a fundamental parameter
for any hydraulic transient analysis. Low transient pressures can cause a liquid to vaporize and, once one or more of
these vapor pockets collapse later on, result in very large transient pressures, which may break pipes or other system
components.

Note: For drinking-water systems at typical temperatures and pressures, HAMMER uses an approximate vapor
pressure of -10.0 m or -14.2 psi (gauge) or -32.8 ft. by default, depending on the unit system in use. Typically, a
liquid's vapor pressure can be obtained from tables (steam tables for water) given its temperature and absolute
(not gauge) pressure. You might consider adjusting the vapor pressure if the elevation of your system is
significantly different from mean sea level.

The vapor pocket collapse process is analogous to the well-known tip-cavitation phenomenon, which causes pitting
damage at pump impellers; however, vapor pockets can be orders of magnitude larger than cavitation bubbles and can
result in system-wide transients.

20
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Note: To determine the impact of collapsing vapor pockets on your system, set the vapor pressure to a large
negative value which you do not expect to occur, such as -1000 m, and run HAMMER with a different file name.
Then reset the vapor pressure to its true value and run HAMMER again. The difference between these results is
due to the effect of vapor pressure.

Heating or pressurizing a fluid increases its vapor pressure-an important consideration in industrial applications.
Consider both operating temperature and pressure when determining a liquid's vapor pressure limit. (For example,
water boils at a lower temperature at high altitudes due to the lower atmospheric pressure and lower absolute vapor
pressure. Similarly, water boils at a higher temperature in a pressure cooker and this increased steam temperature
accelerates the cooking process.) This is why the parameter library provided with HAMMER often provides values for
liquids at different temperatures.

Selecting the Transient Friction Method

The Transient Friction Method option enables you to select the methodology for determining flow resistance and
friction losses during calculations. This can be accessed from the Transient Solver calculation options (Analysis >
Calculation Options). Available methodologies include:
• Steady Friction
• Quasi-steady Friction
• Unsteady Friction, also known as transient friction
For more information on the theory for each of these friction models, see Friction and Minor Losses.
Steady State Friction Method
In HAMMER, a hydraulic transient analysis usually begins with an Initial Conditions (steady state) calculation, which
computes the heads and flows for every pipe in the system. Prior to beginning the transient calculations, HAMMER
automatically determines the friction factor based on this information.
If a pipe has zero flow at the initial steady-state, HAMMER use the Friction Coefficient specified in the Pipe Physical
properties.
If a pipe has a nonzero flow at the initial steady-state, HAMMER automatically calculates a Darcy-Weisbach friction
factor, f, based on the heads at each end of the pipe, the pipe length and diameter, and the flow in the pipe. It uses this
calculated value in the transient simulation.

Note: HAMMER always uses the Darcy-Weisbach friction method in performing the hydraulic transient
calculations, regardless of which method is specified in the Steady State/EPS Solver Calculation Options. If
required, HAMMER will automatically convert the friction factors to the appropriate format.

Quasi-Steady Friction Method

The quasi-steady friction method uses variable Darcy-Weisbach friction factors, f, at each point along the system, so
that friction losses for an instantaneous velocity match the friction losses which would occur for fully developed steady
flows with the same cross-sectional average velocity. For more information, see Quasi-Steady Friction.

Note: Quasi-steady and unsteady friction models are the result of current research by others. Results should be
compared with those obtained with a steady friction model. Always use engineering judgement when
interpreting transient simulation results.

Transient or Unsteady Friction

21
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Compared to a steady state, fluid friction increases during hydraulic transient events because rapid changes in transient
pressure increase turbulent shear. HAMMER can track the effect of fluid accelerations to estimate the attenuation of
transient energy more closely than would be possible with quasi-steady friction.
Computational effort increases significantly if transient friction must be calculated for each time step. This can result in
long model calculation times for large systems with hundreds of pipes or more. Typically, transient friction has little or
no impact on the initial low and high pressures, and these are usually the largest ever reached in the system (provided
the simulation does not involve a vapor pocket collapse).

Note: The steady-state friction method yields conservative estimates of the extreme high and low pressures
which usually govern the selection of pipe class and surge-protection equipment. However, if cyclic loading is an
important design consideration, the unsteady friction method can yield less-conservative but rigorous estimates
of recurring and decaying extremes.

For more information on the implementation of the transient friction method in HAMMER, see Unsteady or Transient
Friction.

Engine Compatibility Calculation Option

Previous versions of the software had a calculation option called "Use EPANET Compatible Results?" which was used
to turn off computational changes Bentley had made to the core engine calculation that would change results compared
to the results for an equivalent model run in the US EPA's EPANET software. In the current version of the software,
however, the "Use EPANET Compatible Results?" has been replaced by a new "Engine Compatibility" calculation
option that offers 4 choices as follows:
1. WaterGEMS CONNECT 2.00.12
2. WaterGEMS CONNECT 2.00.10
3. EPANET 2.00.12
4. EPANET 2.00.10
Previously, the "Use EPANET Compatible Results?" option was functionally the same as having choices 2 and 4 only.
When the previous property was set to false, you were using option 2. When the previous property was set to true, you
were using option 4. For this release of the software we have extended the engine support to include compatibility
modes that include the revised engine convergence algorithms in EPANET 2.00.12, in addition to keeping the old
behavior that was based on EPANET 2.00.10.
The intent of each of the compatibility modes is as follows:
1. WaterGEMS CONNECT 2.00.12 - Computation engine based on EPANET 2.00.12 with Bentley's own
enhancements and features.
2. WaterGEMS CONNECT 2.00.10- Computation engine based on EPANET 2.00.10 with Bentley's own
enhancements and features.
3. EPANET 2.00.12 - Computational engine based on EPANET 2.00.12 including any Bentley enhancements and
features that do not change hydraulic results compared to EPANET, for models that are able to be completely
represented in EPANET.
4. EPANET 2.00.10 - Computational engine based on EPANET 2.00.12 including any Bentley enhancements and
features that do not change hydraulic results compared to EPANET, for models that are able to be completely
represented in EPANET.
For those interested in what each engine compatibility mode means in more detail we provide the following
compatibility matrix.

22
WaterGEMS CONNECT Edition Help
Modeling Capabilities

23
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Patterns

The extended period analysis is actually a series of Steady State analyses run against time-variable loads such as sewer
inflows, demands, or chemical constituents. Patterns allow you to apply automatic time-variable changes within the
system. The most common application of patterns is for residential or industrial demands. Diurnal curves are patterns
that relate to the changes in demands over the course of the day, reflecting times when people are using more or less
water than average. Most patterns are based on a multiplication factor versus time relationship, whereby a
multiplication factor of one represents the base value (which is often the average value).
Using a representative diurnal curve for a residence as illustrated below, we see that there is a peak in the diurnal curve
in the morning as people take showers and prepare breakfast, another slight peak around noon, and a third peak in the
evening as people arrive home from work and prepare dinner. Throughout the night, the pattern reflects the relative
inactivity of the system, with very low flows compared to the average.
Patterns can be applied to a wide variety of data types including:
• Hydraulic (demands)
• Constituents
• Pump (speed)
• Reservoir (hydraulic grade)
• Valve settings (PRV, PSV)
• Valve Relative Closure (TCV)
• Operational (Transient valve)
• Operational (Transient Pump)
• Operational (Transient Turbine)
• Power Usage
The values entered for most patterns are dimensionless multipliers. For example, if the reservoir has a hydraulic grade
elevation of 200 m and time 2 hrs. it is at 202 m, the multiplier for hr. 2 would 1.01. However, some patterns are
expressed as a percentage, such as Valve Relative Closure or Operational (Transient Turbine).

Note: This curve is conceptual and should not be construed as representative of any particular network.

24
WaterGEMS CONNECT Edition Help
Modeling Capabilities

There are two basic forms for representing a pattern: stepwise and continuous. A stepwise pattern is one that assumes a
constant level of usage over a period of time, and then jumps instantaneously to another level where it remains steady
until the next jump. A continuous pattern is one for which several points in the pattern are known and sections in
between are transitional, resulting in a smoother pattern. For the continuous pattern in the figure above, the
multiplication factor and slope at the start time and end times are the same. This is a continuity that is recommended for
patterns that repeat.
Because of the finite time steps used for calculations, this software converts continuous patterns into stepwise patterns
for use by the algorithms. In other words for a time step a multiplier is interpolated from the pattern curve. That
multiplier is then used for the duration of the time step, until a new multiplier is selected for the next time step.
Patterns provide a convenient way to define the time variable aspects of system loads.

Pattern Manager
A pattern is a series of time step values, each having an associated multiplier value. During an extended period analysis,
each time step of the simulation uses the multiplier from the pattern corresponding to that time. If the duration of the
simulation is longer than the pattern, the pattern is repeated. The selected multiplier is applied to any baseline load that
is associated with the pattern. You can also define daily and monthly multipliers for any pattern.

Patterns provide an effective means of applying time-variable system demands to the distribution model. The Pattern
Manager allows you to create the following types of patterns:
• Hydraulic—This type of pattern can be applied to Junctions or Tanks. Use this pattern type to describe demand or
inflow patterns over time.
• Constituent—This type of pattern can be applied to Reservoirs, Tanks, or Junctions. Use this pattern type to
describe changes in Constituent Baseline Loads over time.

25
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Pump—This type of pattern can be applied to Variable Speed Pumps only. Use this pattern type to describe
changes in the pump's Relative Speed Factor. In the Property dialog box for the pump, Is Variable Speed Pump
needs to be set to True and the VSP type needs to be Pattern Based.
• Reservoir—This type of pattern can be applied to Reservoirs. Use this pattern type to describe changes in HGL
over time, such as that caused by tidal activity or when the reservoir represents a connection to another system
where the pressure changes over time.
• Valve Settings—This type of pattern can be applied to valves. Use this pattern type to describe changes to valve
settings over time.
• Valve Relative Closure—This type of pattern can be applied to valves. Use this pattern type to describe changes to
the relative closure of a valve over time.
• Operational (Transient, Valve)—This type of pattern can be applied to valves. Use this pattern to describe
changes in a valve's status over time during a transient analysis.
• Operational (Transient, Pump)—This type of pattern can be applied to pumps. Use this pattern to describe
changes in a pump's status over time during a transient analysis.
• Operational (Transient, Turbine)—This type of pattern can be applied to turbines.Uuse this pattern to describe
changes in a turbine's status over time during a transient analysis.

Note: In this program, an individual demand node can support multiple demands. Furthermore, each demand
can be assigned any hydraulic pattern. This powerful functionality makes it possible to model any type of
extended period simulation.

• Power Usage—This type of pattern can be applied to Power Meters in for use in energy management analysis.
The following management controls are located above the pattern list pane:

New Creates a new pattern of the highlighted type.

Delete Deletes the pattern that is currently highlighted in the list pane.

Rename Renames the pattern that is currently highlighted in the list pane.

Report Opens a report of the data associated with the pattern that is currently highlighted in the
list pane.

Synchronization Options Browse the Engineering Library, synchronize to or from the library, import from the
library or export to the library.

Note: Use the Report button to view or print a graph or detailed report of your pattern.

The right half of the dialog consists of controls that allow you to define the settings for the pattern that is currently
selected in the list of patterns on the left side of the dialog.

26
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Start Time—The first time step in the pattern. The start time format is a standard 24-hour clock. The format is
Hour:Minute:Second AM or PM (e.g., 12:45:30 PM).
• Starting Multiplier—The multiplier value of the first time step point in your pattern. Any real number can be used
for this multiplier (it does not have to be 1.0).
• Pattern Format—The following pattern formats are available:
• Stepwise—The multiplier values are considered to be the average value for the interval between the specified
time and the next time. Patterns using this format will have a staircase appearance. Multipliers are set at the
specified time and held constant until the next point in the pattern.
• Continuous—The multipliers are considered to be the instantaneous values at a particular time. Patterns using
this format will have a curvilinear appearance. Multipliers are set at the specified time, and are linearly increased
or decreased to the next point in the pattern.
Hourly patterns consist of a number of time step points, defined in the table below the Pattern Format control on the
Hourly tab.

Note: The minimum time step for hourly patterns is 1 second. WaterCAD/WaterGEMS are not intended to be
used for demand changes at such a short interval. In those cases, transient phenomena may dominate and those
changes can be better modeled using HAMMER.

• Time From Start—The amount of time from the Start Time of the pattern to the time step point being defined.
• Multiplier—The multiplier value associated with the time step point.
• Relative Closure— The initial relative closure used at the start of a steady state or EPS run. (A relative closure of
0% means the valve is 0% closed, or 100% open. Conversely, a relative closure of 100% means the valve is 100%
closed or 0 % open).
• Relative Speed Multiplier—The percentage of full speed that the pump is running at during the associated time
step point. This attribute is only available for Operational (Transient, Pump) pattern types.
• Gate Opening Percent —The percentage compared to fully open for the turbine gate opening at the associated time
step point. This attribute is only available for Operational (Transient, Turbine) pattern types.
Daily and Monthly factors are defined in the same way as hourly ones, the difference being that rather than defining
time steps you enter multipliers for each day of the week (for Daily patterns) or for each month of the year (for monthly
patterns).
A graph of the currently selected pattern is displayed in the lower right corner of the dialog.

Note: Patterns must begin and end with the same multiplier value. This is because patterns will be repeated if
the duration of the Extended Period Analysis is longer than the pattern duration. In other words, the last point in
the pattern is really the start point of the pattern's next cycle.
An Extended Period Analysis is actually a series of Steady State analyses for which the boundary conditions of
the current time step are calculated from the conditions at the previous time step. This software will
automatically convert a continuous pattern format to a stepwise format so that the demands and source
concentrations remain constant during a time step.
An individual node can support multiple hydraulic demands. Furthermore, each load can be assigned any
hydraulic demand pattern. This powerful functionality makes it easy to combine two or more types of demand
patterns (such as residential and institutional) at a single loading node.

27
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Pattern Curve Dialog Box

This dialog allows you to define pattern curves for the Patterns Engineering Library.
The following buttons are located above the time step points table on the left:

New Creates a new row in the time step

points table.

Delete Deletes the currently highlighted row

from the time step points table.

The time step points table contains the following columns:

Column Description

Time from Start Lets you specify the amount of time from the Start Time
of the pattern to the time step point being defined.

Multiplier Lets you specify the multiplier value associated with the
time step point.

Controls

Controls give you a way to specify for virtually any element based on almost any property of the system. Controls are
included in a scenario when they are 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 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 you to define controls using advanced IF, AND,
and OR condition logic, which can trigger any number of THEN or optional ELSE actions.
Choose Components > Controls to open the Control Manager.

28
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Control Manager consists of the following tabs:

• Controls—Manage all controls defined in the system.
• Conditions—Define the condition that must be met prior to taking an action.
• Actions—Define what should be done to an element in the system in response to an associated control condition.

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

29
WaterGEMS CONNECT Edition Help
Modeling Capabilities

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 Controls tab is divided into sections:
• 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:

30
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Evaluate as Simple Control—Turn on in order to evaluate the condition as a simple control.

• IF Condition—The drop-down list allows you to choose from a list of conditions that have already been created in
the Conditions tab.
• THEN Action—The drop-down list allows you to choose from a list of actions that have already been created in the
Actions tab.
• ELSE Action (optional)—The ELSE action is used when the conditions for the control are not met. To specify an
ELSE action, click the check box to activate the drop-down list. The drop-down list allows you to choose from a list
of actions that have already been created in the Actions tab.
• Priority—This area of the dialog box is optional. To set a priority for the control being created, turn on to activate
the priority drop-down list. You can set a priority of 1-5, 5 being the highest priority. If multiple controls meet a
certain condition and they have conflicting actions, the control with the highest priority will be used.

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
pump.Hovering the mouse cursor over a control in the list will open a tooltip which displays the conditions and actions
that make up that control.When 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
clause.THENAction 1 AND action 2, etc. where action X is an action clause.ELSE (Optional)Action 3 AND action 4,
etc. where action X is an action clause.Priority (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

31
WaterGEMS CONNECT Edition Help
Modeling Capabilities

is true.IF 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 true.THEN 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}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.

Select Condition Dialog Box

This dialog allows you to find and select a condition from a list of available conditions, as well as to narrow the list by
using filters.
You can narrow the list by using the Control Set, Type, and/or Condition Element filter controls along the top of the
dialog. Once you have found the desired condition, highlight it in the list and click the Select button at the bottom of the
dialog.

Select Action Dialog Box

This dialog allows you to find and select an action from a list of available actions, as well as to narrow the list by using
filters.
You can narrow the list by using the Control Set, Type, and/or Action Element filter controls along the top of the
dialog. Once you have found the desired action, highlight it in the list and click the Select button at the bottom of the
dialog.

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 Conditions tab is divided into sections:
• 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.

32
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• 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...).

33
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• 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...).
• 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...).

34
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• 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:
• Insert: Adds a new row to the Condition list.
• Delete: Deletes the highlighted row from the Condition list.
• Refresh: Updates the referenced conditions.
The table contains two columns, 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.

35
WaterGEMS CONNECT Edition Help
Modeling Capabilities

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 tab is divided into sections:
• 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.
• 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.

36
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• 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
The following controls are used to define or edit 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.

• Operator—The operator for logical actions is always EQUAL TO (=).

• Attribute Value—This field’s label will change depending on the attribute that is chosen. Depending on the element
type and the attribute that was chosen, the input field may also change to a drop-down list, which contains the
possible settings for that element. Not all settings are available for all element types.

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:

37
WaterGEMS CONNECT Edition Help
Modeling Capabilities

%# 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.
Insert—Adds a new row to the Action list Delete—
Deletes the highlighted row from the Action list.
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.

Control Wizard
The Control Wizard lets you quickly create pump controls based on tank HGL.

38
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The dialog consists of a table containing the following columns:

• Pump: Choose the pump to be controlled. You can select it from the menu, click the ellipsis (...) button to use the
Find function, or click the cursor button to select the pump from the drawing.
• Tank: Choose the controlling tank. You can select it from the menu, click the ellipsis (...) button to use the Find
function, or click the cursor button to select the tank from the drawing.
• On Operator: This field allows you to specify the relationship between the HGL and the target On value for the
HGL. The choices include Greater Than (>), Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal
To (<=), Equal To (=), or Not Equal To (<>).
• On HGL: The HGL value at which the pump turns on.
• Off Operator: This field allows you to specify the relationship between the HGL and the target Off value for the
HGL. The choices include Greater Than (>), Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal
To (<=), Equal To (=), or Not Equal To (<>).
• Off HGL: The HGL at which the pump turn off.
Click the New button above the table to add a new row; click the Delete button to remove the currently selected row.

Control Sets Editor Dialog Box

The Control Sets editor displays a tabular view of the controls that make up the Control Set(s).
Check or uncheck the box next to the corresponding control to include or omit a control from the control set.
Click the Report button to create a report containing the data for the currently displayed control set.

Active Topology

The Active Topology feature lets you create alternatives in which selected elements are displayed differently in the
drawing view.
In ArcGIS mode, you must activate the WaterGEMS Renderer to visually differentiate active and inactive elements.
Turn on the WaterGEMS Renderer by clicking the WaterGEMS > View > Apply WaterGEMS Renderer command.

39
WaterGEMS CONNECT Edition Help
Modeling Capabilities

While these elements are in the inactive state, they are not evaluated in network calculations. This ability allows you to
easily create before and after scenarios for proposed construction hydraulic models and test the redundancy of existing
networks.
While elements are inactive, they are not included in any hydraulic equations. Inactive elements are also not evaluated
when generating contour plots, and are not available for inclusion while generating profiles. Inactive elements are
differentiated visually from Active ones in the main drawing pane, in the Aerial View window, and in either of the plan
view types. When generating hydraulic model inventory reports, element details reports, or element results reports,
inactive elements are not included.
Inactive elements will not appear in the corresponding tabular reports, unless the Include Inactive Topology option is
turned on. The default setting does not include inactive elements. Inactive elements are still available for inclusion in
selection sets.
Any changes made to the Active Topology are applied to the Active Topology Alternative associated with the current
scenario, and an unlimited number of active topology alternatives can be created.

Active Topology Selection Dialog Box

While it is possible to make elements active or inactive by:
1. Checking or unchecking the "Is active?" box in the Alternatives Manager under the Active Topology Manager,
2. Unchecking the "Is active?" box in a FlexTable, or
3. Picking True of False in property grid next to "Is active?" for individual elements.
Another way of making elements active or inactive is the Active Topology Selection Tool, which is accessed through
Tools>Active Topology Selection.
When the user starts Active Topology Selection, a Select tool opens. Clicking elements in the drawing view while the
selection tool is enabled can make them active or inactive according to the commands below.
Making an element "inactive" means that the element remains in the data file but it is not included in any hydraulic
analysis calculations. Inactive elements will appear in FlexTables but calculated values will be set to NA.
Changing the active status using this tool only affects the Active Topology Alternative of the current scenario.
The Select tool consists of the following controls:
• Done: Select Done when you are finished selecting elements. This brings the user back to the drawing pane.
• Add: When this button is selected, clicking elements highlights the elements and makes them Inactive. Clicking on
an element that is already inactive causes the tool to give a beep and the element remains inactive.
• Remove: While in this mode, clicking on elements that are inactive deselects them, making them Active. Clicking
on active elements has no effect.
• Clear: Clicking on this button causes all elements to become active in the current scenario.
Right clicking while the Selection tool is open (i.e. opening the right click context menu) brings up a list which enables
the user to switch between Add, Remove or Done.

Note: Selecting a node element to become Inactive will also select all adjacent pipes to become Inactive. This is
because all pipes must end at a node.

In AutoCAD mode, you cannot use the right-click context menu command Repeat to re-open the Active Topology
Selection dialog box.

40
WaterGEMS CONNECT Edition Help
Modeling Capabilities

External Tools

External Tools allows you to manage commands which you can run directly from within WaterGEMS CONNECT. A
command can be anything you can double-click to run from within Windows Explorer, such as a program (e.g.
Notepad.exe), a folder (e.g. C:\Windows\), a document (e.g. a .txt or a .doc file), or an internet resource (e.g.
www.bentley.com).
The External Tool Manager consists of the following elements:
• External Tool List Pane—This pane lists the external tools that have been created.
• New—Creates a new external tool in the list pane.
• Delete—Deletes the currently highlighted external tool.
• Rename—Allows you to rename the currently highlighted external tool.
• Command—This field allows you to enter the command you would like to run. Click the ellipsis button to open the
standard Windows Open dialog to select an item interactively.
• Arguments—This optional field allows you to enter command line variables to be passed to your command when
run. Arguments containing spaces must be enclosed in quotes.
• [>] Predefined Arguments—The button located to the right of the Arguments field provides a submenu of
predefined arguments. You can concatenate directory and filename arguments to specify a full path name. The
available predefined arguments are:
• Hydraulic Model Directory—This predefined argument expands to the directory where your hydraulic model was
last saved. The argument string is %(ProjDir). e.g. C:\Users\MyUser\Documents\Bentley\<ProductName>\ .
• Hydraulic Model File Name—This predefined argument expands to the file name of your hydraulic model when it
was last saved. The argument string is %(ProjFileName). E.g. Hydraulic Model.wtg.
• Hydraulic Model Store File Name—This predefined argument expands to the datastore filename of your hydraulic
model when it was last saved. The argument string is %(ProjStoreFileName). E.g. Hydraulic Model.wtg.sqlite.
• Hydraulic Model Working Directory—This predefined argument expands to the directory where your hydraulic
model is located when it is being edited. The argument string is %(ProjWorkingDir). E.g. C:\Users\MyUser
\AppData\Local\Temp\Bentley\<ProductName>\.
• Hydraulic Model Working File Name—This predefined argument expands to the filename of your hydraulic
model when it is being edited. The argument string is %(ProjWorkingFileName). E.g. Hydraulic Model.wtg.$$$.
• Hydraulic Model Store Working File Name—This predefined argument expands to the datastore filename of
your hydraulic model when it is being edited. The argument string is %( ProjWorkingStoreFileName). E.g.
Hydraulic Model.wtg.sqlite.$$$.
• Working Directory—This predefined argument expands to the top-level temporary working directory. The
argument string is %(ProjWorkDir).
• Initial Directory—Specifies the initial or working directory of the tool or command.
• [>] Predefined Initial Directories—The button located to the right of the Initial Directory field provides a
submenu of predefined directory variables. The available predefined directory variables are:
• Hydraulic Model Directory—The variable string is %(ProjDir). Refer to the Predefined Arguments above for
more information.
• Hydraulic Model Working Directory—The variable string is %(ProjWorkingDir). Refer to the Predefined
Arguments above for more information.
• Working Directory—The variable string is %(ProjWorkDir). Refer to the Predefined Arguments above for more
information.
• Run—This button executes the external tool using the specified settings.

41
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Hydraulic Transient Pressure Analysis

Steady-state hydraulic models, such as WaterGEMS, simulate systems in which a dynamic equilibrium has been
achieved and where changes in head or flow take minutes to hours. WaterGEMS can also solve such systems using a
steady state run. In contrast, WaterGEMS also simulates hydraulic systems whose balance has been upset by rapid
control-valve operation or other emergencies—all occurring in seconds or fractions of a second.
With HAMMER's added simulation power comes a higher computation cost, since many time steps must be calculated
for a transient solution, using more complex equations to track dynamic changes systemwide. Fortunately, HAMMER
automatically adjusts its solution method to minimize execution time, while delivering detailed and accurate solutions.
HAMMER uses one or both of these algorithms:
Method of Characteristics (MOC) solution of the full continuity and momentum equations for a Newtonian fluid (i.e.,
elastic theory), which account for the fact that liquids are compressible and that pipe walls can expand under high
pressures.
Differential equation solution of simpler momentum and continuity equations based on rigid-column theory, which
assumes liquids are incompressible and pipes are rigid. This simpler method is not used by default.
HAMMER uses MOC system-wide for every simulation by default. The simpler, faster rigid-column algorithm can
also applied in specific reaches for a few special applications if you enable this option. Although the MOC is preferred,
due to its greater accuracy, both methods are described separately below.

Rigid-Column Simulation
Rigid-column theory is suitable for simulating changes in hydraulic transient flow or head that are gradual in terms of
the system's characteristic time, T = 2 L/a (Appendix B). This type of hydraulic transient is often referred to as a mass-
oscillation phenomenon, where gradual changes in momentum occur without significant or sharp pressure wave fronts
propagating through the system.
For example, mass oscillations can occur when a vacuum-breaker or combination air valve lets air into the system at a
local high point (to limit subatmospheric pressures). The water columns separate and move away from the high point as
air rushes in to fill the space between them. Eventually, flow reverses towards the high point, where the air may be

42
WaterGEMS CONNECT Edition Help
Modeling Capabilities

compressed as it is expelled. This back-and-forth motion of the water columns may repeat many times until friction
dissipates the transient energy.
From the HAMMER Tools > Options menu, click the Other Options tab and set Extended CAV (combination air valve)
to True. HAMMER will track the extent of the air pocket and the resulting mass-oscillation and water column
accelerations. HAMMER still calculates the system-wide solution using MOC and elastic theory; it uses rigid-column
theory only for the pipes nearest the high point. This results in more accurate solutions, without increasing execution
times.
Elastic Simulation
Elastic theory is suitable for simulating changes in hydraulic transient flow or head of all types, whether gradual, rapid,
or sudden in terms of the system's characteristic time. A popular and proven way to implement an elastic theory solver
is the Method of Characteristics (MOC).
The MOC is an algebraic technique to compute fluid pressures and flows in a pressurized pipe system. Two partial
differential equations for the conservation of momentum and mass are transformed to ordinary differential equations
that can be solved in space-time along straight lines, called characteristics. Frictional losses are assumed to be
concentrated at the many solution points.
HAMMER's power derives from its advanced implementation of elastic theory using the MOC, which results in several
advantages:
• Rigorous solution of the Navier-Stokes equation, including higher-order minor terms and complex boundary
conditions, whose physics can be described with mathematical rigor.
• Robust and stable results minimizing numerical artifacts and achieving maximum accuracy. Convergence is
virtually assured for most systems and tolerances.
• Research and field-proven method based on numerous laboratory and field experiments, where transient data were
measured and used to validate numerical simulation results.
Numerical methods for solving hydraulic transient systems or describing their boundary conditions are continuously
evolving. The ideal model should have the right balance of proven algorithms and leading-edge methodologies.
HAMMER is such a model. It is the result of decades of experience and innovation by Environmental Hydraulics
Group's senior staff combined with Bentley Systems' software expertise and track record in bringing leading-edge
technologies into widespread use.

Data Requirements and Boundary Conditions

The data requirements of hydraulic models increase with the complexity of the phenomena being simulated. A steady-
state model's simple dataset and system representation are sufficient to determine whether the network can supply
enough water to meet a certain average demand. An extended-period simulation (EPS) model requires additional data,
but it can indicate whether the system can provide an acceptable level of service over a period of minutes, hours, or
days. EPS models can also be used for energy-consumption studies and water-quality modeling.
Data requirements for hydraulic transient simulations are greater than for EPS or steady-state runs. In addition to the
information required by a steady-state model, you also need to determine the following:
• Pipe elasticity (i.e., pressure wave speed)
• The fluid's vaporization limit (i.e., vapor pressure)
• The pumps' combined pump and motor inertia and controlled ramp times, if any.
• Pump or pump-turbine characteristics for hydropower systems.
• The valves' controlled operating times and their stroke to discharge coefficient (or open area) relationship.
• The characteristics of surge-protection equipment.

43
WaterGEMS CONNECT Edition Help
Modeling Capabilities

You can use simple methods to estimate each of the above parameters, as described elsewhere in this documentation
and in the HAMMER software.

Note: If you are analyzing a subsection or skeletonized version of the system, care should be taken when
considering how to represent the boundary condition at the connection point. For example if you're analyzing
the transient effects in a transmission main only, you will need to consider if the downstream end of the
transmission main should be represented as a known hydraulic grade (tank or reservoir) or known outflow
(junction with demand or discharge to atmosphere node). It is important to consider the effects of wave
reflection, which will be different depending on the boundary condition used. See Wave Reflection and
Transmission in Pipelines.

Analysis of Transient Forces

At zero flow (static or stagnant condition), a piping system experiences hydraulic forces due to the weight and static
pressure of the liquid to be conveyed. At steady-state, these forces are typically balanced such that forces on most
elbows are balanced by forces at another elbow or by a restraint, such as a thrust block. Codes such as ASME B31.3
refer to this balanced hydraulic steady-state as the "Operating" pressure and temperature. Pipe stress software can be
used to ensure that supports, guides and restraints are sufficiently strong to hold the pipes in position without excessive
displacement or vibration.
Hydraulic transients occur whenever a change in flow and/or pressure is rapid with respect to the characteristic time of
the system. The rapid changes in pressure and momentum that occur during a transient cause liquids [and gases] to
exert transient forces on piping and appurtenances. This is highly significant for in-plant, buried and freely-supported
piping because:
• If pressures and flows change during the transient event, the force vectors will likewise change in magnitude and
direction. This has fundamental implications for the design of thrust blocks and restraints.
• Due to weight, transient forces are always three-dimensional even for horizontal pipelines. For buried piping, these
forces are also resisted in three dimensions at discrete points (thrust blocks), transversely due to contact with the
earth, and longitudinally due to pipe friction with the soil.
• Transient forces are not linearly proportional to transient pressures. A small increase in transient pressure can
develop proportionally larger transient forces. This is because the forces are not a linear function of the pressures.
• Thrust blocks or restraints designed for the steady-state or "operating case" times a (constant) safety factor can often
be inadequate to resist transient forces, especially for systems with high operating pressures, temperatures or mass.
Codes such as ASME B31.3 refer to a fluid transient as a "Dynamic" operating case, which may also include sudden
thrust due to relief valves that pop open or rapid piping accelerations due to an earthquake. It is advisable to investigate
fluid-structure interactions (FSI) that can develop for dynamic cases but the decision to undertake such analysis is
largely up to the designer; except for boilers or nuclear installations.
Prior to the advent of inexpensive computing, transient and pipe stress calculations were onerous and virtually
impossible to perform for large piping systems or plants. The increased analysis and design involved can be justified in
terms of achieving a greater understanding of the system to ensure safe operations with minimum down-time.
Designers are well-advised to follow the following steps:
• Steady-state analysis using HAMMER: layout piping and equipment to convey the steady-state flow efficiently.
This remains the essential design step and governs the economics of most systems by determining the number,
material/thickness and length of pipe required.
• Transient analysis using HAMMER: revisit pipe class and/or add protective equipment to keep transient pressures
as close to steady as possible. Check steady and transient forces to guide the design of thrust blocks. This may be
the last step in the design of buried pipelines, or specialized pipe/soil models can be used to check for sufficient
support and resistance to overburden and groundwater.

44
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Pipe stress analysis using Bentley AutoPIPE: verify supports, guides and restraints against steady-state (operating
case) and transient (dynamic) plus thermal pipe stresses, if any. This may be the last step in the design of process
plant piping, or additional time or frequency-domain analysis may be performed to check for flow-induced vibration
or earthquakes.
HAMMER needs X, Y and Z (elevation) coordinates to calculate transient forces. Simulations for which transient
forces are enabled have longer completion times but there are no additional steps. The results are available as tables or
graphics in a similar way as transient pressures: transient force graphs show the X, Y and Z components as well as the
resultant magnitude. Transient forces are also available from FlexTables: these can be used as input to pipe stress
software such as Bentley AutoPIPE.

Infrastructure and Risk Management

HAMMER provides input to operation procedures to increase infrastructure life and reduce the risk of service
interruptions in the following ways:
• Reduce wear and tear from pressure cycling due to rapid industrial demand changes, incorrect control-valve
operations, or water-column separation.
• Reduce the risk of pipe breaks, leaks, and unaccounted-for water (UFW) by optimizing normal and emergency
procedures to minimize transient pressure shock waves. This will also minimize transient thrust forces.
• Verify thrust block designs using time-dependent load vectors. Transient forces are a more rigorous design basis
than the conventional method, whereby thrust blocks are sized to resist steady-state forces. Transient thrust can be
orders of magnitude greater than steady state thrust. Transient thrust can also change direction as flows and
pressures oscillate and dampen to the new steady-state.
• Predict overflows at outfalls or spills to the environment more accurately.
• Manage the risk of contamination during subatmospheric transient pressures, which can suck air, dirt, and
contaminants into your system.

Water Column Separation and Vapor Pockets

During a hydraulic transient event, the hydraulic-grade line (HGL), or head, at some locations may drop low enough to
reach the pipe’s elevation, resulting in sub-atmospheric pressures or even full-vacuum pressures. Some of the water
may flash from liquid to vapor while vacuum pressures persist, resulting in a temporary water-column separation.
When system pressures increase again, the vapor condenses to liquid as the water columns accelerate toward each other
(with nothing to slow them down unless air entered the system at a vacuum breaker valve) until they collapse the vapor
pocket; this is the most violent and damaging water hammer phenomenon possible.
Bentley HAMMER makes a number of assumptions with respect to the formation of air or vapor pockets and the
resulting water column separation:
• HAMMER models volumes as occupying the entire cross section of the pipe. This may not be realistic for small
volumes, since they could overlie the liquid and not create column separation, as in the case of air bubbles, but this
does not result in significant errors.
• HAMMER models air or vapor volumes as concentrated at specific points along a pipe. Volume at a node is the
sum of the end points (a special case of a point) for all pipes connected to it. However, HAMMER can simulate an
extended air volume if it enters the system at a local high point (via a combination air valve or CAV) and if it
remains within the pipes connected to it.
• HAMMER ignores the reduction in pressure-wave speed that can result from the presence of finely dispersed air or
vapor bubbles in the fluid. Air injection using diffusers or spargers can be difficult to achieve consistently in

45
WaterGEMS CONNECT Edition Help
Modeling Capabilities

practice and the effect of air bubbles (at low pressures) on wave speed is still the subject of laboratory
investigations.
In each case, the assumptions are made so that HAMMER’s results provide conservative predictions of extreme
transient pressures.

Global Adjustment to Vapor Pressure

If system pressure drops to the fluid’s vapor pressure, the fluid flashes into vapor, resulting in a separation of the liquid
columns. Consequently, vapor pressure is a fundamental parameter for hydraulic transient modeling. Vapor pressure
changes significantly at high temperature, operating pressure, or altitude. Fortunately, it remains close to WaterGEMS
CONNECT’s default value for a wide range of these variables for typical water pipelines and networks.
If your system is at high altitude or if it is an industrial system operating at high temperatures or pressures, consult a
steam table or vapor-pressure curve for the liquid. Consider a few extra model runs to assess the sensitivity of the
hydraulic transient simulation results to global changes in vapor pressure—you can change it on the System tab of the
Options window (Tools > Options).

Global Adjustment to Pipe Elevations

HAMMER calculates the elevation along the top of any pipe (also known as its obvert or crown) from a straight line
joining the elevations of the two nodes it connects to. Because differences can occur between as-constructed pipe
elevations (or surveys) and the design drawings that hydraulic models are typically based on, it is prudent to assess the
sensitivity of the hydraulic transient simulation results to changes in elevation. If the transient HGL drops below the
pipe elevation, vapor pockets can form and collapse.
HAMMER speeds this process by allowing you to make a global adjustment to pipe elevations from the Tools >
Options menu command; click the Preferences tab and type in the amount to increase the pipe elevations. After running
HAMMER, you can save the resulting profile as a HAMMER graph (.grp) and copy data from several such graphs onto
a common graph showing the sensitivity to elevation errors.

Global Adjustment to Wave Speed

The pressure-wave speed is a fundamental parameter for hydraulic transient modeling, since it determines how quickly
disturbances propagate throughout the system. This affects whether or not different pulses may superpose or cancel
each other as they meet at different times and locations. Wave speed is affected by pipe material and bedding, as well
as by the presence of fine air bubbles in the fluid. The default value of 1,000 m/s (3,280 ft./sec.) is for metal or concrete
pipe.
Although higher wave speeds are conservative for typical systems composed of a single pipe material, such as
pipelines, consider a few extra model runs to assess the sensitivity of the hydraulic transient simulation results to global
changes in wave speed; you can change it on the Summary tab of the Options window (Tools > Options).

Check Run
This feature allows you to validate your model against typical data entry errors, hard to detect topology problems, and
modeling problems. When the Data Check button is selected, in the Run dialog box, the model is automatically
validated before detailed calculations are begun. The process produces either a dialog box stating No Problems Found
or a status log (see “Status Log” on page 12-539) with a list of messages. The data check algorithm performs the
following validations:

46
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Network Topology—Checks that the network contains at least one boundary node, one pipe, and one junction, the
minimum network requirements. It also checks for fully connected pumps and valves and that every node is
reachable from a boundary node through open links.
• Element Validation—Checks that every element in the network is valid for the calculation. For example, this
validation ensures that all pipes have nonzero length, nonzero diameter, etc. Each type of element has its own
checklist. This same validation is performed when you edit an element in a dialog box.
The validation process generates two types of messages. A warning message means that a particular part of the model
(e.g., a pipe’s roughness) does not conform to the expected value or is not within the expected range of values. This
type of warning is useful but not fatal. Therefore, no corrective action is required to proceed with a calculation.
Warning messages are often generated as a result of a topographical or data-entry error and should be corrected.

Note: If your model will not run due to error messages and you do not know how to proceed, please contact
Bentley Systems’ support staff (see Contact Bentley Systems (on page 970)).

An error message, on the other hand, is a fatal error and the calculation cannot proceed before it is corrected. Typically,
error messages are related to problems in the network topology, such as a pump or valves not being connected on both
its intake and discharge sides.

Numerical Model Calibration and Validation

As part of its expert witness and break-investigation service, EHG has calibrated and validated HAMMER’s numerical
simulations for different fluids and systems for clients in the civil (water and wastewater), mining (slurry), and
hydropower sectors. Comparisons between computer models and validation data can be grouped into the following
three categories:
• Cases for which closed-form analytical solutions exist given certain assumptions. If the model can directly
reproduce the solution, is considered valid for this case. The example file (\\HAMR\Samples) hamsam01.hif is a
validation case against the Joukowski equation.
• Laboratory experiments with flow and pressure data records. The model is calibrated using one set of data and,
without changing parameter values, it is used to match a different set of results. If successful, it is considered valid
for these cases.
• Field tests on actual systems with flow and pressure data records. These comparisons require threshold and span
calibration of all sensor groups, multiple simultaneous datum and time base checks and careful test planning and
interpretation. Sound calibrations match multiple sensor records and reproduce both peak timing and secondary
signals—all measured every second or fraction of a second.
It is extremely difficult to develop a theoretical model that accurately simulates every physical phenomenon that can
occur in a hydraulic system. Therefore, every hydraulic transient model involves some approximations and
simplifications of the real problem. For designers trying to specify safe surge-control systems, conservative results are
sufficient.
The differences between computer model results and actual system measurements are caused by several factors,
including the following difficulties:
• Precise determination of the pressure-wave speed for the piping system is difficult, if not impossible. This is
especially true for buried pipelines, whose wave speeds are influenced by bedding conditions and the compaction of
the surrounding soil.
• Precise modeling of dynamic system elements (such as valves, pumps, and protection devices) is difficult because
they are subject to deterioration with age and adjustments made during maintenance activities. Measurement
equipment may also be inaccurate.

47
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Unsteady or transient friction coefficients and losses depend on fluid velocities and accelerations. These are difficult
to predict and calibrate even in laboratory conditions.
• Prediction of the presence of free gases in the system liquid is sometimes impossible. These gases can significantly
affect the pressure-wave speed. In addition, the exact timing of vapor-pocket formation and column separation are
difficult to simulate.
Calibrating model parameters based on field data can minimize the first source of error listed above. Conversations
with operators and a careful review of maintenance records can help obtain accurate operational characteristics of
dynamic hydraulic elements. Unsteady or transient friction coefficients and the effects of free gases are more
challenging to account for.
Fortunately, friction effects are usually minor in most water systems and vaporization can be avoided by specifying
protection devices and/or stronger pipes and fittings able to withstand subatmospheric or vacuum conditions, which are
usually short-lived.
For systems with free gas and the potential for water-column separation, the numerical simulation of hydraulic
transients is more complex and the computed results are more uncertain. Small pressure spikes caused by the type of
tiny vapor pockets that are difficult to simulate accurately seldom result in a significant change to the transient
envelopes. Larger vapor-pocket collapse events resulting in significant upsurge pressures are simulated with enough
accuracy to support definitive conclusions.
Consequently, HAMMER is a powerful and essential tool to design and operate hydraulic systems provided the results
are interpreted carefully and scrutinized as follows:
• Perform what-if analyses to consider many more events and locations than can be tested, including events that
would require destructive testing.
• Determine the sensitivity of the results to different operating times, system configurations, and operating- and
protective-equipment combinations.
• Based on a calibrated or uncalibrated model, predict the effects of proposed system capacity and surge-protection
upgrades by comparing them against each other.
These are facilitated if transient pressure or flow measurements are available for your system, but valid conclusions and
recommendations can usually be obtained using HAMMER alone.

Gathering Field Measurements

Rather than conventional pressure gages and SCADA systems, high-speed sensors and data logging equipment are
needed to accurately track transient events. The pressure transducer should be very sensitive, have a high resolution,
and be connected to a high-speed data acquisition unit. It should be connected to the system pipeline with a device to
release air, because air can distort the pressure signal transmitted during the transient.
Recording should not begin until all air is released from the pipeline connection and the pressure measurement interval
is defined. Typically, at least two measuring locations should be established in the system and the flow-control
operation should be closely monitored. The timings of all recording equipment must be synchronized. For valves, the
movement of the position indicator is recorded as a function of time. For pumps, rotation or speed is measured over
time. For protection devices such as one-way and two-way surge tanks and hydro-pneumatic tanks, the level is
measured over time.

Timing and Shape of Transient Pressure Pulses

With respect to timing, there should be close agreement between the computed and measured periods of the system,
regardless of what flow-control operation initiated the transient. With a well-calibrated model of the system, it is
possible to use the model in the operational control of the system and anticipate the effects of specific flow-control

48
WaterGEMS CONNECT Edition Help
Modeling Capabilities

operations. This requires field measurements to quantify your system’s pressure-wave speed and friction, with the
following considerations:
• Field measurements can clearly indicate the evolution of the transient. The pressure-wave speed for a pipe with
typical material and bedding can be determined if the period of the transient (4 L/a) and the length (L) between
measurement locations is known. If there is air in the system, the measured wave speed may be much lower than the
theoretical speed.
• If friction is significant in a system, real-world transients attenuate faster than the numerical simulation, particularly
during longer time periods (t > 2 L/a). Poor friction representation does not explain lack of agreement with an initial
transient pulse.
In general, if model peaks arrive at the wrong time, the wave speed must be adjusted. If model peaks have the wrong
shape, the description of the control event (pump shutdown or valve closure) should be adjusted. If the transient dies off
too quickly or slowly in the model, the friction losses must be adjusted. If there are secondary peaks, important loops
and diversions may need to be included in the model.

Steady State Run

Steady-state analyses determine the operating behavior of the system at a specific point in time or under steady-state
conditions (flow rates and hydraulic grades remain constant over time). This type of analysis can be useful for
determining pressures and flow rates under minimum, average, peak, or short term effects on the system due to fire
flows.
For this type of analysis, the network equations are determined and solved with tanks being treated as fixed grade
boundaries. The results that are obtained from this type of analysis are instantaneous values and may or may not be
representative of the values of the system a few hours, or even a few minutes, later in time.
In Bentley HAMMER, a steady state simulation (Analysis > Compute Initial Conditions) can be used to establish the
initial conditions for the transient simulation.

Copy Initial Conditions Dialog Box

This tool allows you to copy initial conditions from a specified time step (after an Initial Conditions computation has
been run) to user-specified initial condition fields for some or all of the elements in the model. The following intial
conditions are applied to the selected elements:
• Discharge Coefficient (FCV, GPV, PRV, PSV)
• Valve Status (FCV, GPV, PBV, PRV, PSV, TCV)
• Valve Flow (FCV, GPV, PBV, TCV)
• Headloss (GPV, PBV, TCV)
• Gas Volume (Hydropneumatic Tank)
• Pressure (Junction)
• Demand (Junction)
• Nominal Flow (Variable Speed Pump Battery, Pump)
• Nominal Pressure (Variable Speed Pump Battery, Pump)
• Relative Speed (Variable Speed Pump Battery, Pump)
• Number of Running Lag Pumps (Variable Speed Pump Battery)
• Pump Status (Variable Speed Pump Battery, Pump)
• Elevation (Surge Tank, Tank)

49
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Rated Flow (Turbine)

• Rated Pressure (Turbine)
• Pipe Flow (Pipe)
• Start HGL (Pipe)
• Stop HGL (Pipe)
• Friction Coefficient (Pipe) (only if friction method is Darcy Weisbach)
The dialog consists of the following controls:
Time—Allows you to choose the time step. The values at this time step will be used as the initial conditions for the
HAMMER transient calculations.
All—When this button is selected, initial conditions will be applied to all elements in the model.
Selection—When this button is selected, initial conditions will be applied only to elements that are currently selected in
the drawing pane.
Selection Set—When this button is selected, initial conditions will be applied only to the elements contained within the
specified selection set.

Selection of the Time Step

In the Method of Characteristics, the pipes in the network are broken into segments so that a sharp pressure-wave front
can travel the length of one of the pipe's interior segments in one time step. However in systems with a mix of very long
and short pipes, it is not always practical to use very small time steps since this can significantly increase the time it
takes to complete a simulation. Therefore, it is possible to adjust either the length or wave speed parameters for each
pipe so that a larger time step can be used while still satisfying the requirement that a sharp pressure-wave front can
travel the length of one of the pipe's interior segments in one time step.
For example, if a pipe has a length of 10 ft and the wave speed is 1000 ft/s, then the time step required to simulate this
pipe without adjustment is 0.01 seconds (= 1 ft / 1000 ft/s). However, if the time step was set to 0.02 seconds, the pipe
length would need to be adjusted to 20 ft (= 0.02 s x 1000 ft/s), or the wave speed would need to be reduced to 500 ft/s
(= 10 ft / 0.02 s) to satisfy the requirement that a sharp pressure-wave front can travel the length of one of the pipe's
interior segments in one time step.
In general, a smaller calculation time step will produce a more accurate solution but will take longer to compute.
However, using a larger time step (and adjusting pipe lengths or wave speeds) can produce accurate simulation results
with much shorter simulation times, so this is generally recommended.
The calculation time step used in WaterGEMS CONNECT can be defined by the user, or the user can elect to have
WaterGEMS CONNECT automatically select a time step for them. If WaterGEMS CONNECT selects the time step, it
will attempt ensure the time step provides a good trade off between solution accuracy and the time taken to compute the
simulation. The time step selected by WaterGEMS CONNECT generally requires some adjustment to the pipe lengths
or wave speeds. The adjustments are done automatically by WaterGEMS CONNECT, but the user is able to select
whether they want the length or wave speed adjusted. Similarly, if a user enters their own time step, WaterGEMS
CONNECT will adjust the pipe lengths or wave speed accordingly and once again the user can select which of these
parameters is adjusted.

Note: Using very short pipes (in a pump station) and very long pipes (transmission lines) in the same
WaterGEMS CONNECT model could require excessive adjustments to the length or wave speed. If this happens,
WaterGEMS CONNECT prompts you to subdivide longer pipes or reduce the time step to avoid resulting
inaccuracies.

50
WaterGEMS CONNECT Edition Help
Modeling Capabilities

In addition, many short pipes in a model will prompt WaterGEMS CONNECT to select a smaller time step - increasing
the time taken to compute a simulation. (Note: it may be possible to remove short pipes from the model using the
Skelebrator tool.)
Regardless of whether a user-defined, or automatic time step is used, users are advised to conduct a sensitivity analysis
using a run with a very small user-defined time step to satisfy themselves that the time step they are using produces
satisfactory results. (The appropriate time step to use for this will depend on the model, but a value like 0.01 s is
suggested.) If the run using a very small time step produces results that correlate well with results obtained using a
larger time step, then it should be valid to adopt the larger time step.
Likewise, there is no hard and fast rule which determines the maximum amount of adjustment that can be applied to
pipe lengths of wave speeds without adversely affecting the results, so users should investigate the sensitivity of results
to different levels of adjustment. However, users should keep in mind that, if the mean pipe length adjustment is
significant, this means that the mass of liquid analyzed in the model is significantly different to the mass of liquid in the
real system.

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.
Each of these groups of features is described further below.
Importing Data to Hydraulic Models
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:
1. Viewing external data in the model in tabular or graphical form
2. Comparing model results with external data for model calibration using tabular and graphical views
3. Importing initial conditions for use in a model run
4. Importing field data for use with Darwin Calibrator
The work flow is:
1. Set up connection to data source (View data)
2. Create SCADA elements

51
WaterGEMS CONNECT Edition Help
Modeling Capabilities

3. Associate SCADA signal with model element and tag from SCADA data source
4. Use SCADA data in model
Running Model using SCADAConnect Simulator
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).
The work flow is generally:
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.
Viewing Model using SCADA HMI
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 work flow generally is:
1. Set up or copy SCADA HMI.
2. Set up or use OPC server and map to HMI.
3. Map model results to OPC server.
4. Run SCADAConnect scenario in model and view results in HMI.
Alarms and Alerts
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).
The general work flow is:
1. Set up alarms and alerts.
2. Make model runs.
3. View alarms and alerts in User Notifications.

52
WaterGEMS CONNECT Edition Help
Modeling Capabilities

SCADA Element
A SCADA element is an element created in order to link model elements with external time series data usually from a
SCADA system (although it could be a data logger or database/spreadsheet file). These elements can be used to display
external data in a model or set up alarms for model results.
A SCADA element can be placed as any other element although it is not used in hydraulic calculations. The symbol for
a SCADA signal is shown below

The SCADA element must be linked to both a model element and some type of external signal. Each SCADA element
corresponds to only one property so that an element with multiple properties must have one SCADA element per
property (e.g. a pump with suction and discharge pressure and flow would have three SCADA elements).
The user enters the required data in the SCADA element property grid or flex table.

53
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The most important property of the SCADA element is the model element with which it is associated. To set this, the
user picks Select Model Element in the Model element property. The user then picks the model element associated with
the SCADA element. The two elements should be located close to one another and are connected by a dashed line.

Once the model and SCADA element have been connected, the user selects the field/property that will be shared. If
there is an external signal that will be passed, the user identifies the type of signal (real time or historical) and selects
the signal from the drop down list of available signals that have already been established in the SCADAConnect
Signals Manager (see SCADA Signals Setup (on page 556)). The signal value, quality and difference between the
signal and the model result are then displayed if available. The quality field is found on some data sources indicating
whether the value appears to be good.
The user can also set up alarms for that model element which will be displayed at the end of a model run (see Alarms
(on page 578)).
The full list of SCADA elements in a model can be viewed in the SCADA flex table as shown below (View > Flex
Table > SCADA element).

54
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The mappings between the model and external data are also used in importing initial conditions and loading Darwin
Calibrator.
Once SCADA elements have been created, they can be detected in Network Navigator queries such as
• All SCADA elements
• Orphaned SCADA elements
• Find associated SCADA elements
• Elements with SCADA data

SCADA Signals Setup

In order to work with external data sources (in particular SCADA systems), it is necessary to set up the link between
WaterGEMS/CAD and the data source. There are several type of data sources that can be used including database
sources (which can include a wide range of file types), OPC Historical data source, OPC Real Time data source and a
Citech data source.
The SCADA Signals dialog can be reached using Analysis > SCADAConnect Simulator (Drop Down) > SCADA
Signals or within the SCADAConnect Simulator via Configure > SCADA Signals. When opening the dialog for the
first time, the user should pick the New button and then identify the type of data source from the four listed above.
Depending on the type of data source selected, dialog will open enabling the user to define the data to be shared
between the model and datasource. See the help topic for the individual datasource types (see SCADA Signals -
Database (on page 556), SCADA Signals - OPC (on page 567), and SCADA Signals - Citect (on page 569)).
The other buttons on the top of the dialog include
Edit which enables the user to change the datasource properties.
Delete which deletes the selected existing data source or SCADA signal. This does not delete any data from the
datasource.
Rename which enables the user to change the name of the selected datasource or SCADA signal.
Duplicate which enables the user to copy the highlighted existing datasource.
SCADA Log which opens the log file containing status and error messages from communication with the data sources
The left pane of the dialog lists the datasources that have been defined. When the datasource list is expanded, each
signal within that datasources is listed.
The right pane lists the signals when a datasource is highlighted in the left pane. When one of the individual signals is
highlighted in the left pane, the right pane displays the range of times covered by the signal, a tabular view of the data
and a graph of the data. If values are not shown, the user should pick the refresh button.
In general, the model expects numerical values for signals. In some cases, the values may be non-numeric such as On,
Off, Open or Closed. These values are imported in their raw form and transformed using signal mapping. They are
displayed like the Open value in the table below. (see Signal Mapping to create this mapping).
At the bottom of the SCADA Signals dialog the user can choose OK to save the signals or cancel to leave without
saving.
The check box for Auto-refresh is not persisted. Therefore, it must be checked each time this dialog is opened.

SCADA Signals - Database Source

55
WaterGEMS CONNECT Edition Help
Modeling Capabilities

When the user selects a database source, the user is indicating that the SCADA data (whether it is from a SCADA
system, logger or some other source) will be in the form of a file or database as opposed to retrieving data directly from
a SCADA OPC server. Datasources can be managed with ProjectWise. The file types and format are described below.
As of SELECTseries 5, WaterGEMS/CAD currently supports the following although more could be added In the
future:
• Excel 3.0
• Excel 4.0
• Excel 5.0
• Excel 2003/XP/2000/97 (8.0)
• Excel 2007 (12.0)
• Access 2.0
• Access 97/7.0 (3.0)
• Access 2003/2002/2000 (4.0)
• Access 2007 (12.0)
• OBDC Source
• OLEDB Source
• SQL Source
• Oracle connection
There are essentially two formats for the signals to be presented to the model: One value per row or multiple values per
row.
One value per row: In this format, the signals should be stored in a way that each row/record contains a signal name, a
time stamp and value columns. It is also possible to indicate the quality of the data (e.g. good, bad, questionable). The
order of the columns does not matter and there may be columns that are not used. An example of such data is shown
below:

Date-Time Signal/Tag Name Value Quality

3:45:14 15 June, 2016 Flow Pump #7 234.156 Good

3:45:16 15 June, 2016 South Tank 18.187 Good

3:45:16 15 June, 2016 West Pressure Point Nan Bad

Multiple values per row. In this format, usually found when SCADA data have been processed, there can be multiple
values for each record or row corresponding to a single date-time. The signal name needs to be the first row of the
table. The signal names will usually correspond to the tags from the SCADA system. Not all of the columns/fields in
the data source need to be used. An example of such data is shown below.

Time Stamp Pump B Flow Level South Tank West Pressure Gauge Flow Plant TM

3:45:14 15 June, 2016 375.788 34.44 87.5 12.356

3:45:15 15 June, 2016 376.114 34.41 87.1 12.319

3:45:16 15 June, 2016 0.015 34.38 85.6 12.189

Once the user has selected a Database source and chooses to Edit the following dialog is displayed where the
connection can be configured and signals from the data source selected.

56
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The fields are described below:

Connection actually establishes the connection with the data file. Picking Edit will open the dialog below:

57
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Data Source Type field will open a drop-down list of the available types as listed earlier. In case of Excel and
Access the Data Source is the actual file with a full path that is selected by clicking the ellipse button. Once the path is
provided, it is suggested to pick Test Connection to ensure that the source is set up correctly. For Data Source Type
ODBC, OLEDB, SQL and Oracle connections, additional information, which includes such items as login information,
is required in a dialog as shown below:

The Advanced button opens a dialog that allows to adopt delimiters used in SQL statements. For the well-defined data
source types (Excel, Access, Oracle) the values are preconfigured. Generic data source types may need modifications:

58
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Connection String is automatically established by the program. Advanced users can edit this string for Generic
Data Source Types.
The Table Name field opens a drop down which enables the user to pick the table from the table corresponding to this
datasource. If multiple datasources are used, each must have its own connection.
The Source Format identifies which of the formats: one value per row or multiple values per row is to be used.
The Signal Value Field identifies which table column is to be used as the signal name when the one value per row
format is used. It is not used for multiple values per row.
The Value Field identifies which table column is to be used as the Value when the one value per row format is used. It
is not used for multiple values per row.
The Time Stamp Field is used to identify which table column contains the time stamp. Any Windows-compliant Date/
Time format can be used.
The Questionable Field identifies which table column is to be used as the data quality field when the one value per row
format is used. It is not used for multiple values per row. For data to be considered acceptable for use, this field must
contain the word "Good" although it may be part of a longer string (e.g. "Good data").
The Options portion of the dialog identifies which type of data this is to be considered. If the Real Time button is
picked, then only the most recent value is imported while if Historical is picked, all values in the time band are used
except for cases when a single value is needed such as Initial Conditions or Darwin Calibrator, in which case the Time
Tolerance is used to pick the correct value from the historical datasource.
Once the user has identified the Data Source, the user can pick the Select SCADA Signals button which opens the
dialog below which enables the user to select the signals that will be available in the model. These should correspond to
the properties that are available for model elements plus any user defined properties. This is done by highlighting the
signals in the left pane and picking Add to move them to the right pane.

59
WaterGEMS CONNECT Edition Help
Modeling Capabilities

These signals are added to the list of available signals by highlighting them in the left pane and picking the Add button
to move them to the right pane.
Clicking OK on the Database Source dialog performs a number of validations including verifying that:
• Datasource is available
• The selected table is valid
• Signal names are valid
• Questionable field exists (if it was selected)
• Time/date field is available (if Historical is selected)
The second tab on the Datasource editor dialog is the Units tab which enables the user to specify the units for the
SCADA signals. The default values are the values specified for the parameters in the model. However, if the units in
the SCADA system datasource are different, this is where the user can indicate what those units are so that they can be
adjusted when being imported.
The user picks the field in the right column and then selects the correct units from the drop down list.
In some cases, the values from the database source must be transformed into values that are expected in the model. Use
SCADA Signal Mapping tab to set up these transformations (see SCADA Signal Mapping).
SCADA Signals - Units
The second tab on the Datasource editor dialog is the Units tab which enables the user to specify the units for the
SCADA signals. The default values are the values specified for the parameters in the model. However, if the units in
the SCADA system datasource are different, this is where the user can indicate what those units are so that they can be
adjusted when being imported.
The user picks the field in the right column and then selects the correct units from the drop down list.

60
WaterGEMS CONNECT Edition Help
Modeling Capabilities

SCADA Signals - Signal Value Mappings

In some cases, the values from the database source must be transformed into values that are expected in the model. Use
SCADA Signal Mapping tab to set up these transformations (see SCADA Signal Mapping (on page 565)).

61
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Database Connection

62
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Data Source Type field will open a drop-down list of the available types as listed earlier. In case of Excel and
Access the Data Source is the actual file with a full path that is selected by clicking the ellipse button. Once the path is
provided, it is suggested to pick Test Connection to ensure that the source is set up correctly. For Data Source Type
ODBC, OLEDB, SQL and Oracle connections, additional information, which includes such items as login information,
is required in a dialog as shown below:

63
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Advanced button opens a dialog that allows to adopt delimiters used in SQL statements. For the well-defined data
source types (Excel, Access, Oracle) the values are preconfigured. Generic data source types may need modifications.

Units in SCADAConnect Datasource

The Units tab in the Database Source dialog is used when the units in the SCADA system are different from the units
used in the hydraulic model. When the user opens the tab (below), the user can specific the units used in the SCADA
system and values will be automatically converted on import. If the units are the same in the model and SCADA
system, there is no reason to use this tab.

SCADA Signal Mapping

In most cases the values that are provided by the database or OPC source are directly imported into the model.
However, some values may need to be transformed. For example, while the model has pipe properties of OPEN and
CLOSED, the file may contain 1 for open and 0 for closed. Alternatively, the SCADA system may not track run status
as ON or OFF, but instead an operator simply views the flow from the pump and if the value is substantially larger than
zero (allowing for drift), then the pump is considered on. In these cases, the user must indicate how to map raw signals

64
WaterGEMS CONNECT Edition Help
Modeling Capabilities

to values the model can understand. This is done by picking the Signal Values Mapping tab from the top of the
Database source manager.

This opens up a dialog, where the user can specify the mappings. There are two types of mappings, Single value where
a specific SCADA value is mapped to a model property and a Threshold where a model value is inferred based on an
inequality. For example, in the dialog below, if the flow is greater than the threshold value of 0.01, then the pipe is
treated as being Open. Otherwise, it is considered Closed.
A value must be specified on the first row for any mapping. The second row, by default, is set to <any other value>.
The user can explicitly override the "any other value" with a specific value.
Mapping using "single value" might fail. In this case the signal value is reported as (N/A). For example the Pipe Status
mapping below will yield in a signal value of (N/A) for raw values that are not 0 or 1.
Note: the signal preview does not consider mappings. It is a view on the plain signal data.
When mapping are used and the user views values, there will be two values displayed in the SCADAD Signal Preview:
the signal raw value and the signal value.

65
WaterGEMS CONNECT Edition Help
Modeling Capabilities

One special case is that of importing pump status as On or Off in the data source. One would think that it doesn't need a
mapping since On/Off is what is displayed in WaterGEMS/CAD. However, internally the model stores 0 (On) and 1
(Off) so that it is necessary to map On to On and Off to Off as shown above.
Also see SCADA Signals - Database (on page 556)

SCADA Signals - OPC

When setting up a SCADA connection, the user can import data from an OPC server (in addition to database
datasources). The OPC connection can be used to import values that are either real time values or historical values.
Upon selecting an OPC source, the following dialog open for the user to select the location of the server. If it is the
same computer as the model, the user should leave the Host box unchecked. If it is a different computer, the user should
check the Host box and the program will search for a list of connected computers from which the user can choose.
The user then picks the OPC server from the drop down list provided.
Once the server connection is available, the user picks the Select SCADA Signals box and a dialog opens which
enables the user to pick which signals are to be made available for the model.
These should correspond to the properties that are available for model elements plus any user defined properties. This is
done by highlighting the signals in the left pane and picking Add to move them to the right pane.
The second tab on the Datasource editor dialog is the Units tab which enables the user to specify the units for the
SCADA signals. The default values are the values specified for the parameters in the model. However, if the units in
the SCADA system datasource are different, this is where the user can indicate what those units are so that they can be
adjusted when being imported.
The user picks the field in the right column and then selects the correct units from the drop down list.

66
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Once the connections have been set up, both Historical and Real Time data can be viewed and imported. When real
time data are imported from an OPC server, the latest value is displayed as shown below

67
WaterGEMS CONNECT Edition Help
Modeling Capabilities

In some cases, the values from the OPC source must be transformed into values that are expected in the model. Use
SCADA Signal Mapping tab to set up these transformations (see SCADA Signal Mapping).

SCADA Signals - Citect

The user can also set up customized SCADA connections directly with a Citect SCADA system by choosing Citect
source when creating a new connection. This will open the following dialog which enables the user to establish a
connection with a Citect server.
By picking the Edit button, the user can identify the server and enter any authentication credentials. Citect server
credentials are required for a remote connection.
Most of the other behaviors are similar to connections with other OPC/historical servers. The user can specify whether
the data are to be Historical or Real-time and can use the Select SCADA Signals to identify which signals are to be
connected.
In some cases, the values from the source must be transformed into values that are expected in the model. Use SCADA
Signal Mapping tab to set up these transformations (link to SCADA Signal Mapping).

Select Signals
This dialog allows you to select the SCADA signals to be used. Move the desired signals from the Available list to the
list of Selected signals.

Viewing SCADA Data in Model

A user can view external data, either from a file or an OPC server, directly in WaterGEMS/CAD. Once the connections
have been established, the user can enter the SCADA Signals manager and pick any signal. (The signal does not
necessarily need to be linked to a SCADA element.) The user picks one of the signals from the left pane and will be
able to view the time series as shown below.

68
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If the display is empty, the user should pick the Refresh button.
Checking the Auto-refresh button means that the tabular and graphical views of the data are automatically displayed
when a new signal is selected.
Right clicking on the top of the Signal Value column enable the user to change Units and Formatting.
Right clicking on the bottom border of the graph area enables the user to set chart options in the graphical view.
Once SCADA data are available, they can be viewed graphically by right clicking on the SCADA element and picking
graphs. If the SCADA signal has been set up correctly and the SCADA element is associated with a model element,
then the SCADA signal and model results will be plotted on the same graph.

69
WaterGEMS CONNECT Edition Help
Modeling Capabilities

All of the graph manager features are available for use with these graphs.
For a given time step, the values for SCADA data can be viewed in the SCADA flex table.

The user can also annotate or color code by values associated with SCADA elements.

Time Tolerance

When using historical data, there are cases where the user must select a single value from a time series of values, such
as for loading initial conditions or Darwin Calibrator. The user usually needs data for a single point in time but a
SCADA value may not be available at exactly that time. For example, the user may need a value for 8:00:00 but values
may only be available for 7:58:14 and 8:02:11. SCADAConnect will use the value from the time closest to the time
required.

70
WaterGEMS CONNECT Edition Help
Modeling Capabilities

However, there may be instances where the nearest value available is far from the required time. The user sets the band
of time SCADAConnect will look for values by entering a Time Tolerance.
If there is no value within the time tolerance, no value is imported and an error message is listed in the SCADA Log
which can be reached from Analysis > SCADAConnect Simulator > View Log button in Configure tab. The log
message is written on attempting to read the signal value.

Refresh and Auto Refresh

When viewing signals in the SCADA Signals dialog, WaterGEMS/CAD does not instantly read and display the values.
Instead, the user must pick the refresh button to display the result for the selected signal when the first signal is selected
or the user switches signals.
To force an automatic refresh of the display when switching signals, the user should check the auto-refresh check box.

Importing Initial Conditions with SCADAConnect

A user can override the initial condition associated with a scenario with new initial conditions from an external data
source such as a SCADA system. This tool enables user to import tank levels and other data to start a model run with
exact conditions from an external data source at a specific time. For example, the user may want to set tank levels based
on the current tank levels in the distribution system. 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.

Note: There are actually two ways to import initial conditions. The first is described here, the second consists of
setting up a Historical or Live run in the SCADAConnect simulator. With the method described here, the initial
condition actually modifies the values in the initial setting alternative of the current scenario being run.

The user picks Tools > SCADA Connect Simulator. Initial conditions are imported to the Current Scenario, not the
baseline scenario. If the user does not want to overwrite the an existing scenario, the user should set up a new scenario
to receive the imported values.

The user then picks the Import Initial Conditions button (seventh from left).

71
WaterGEMS CONNECT Edition Help
Modeling Capabilities

This opens the following dialog:

The user then identifies if the import is from a historical data source or real time data. If the data source is a historical
time series, then the user must provide a date and time which can be typed directly or indicated from the drop down
calendar. Data must be available within the Time Tolerance specified when the signal was created for historical data. If
not, then the initial condition from the baseline scenario will be used and an entry will be made in the SCADA log.
If the user checks the Create new Selection Set box, the created Selection Set contains all model elements with updated
initial settings.
If the user selects Real Time, then the model uses the current value from the OPC server or the latest value from the
database source. No time tolerance is applied for real time data.
Values of initial conditions are imported for all model elements that have SCADA elements assigned and are
attempting to import data from an external source which must be identified prior to the import.
The Ignore Inactive Elements check box indicates that initial settings should not be imported for inactive SCADA
elements.
The properties that are set can be stored in the Initial Settings alternative with the exception of water quality values
which are stored in the Constituent alternative. The values that can be imported for any element depend on the initial
settings that can be set for that element as summarized below:
Pumps and Variable speed pump batteries can have on/off status changes and variable speed pumps can directly set the
pump relative speed factor. The import field should contain a 0 or 1 (On=0, Off=1). If status is indicated by some other
value (e.g. text value of On or Off=0) the user needs to adjust the data source.
Pipes can be open (0) or closed (1).
Control valves such as Pressure reducing valve (PRV), Pressure Sustaining Valve (PSV), Pressure Breaker Valve
(PBV), Throttling Control Valve (TCV) or Flow Control Valve (FCV) can have their initial status (0=active,
1=inactive, 2=closed) or their setting (numerical value) set from an external source. A TCV setting can be specified as
either relative closure or headloss coefficient. A General Purpsoe Valve (GPV) can only be Active or Closed.

72
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The initial condition for a tank must be specified as the Elevation as a Hydraulic Grade Line relative to the model data,
not a level relative to tank bottom. A tank with 10 ft of water and a bottom elevation of 230 ft would need to have a
value of 240 ft, not 10 ft.
Constituent values can be imported for any junction node but not HAMMER specific elements.
SCADA elements can be mapped to reservoirs. Reservoir level hydraulic grade is used for regular graphing (of
SCADA elements) and for initial conditions loading (which happens automatically for SCADA runs).
At the end of the import, a summary of the import is provided.

The sections in this dialog are as follows:

• Imported - The number of SCADA elements successfully processed and imported.
• Invalid context - The SCADA element mapping is not appropriate for use in the import (doesn't have an equivalent
initial settings field) or the SCADA field has not been assigned.
• Invalid Data - No data was available. For real-time no value is available. For historical no value is available for the
requested time within the time tolerance of the data source. The data source may also be invalid.
• Invalid Signal - The signal is not properly defined. The signal may not be defined or may have been deleted.
• Inactive Element - The SCADA Element is inactive and the "Ignore inactive elements" option was selected.
• Invalid Target Element - The SCADA Element target element is undefined or deleted.
• Inactive Target Element - The SCADA Element target element is inactive and the "Ignore inactive elements" option
was selected.
• Elapsed Time - The total time taken to execute the import.

Initial Setting Import Dialog

When the Initial settings button is selected in the SCADAConnect toolbar, the following dialog opens:

73
WaterGEMS CONNECT Edition Help
Modeling Capabilities

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.

Loading Darwin Calibrator from SCADA Data

SCADAConnect enables a user to automatically load data from an external data source, such as a SCADA system, into
Darwin Calibrator to assist in calibrating a model. See the Darwin Calibrator help for instructions for using Calibrator
(Calibrating Your Model with Darwin Calibrator (on page 663)).
Before using Darwin, the user must first set up a SCADA element for each signal, set up the connection to the data
source (see SCADA Signals Setup (on page 556)), assign the SCADA signal to the SCADA elements and assign the
SCADA element to the SCADA element to a hydraulic model element (see SCADA Element (on page 554)).
The SCADA data are imported to as many Field Data sets in Darwin as there are time steps in the field data set. Open
Darwin Calibrator, pick or create a Calibration study in the left pane and pick the Field Data Snapshot tab in the right
pane.

74
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Pick the Import Field Data from SCADA button at the top of the right pane.

Select whether historical or real time data are to be imported and if it is historical data, the time setting for the import
should be indicated.

75
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Ignore inactive elements options allows the user to exclude certain SCADA signals from the import by making
either the SCADA Element inactive or the target element of the SCADA Element inactive (or both). The default Field
Data Set Label is taken from the time assigned to the import data or the current time for Real Time data. The user can
overwrite this time.
Hit OK to import the data. On completion of the import, the following message will appear.

The definition of each entry is shown below.

• Imported - The number of SCADA elements successfully processed and imported.
• Invalid context - The SCADA element mapping is not appropriate for use in the import (doesn't have an equivalent
initial settings field) or the SCADA field has not been assigned.
• Invalid Data - No data was available. For real-time no value is available. For historical no value is available for the
requested time within the time tolerance of the data source. The data source may also be invalid.
• Invalid Signal - The signal is not properly defined. The signal may not be defined or may have been deleted.
• Inactive Element - The SCADA Element is inactive and the "Ignore inactive elements" option was selected.
• Invalid Associated Model Element - The SCADA Element target element is undefined or deleted.

76
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Inactive Associated Model Element - The SCADA Element target element is inactive and the "Ignore inactive
elements" option was selected.
• Elapsed Time - The total time taken to execute the import.
Note that if any of the line items that contain "Invalid" are non zero, the message will show a warning icon as pictured
above, else an information icon is shown. Details of the issues when a warning is present are able to be obtained from
the SCADA Log, which is the eight button from the left in the SCADAConnect Simulator dialog (see SCADAConnect
Simulator (on page 582)).
If the user wants to import data from multiple historical times, the steps from Import Field Data from SCADA should
be repeated for each time. The imported values are displayed in the lower right pane.
Darwin determines if the imported values are to be Observed Target values (pressures, pipe flows), Boundary Overrides
(tank level, pump status) or Demand Adjustment (junction demands).

Alarms
Alarms refer to messages that are generated by WaterGEMS/CAD when specific values are exceeded in model results.
Alarms can be created at any SCADA element or for high and low values of tank elements. They differ from alerts in
that alerts can be triggered at any type of element and can include multiple elements in one alert. As a property of a
SCADA element, alarms are intended to mimic the response of alarms in a SCADA system.
The alarms can be established by setting up a SCADA element with a property on which an alarm can be based. Under
the Active Alarms property, the user can set up 4 different combinations of alarms
• Low
• High
• Low and High
• Low-low, Low, High, and High-High
Once the user picks the combination of alarm setting, the user fills in the numerical value.

77
WaterGEMS CONNECT Edition Help
Modeling Capabilities

When the model is run, the user can view the alarms by selecting Analysis > User Notifications and picking the Alarms
and Alerts tab.

The buttons on the top of the display include:

The first button is not active for alarms.
The second button enables the user to save the alarms and alerts in a csv file.
The third button generates a report that can be printed.

78
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Thefourth button copies the highlighted alarm.

40020 “Base" "Tank" "456” “T2” 16.598 “Tank T2 low alarm level is violated” Calculation Warnings
The fifth button zooms to the element associated with the highlighted alarm.
The sixth button selects the highlighted element in the model. When multiple elements trigger an alert, it is to do this in
the Details version of alerts.
The final button is Help.
Alarms can also be set up for Tank elements in the element property grid. The user selects where High and/or alarms
are desired by setting Use High/Low Alarm to True and setting the numerical value as either an Elevation or a Level.

Alerts
A user can establish Alerts which are settings that will trigger messages when an alert Criterion Value has been
exceeded. Alerts differ from Alarms in that they can be associated with any type of hydraulic model element. Alerts are
set up in the Alerts manager which can be accessed from Components > Alerts or as the second button from the
SCADAConnect Simulator dialog.
Alerts can be used for example, to find all junction elements that fall out of a given pressure range during a model run.
Alerts Manager

79
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The alerts manager is shown below:

From the buttons at the top of the dialog, the user can create new alerts, delete existing alerts or duplicate an alert.
Checking a box in the column labelled when the alert is to be used in the next model run.
The Label is a user supplied name for the alert.
Severity is used to differentiate between different levels of alerts and can be Informational, Warning or Critical. They
affect the color of the symbol at the beginning of an alert.
Element type refers to the type of element covered by the alert. Each element type has its own alerts such that junctions
and hydrants would need their own alerts.
The Include Elements column enables the user to apply an alert to all elements of the selected type or to a selection set
of elements.
The Results Field column enables the user to specify which result property for the elements will be used in the
comparison.
The Test Criterion column identifies which type of relationship is to be used for the comparison.
The Criterion Value column enables the user to set the threshold numerical value used for the comparison. It is best to
not set the threshold too tightly or it will result in a very large number of alerts.
The Units column is a read-only column showing the user the units for the criterion value.
Alerts Results
Alerts are calculated at the time the scenario is run, not when the alerts are entered.
The alert messages can be found with user notifications under Analysis > User Notifications and picking the Alarms
and Alerts tab.
Most of the columns are self-explanatory. The color of the message is an indication of its severity.
When multiple elements trigger alerts, these can be viewed by picking the Details (first button on top of table) to view
multiple alerts at a given time.
The second button enables the user to save the alarms and alerts in a csv file.
The third button generates a report that can be printed.
The fourth button copies the highlighted alert.
40020 "Base" "Tank" "456" "T2" 16.59 "Tank T2 low alarm level is violated." Calculation Warnings
The fifth button zooms to the element associated with the highlighted alert.

80
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The sixth button selects the highlighted element in the model. When multiple elements trigger an alert, it is to do this in
the Details version of alerts.
The final button is Help.

SCADAConnect Simulator
SCADAConnect Simulator provides a way for users to modify and run a model scenario from a very simple user
interface without the need to interact with some of the more sophisticated features of WaterGEMS/CAD with the
option of loading initial conditions from SCADA data. With SCADAConnect Simulator, an operator can take an
existing WaterGEMS/CAD model, make some simple changes to simulate for example a fire, pipe break or shutdown,
override any controls or demands, and quickly make a model run to determine such properties as pressures, flows, tank
levels, water quality and energy use depending on how the model was set up.
There are essentially two roles in SCADAConnect Simulator: a modeler who sets up the model as described in the
preliminary setup section below and a user (intended to be an operator or someone who may not have all the
background of the modeler who can use the model to generate results).
Preliminary setup
In order to run the simulator, it is necessary to have a model with an existing Extended Period Simulation (EPS)
scenario already created with the Calculation type "SCADAConnect Simulator" in the calculation options for the
scenario(s) that will be used as the baseline starting point for SCADAConnect Simulator runs.
The model to be used in SCADA Simulations should be calibrated well enough for its intended purposes so that users
will have reasonable confidence in the results. It is helpful to give SCADA scenarios informative names such as
"average day", "weeklong water age run" or "peak summer day". The model needs to be updated to include important
facilities as they are added such as a new pump station or a new transmission main but usually does not need to have
every small new pipe included if it is not expected to affect results. Using the SCADAConnect Simulator on a routine
basis can provide insights as to how well the model simulates the real system and can even be used to indicate SCADA
signals that may be inaccurate.
The scenarios that are set up to be baseline starting scenarios should reflect the purpose of the run. If disinfectant
residual is to be calculated, then decay rates for the disinfectants should be specified. If energy runs are to be made, the
pricing for energy should be set up.
The modeler should also anticipate and set up any symbology such as color coding or annotation that the user may be
expected to want to view. It may be helpful to create some predefined graphs where the user would only need to select
which scenario is being displayed in the graph and named views which enable the user to quickly zoom to a view of a
particular area of the system (see Graphing and Named Views).
If values for initial conditions are to be imported for use in a simulator run, the import mappings need to be set up using
the SCADA Signal setup (see SCADA Signals Setup). The modeler may also want to set up any Alarms and Alerts that
the user may need (see Alarms and Alerts help) which can indicate if there is an alert at the current time step or at any
time step.
If the results of model runs are going to be published to a SCADA OPC server for display in a SCADA Human
Machine Interface (HMI), the modeler needs to create the mappings from the model to the server (see SCADA signals
results publishing) and set up the HMI to display those results.
Using SCADAConnect Simulator
Once the model has been set up, it can be used in the simple SCADAConnect Simulator. To use SCADAConnect
simulator, start WaterGEMS CONNECT and open the file for the model. Select Analysis > SCADAConnect Simulator
or pick the SCADAConnect Simulator button.

81
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The simulator opens to the Home tab where a user can set up and control individual runs. The user should first select
the baseline scenario on which the SCADAConnect Simulator run will be built by clicking the drop down button on the
Baseline Scenario field. If the drop down does not contain any entries, it means that no SCADA Simulations have been
established. See the section above for instructions for creating a SCADA simulation using Calculation Options.
Once the Baseline Scenario has been selected, the user can run it or preferably can make changes to it to reflect the
situation to be modeled. The simulator manager is shown below:

If a user wants to compare the results of a run using the SCADAConnect Simulator with the results of the baseline
scenario without the adjustments, it is best to create a copy of that scenario with a name like AveDaySCADA (if the
baseline is AveDay) so that the results of the two runs can be compared. If this is not done, the results of the
SCADAConnect Simulator runs will overwrite the results of the baseline which may or may not be desired. It is also
advisable to create a duplicate of the Calculation Options with the Calculation Type set to SCADAConnect Simulation.
If the user gets this screen below upon opening SCADAConnect Simulator, it means that they do not have a
SCADAConnect Simulator scenario in the model.

82
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The user needs to create a scenario with the Calculation Type set to SCADAConnect Simulator as shown below.
Picking this calculation type gives the user the ability to make model runs from the SCADAConnect Simulator.

83
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Upon starting SCADAConnect Simulator, the use sees the manager below:

84
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The middle pane of this manager is the location where the user can make changes to the baseline scenario for the model
run of interest. There are four ways in which the baseline can be modified.
1. Daily demand adjustments where the user can change demands to reflect special conditions or events (see Demand
Adjustments-SCADAConnect Simulator).
2. Control overrides where the user can insert control statements to change how pumps and valves are operated (see
Control Overrides-SCADAConnect Simulator).
3. Pipe breaks where a user can specify the location of a pipe break and the approach for shutdown and repair (see
Pipe Break-SCADAConnect Simulator).
4. Fire response where the user can place a fire and view their impacts (see Fire Response-SCADAConnect
Simulator).
Each of these selections opens a manager where the user provides the details which are described in the particular Help
topics. Unchecking the check box indicates that the given overrides are not to be used for a run.
The upper portion of the SCADAConnect Simulator manager contains buttons to quickly navigate to tools in
WaterGEMS/CAD that can help the user view results. These include:
• Time Browser - adjusts the time step to that selected by the user
• User notifications - displays errors and warning associated with the current run
• SCADA Elements - enables the user to view results for SCADA elements

85
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Graphs - provides the user access to the graphing manager

• Named views - zooms to a predefined view
See the help for these individual features which explain how to use them.
The right side of the top pane contains buttons to navigate within SCADAConnect Simulator including New type of
run, Edit highlighted run, Delete highlighted run, Zoom to element, highlight elements in a map and expand or collapse
the tree view.
The bottom portion of the SCADAConnect Simulator manager contains a description of the calculation options for the
current run.
Simulation mode indicates which of four different ways the scenario handles initial conditions with regard to such
properties as tank water levels, pump status and settings and valve status (The default value is baseline):
1. Baseline initial uses the baseline scenario initial settings with no modifications
2. Historical loads the model with initial conditions from the simulation start date and time for data found in an
historical source
3. Historical (Live Training) loads the model as from an historical run but increase the start time of the historical run
by the auto compute interval shown in the property grid before loading and running the model again
4. Live loads the model with initial conditions from current data provided from an OPC server or the latest value from
a database source
5. Live (Auto Compute) loads the data as from a Live run but will reload and rerun the model at a user specified time
interval
If no values are available from the SCADA system for an initial setting, the values from the baseline scenario are used.
SCADA Calculation Type which identifies if the model run is to be Hydraulics Only, Age, Constituent or Trace type
runs. This overrides the calculation option in the baseline scenario. If one of the water quality type runs is selected, the
user must have set the properties of the run in the appropriate water quality alternative. Default value is Hydraulics
only.
The value for Calculation Times is used to set the simulation start date, start time and duration and depends on the
simulation mode. For historical and baseline mode, a start time is required while for Live runs only the duration is
required.
The Emergency Response tab provides the user with a quick way to set up a pipe break (shutdown) (see Pipe Break) or
Fire response run (see Fire Response). The other buttons in the top pane behave as they do in the Home tab.

86
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The first two buttons in the top pane provide a way for the user to quickly create pipe break or fire response runs.
The Configure tab provides the user with a way to easily get to tools to set up a SCADAConnect Simulator run.

87
WaterGEMS CONNECT Edition Help
Modeling Capabilities

SCADA Signals button opens the SCADA Signals setup manager (see SCADA Signals setup) where the user can map
SCADA tags to model elements using SCADA Signal elements (see SCADA signal elements).
View Log opens text file with messages that can be useful in debugging SCADA Signals.
Alerts opens the Alerts manager (see Alerts) where the user can set up alerts which the user can view after a run in the
user notifications (Alerts and Alarms tab).
The Import Initial Settings button enables the user to manually import initial settings to override those in the baseline
scenario (see Importing Initial Conditions with SCADAConnect). The user can either import initial conditions from
historical or real time data sources. SCADA Signal elements must exist and be linked to SCADA Signals (tags) before
this can be used. Doing a manual import is not normally necessary within SCADAConnect Simulator since this will be
done automatically at the start of a calculation (all types except the Baseline Initial Condition type). A manual import
may be used to test/debug the import process from SCADA data. Any errors encountered will be displayed in the
SCADA log.
The Results Publishing button is used to optionally publish results from a SCADAConnect Simulator run in an OPC
server to be provided to the SCADA system Human Machine Interface (HMI). The button enables the user to specify
the mapping from the model results to a tag in the OPC server. The OPC server must already be set up (see
SCADAConnect Results Publishing).

Control Overrides in SCADAConnect Simulator

The simulator user may want to control elements in the model in a different way that specified in the control statements
in the Baseline scenario. This can be done in the Simulator dialog by picking the ellipse button in the Control Overrides
field. This opens the Control Overrides dialog. Pick New to create a new override.
The user is then prompted to pick the element to override. This includes pumps, pipes and most control valves.

The columns in the Control Override are described below:

• Enabled? Should be checked if the user wants to use the override in the current simulation.
• Controlled element is the label of the element to be controlled.
• Element type is a read-only column identifying the type of element.
• Attribute is used to specify which setting or status is to be overridden. These are only to be used for control
properties. For example, pipes can be open or closed but their diameter cannot be changed here.
• Value is the new status or setting. Status refers to on/off, open/closed properties while setting refers to continuous
properties like pump speed.
• Start time is the time when the override begins.
• Duration is the length of time the override is in force.
• Priority is used to determine which control takes preference when there are conflicts between overrides.

88
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Notes can be used as reminders of why the override is being used.

Control overrides are saved with the Calculation options for a scenario. If the user wants to experiment with overrides
but does not want to affect an existing scenario, then the user should create a new scenario with a new set of calculation
options.

Demand Adjustments - SCADAConnect Simulator

Daily Demand Adjustments opens the table below where a user wants to modify a demand for a run. This may
correspond to events such as a sporting event or concert, a high demand due to hot, dry weather, transfer of water to a
neighboring utility, among others. Creating a demand adjustment consists of specifying the Scope of the adjustment
(whether it is the Entire network or some previously created selection set (see Selection Set for a description of creating
such a set), the demand pattern for the elements on which it is placed, the operation (whether the adjustment adds
demand, multiplies existing demands or sets a new demand) and the numerical value of the adjustment (add, subtract
and set must be in the display units of the model while multiply and divide are dimensioneless).

The bottom portion of the table contains some background information about the run. The estimated daily demand
contains the total demand of the system divided by the number of days covered in the duration of the run.

Fire Response, Pipe Break and Shutdowns, and Control Overrides

Fire Response
Fire Response enables the user to place a fire demand (or other emergency flows) at a junction for a period of time to
determine its impact on pressure and flows and possibly test alternative ways of responding to the fire. The user can
reach fire response from the Home tab or the Emergency Response tab in SCADAConnect Simulator. This is to be used

89
WaterGEMS CONNECT Edition Help
Modeling Capabilities

for simulating the operational consequences for a fire. For system wide fire flow capacity analysis, the user should use
Fire Flow Analysis (see Fire Flow Analysis).
When the user picks Fire Response, a dialog appears. The user then picks the node where the fire flow is placed. Then
the user completes the fire flow demand, start date/time and duration of fire demand.

In some cases, fire fighters will use a large flow to control a fire for a few hours and then a lower flow to finally
extinguish the fire. This would correspond to two entries in the Active fire flow dialog. An example of that setup is
shown below.

The image below shows the symbol for a fire placed on a hydrant element.

90
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Pipe Break and Shutdowns

Pipe Breaks enables the user to specify a pipe break or a shutdown of a portion of the distribution system. (A shutdown
is simply an isolated pipe break with zero leak flow.) The user can reach Pipe break simulation from the Home tab or
Emergency Response tab of the SCADAConnect Simulator.
Pick the New button at the top of the Active Pipe Breaks dialog. This opens a row in the dialog shown below where the
user can describe the break.

Enable indicates that this break is included in the scenario being run. The broken pipe is the pipe on which the leak is
located. The user is prompted with a Select from Drawing dialog. The user should pick as accurate a leak location as
possible because the leak symbol will be placed exactly at that location with respect of isolation valves. The exact leak
location becomes important in determining how to isolate the leak. The pipe break simulation divides the duration of
the run into the following time periods.
• Time before leakage start time when demands follow baseline scenario
• Time after leakage start but before isolation when leakage flow is added to the model and all pipes are in service

91
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Time after isolation start during isolation duration when isolated pipes have no flow and isolated nodes have no
demand
• Time after isolation duration when flows return to values from baseline scenario
To define these times the user must specify leakage start date and time, isolation start date and time, and isolation
duration. If the user is specifying a shutdown with no leakage, set the leakage flow to zero and the leakage start time
doesn't matter.
The leak must be isolated for repair. To do this the user can either manually specify the valves and pipes to close or
have the model pick the valves to close.
Manually picking the valves involves using the Select from Drawing toolbar button which will allow manual selection
of the elements to close. Instead the user may wish to let the software decide which valves to close to isolate the pipe
break. This can be achieved by clicking the Auto-Isolate button. The software will then populate the list of elements to
close with those necessary to isolate the leak. At any time the user can choose to manually modify the automatically
selected list and/or make additional manual selections. If it is known in advance that a particular valve or valves are not
valid for isolation (perhaps a valve is known to be stuck open, or a particular control valve should not be closed for
operational reasons) then the user may specify these elements by clicking the ellipsis button to the right of Elements to
Exclude and selecting those elements. The next Auto-Isolation run will look for alternative valves to close.

92
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Once the valves have been selected, the user can chose the highlight button (fourth button) to display the isolation. If
the user is attempting to isolate a section of the system for repairs (e.g. pigging), the isolation valves must be manually
selected.
If there are no isolation or other valves in the model in that part of the system, the user can select pipe elements to
close. It is up to the user to ensure that these pipes do have sufficient valves to accomplish this isolation.
During the time that the leak (or maintenance event) is isolated, the flows in pipes in that area are zero and the demands
are zero. The hydraulic grade and pressure in the isolated area will not have valid results.

Control Overrides
Control Overrides enables the user to modify controls on elements from those associated with the baseline scenario. For
example, the user may instruct the model to force a pump to run for 3 hours starting at 4:00 am regardless of what the
baseline scenario would have done. To set up a control override, pick the New button at the top of the Active Control
overrides and pick which element is to be controlled, that property is overridden (e.g. for constant speed pump pick
pump status and for variable speed pump, pick pump setting) , the value (On/off for constant speed, relative speed for
variable speed pumps), the date and time when the override starts, the duration of the override and the priority if
desired.

93
WaterGEMS CONNECT Edition Help
Modeling Capabilities

This can also be used to simulate a power outage by setting the pump status value to Off over some time period.
Custom Sorting
With control overrides, you can set a custom sort which is automatically applied when the editor is reopened and
controls the order of the child nodes in the SCADAConnect Simulator structure.
To set a custom sort order, right-click any column header (other than Value and Start Time), Sort->Custom. When the
dialog comes up, select the columns and order you want to sort.

Once you have set the attributes and sort order, click the "Save As Default" button (last button on the right in the
toolbar) to save this configuration.
This sort order is applied to the control overrides table and controls the order of the children of the Control Overrides
node in SCADAConnect Simulator.
The custom sort defaults is global and applies to all WaterGEMS/WaterCAD projects and all calculation options for
any scenario.
By default, the XML file that stores the custom sort does not exist. Until the user specifies a custom sort of their own
the factory sort is automatically applied.

94
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The factory default sort order is:

• Enabled? (Ascending)
• Controlled Element (Ascending)
• Element Type (Ascending)
• Start Date (Ascending)
• Start Time (Ascending)
To reset back to the factory default sort order, make sure SCADAConnect Simulator is closed and delete the file:
Haestad.Water.Forms.EditorModel.Collections.SCADA.ControlOverridesCollectionTableModel_sorts.xml in
%UserProfile%\AppData\Local\Bentley\WaterGEMS\10.

SCADAConnect Simulator - Pipe Shutdowns

Pipe shutdowns enable the user to shut down a portion of the distribution system and simulate the results of doing so.
The user can reach pipe shutdown simulation from the Home tab or Emergency Response tab of the SCADAConnect
Simulator.
Pick the New button at the top of the Active Pipe Shutdowns dialog. This opens a row in the dialog shown below where
the user can describe the shutdown.

The Enabled? column indicates that this shutdown is included in the scenario being run. The shutdown pipe is the pipe
to isolate. The user is prompted with a Select from Drawing dialog. The pipe shutdown simulation divides the duration
of the run into the following time periods:
• Time after isolation start during isolation duration when isolated pipes have no flow and isolated nodes have no
demand
• Time after isolation duration when flows return to values from baseline scenario
To define these times, the user must specify isolation start date and time, and shutdown duration.
The pipe must be isolated for repair or other maintenance. To do this the user can either manually specify the valves
and pipes to close or have the model pick the valves to close.

95
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Manually picking the valves involves using the Select from Drawing toolbar button which will allow manual selection
of the elements to close. Instead the user may wish to let the software decide which valves to close to isolate the pipe.
This can be achieved by clicking the Auto-Isolate button. The software will then populate the list of elements to close
with those necessary to isolate the pipe. At any time, the user can choose to manually modify the automatically selected
list and/or make additional manual selections. If it is known in advance that a particular valve or valves are not valid for
isolation (perhaps a valve is known to be stuck open, or a particular control valve should not be closed for operational
reasons) then the user may specify these elements by clicking the ellipsis button to the right of Elements to Exclude and
selecting those elements. The next Auto-Isolation run will look for alternative valves to close.

Once the valves have been selected, the user can choose the highlight button (fourth button and on by default) to
display the isolation.
If there are no isolation or other valves in the model in that part of the system, the user can select pipe elements to
close. It is up to the user to ensure that these pipes do have sufficient valves to accomplish this isolation.
During the time that the shutdown is isolated, the flows in pipes in that area are zero and the demands are zero. The
hydraulic grade and pressure in the isolated area will not have valid results.

96
WaterGEMS CONNECT Edition Help
Modeling Capabilities

SCADAConnect Simulator - Power Outages

Power outages enable the user to mark pumps or variable speed pumps as being affected by a power outage. The user
can reach power outages from the Home tab or Emergency Response tab of the SCADAConnect Simulator.
Pick the New button at the top of the Power Outages dialog. This will take you into selection mode to select one or
more pumps or variable speed pumps that have no power.

97
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The "Enabled?" column indicates that this power outage is included in the scenario being run. The outage start date and
time columns indicate when this outage started. The duration determines how long the outage lasted. Outage elements
specifies which pumps in the model were without power during the run.
To modify which elements is part of this outage you can click the […] button in the Outage Elements column for the
outage you want to modify.
When you click the […] button for the outage elements column, the list of outage elements, if any, is displayed.

98
WaterGEMS CONNECT Edition Help
Modeling Capabilities

This dialog will list the pumps selected for this outage. To select additional elements, click the first toolbar button
"Select From Drawing". The second toolbar button will remove from the table the currently selected row. The last
button will clear the table of any selected elements.

99
WaterGEMS CONNECT Edition Help
Modeling Capabilities

From the SCADAConnect Simulator dialog you can do a quick add of a power outage. When you do a quick add you
will be taken immediately into select from drawing mode to select the pumps that are part of the outage. You are then
presented with a dialog so you can specify the starting date and time of the outage and the duration of the new outage.

100
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The new power outage response dialog shows a summary of the selected outage elements. You can also enter the
starting date and time of the outage and the duration of the outage. Click OK when done. The new outage will appear in
SCADAConnect Simulator.

Isolating a Pipe in SCADAConnect Simulator

Users can analyze the effect of shutting down a pipe for routine maintenance or emergency repair using
SCADAConnect Simulator. Within SCADAConnect Simulator (Analysis > SCADAConnect Simulator), the user can
start the pipe isolation tool either by:
1. Picking Pipe Shutdowns from the middle pane of the Home tab.

101
WaterGEMS CONNECT Edition Help
Modeling Capabilities

This will open the Active Pipe Shutdown dialog where the user can pick New to be able to select the point on the
pipe to be shut down using the Select from Drawing option.

102
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Or
2. Picking Pipe Shutdown from the Emergency Response tab.

103
WaterGEMS CONNECT Edition Help
Modeling Capabilities

This automatically opens the Select from Drawing option.

Selecting the pipe opens the dialog below where the user sets the pipe label, start time for shutdown and duration.
The user can also select the Isolate Shutdown tool.
Regardless of how shutdown pipe was selected, the Pipe Shutdown dialog should look like this when completed:

104
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If Isolate Shutdown is selected, the user can manually select the valves to be closed to isolate the location or use
the Auto-Isolate button which will automatically identify valves to be closed.

105
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If the user knows that some valves may be inoperable, the user can select Elements to Exclude and manually
identify those elements.

106
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If the user selected Highlight, the point to be isolated is shown as a circle with a white X and closed valves will be
higlighted.

Once the isolated pipe is identified, the user can pick the Compute button and the Baseline Scenario will be run
with the valves closed in the model.

107
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Picking the + button above the list closed valves will zoon to the selected valve.
The pipe shutdown feature is intended for models which have explicitly included isolation valves associated with
pipes. If the system does not have isolation valves in the model, then the isolation will search for the nearest PRV or
pump feeding the shutdown point which will be misleading for system with isolation valves.

Displaying Model Results in SCADA Human Machine Interface (HMI)-Overview

WaterGEMS/CAD enables a user to run an EPS analysis and display the results in a SCADA HMI. The process is
summarized in the figure below. The blue boxes are the work flow for a user. The orange boxes are configuration steps
that are set up once (unless changes are needed).

Model results are not directly displayed in the HMI. As is typical of SCADA systems, values are placed in an OPC
server and these values are then displayed from the OPC server to the HMI. Therefore it is necessary to define
mappings from the model to the OPC server tags and then identify which tags are displayed in which locations in the
HMI. ("Tags" refer to the name of a property in the server.)
Configuration Steps
Because there are numerous brands of OPC servers and HMI software, it is not possible to give detailed steps on setting
up the server and configuring the HMI. Users are referred to the documentation of those individual products for
instructions. The user needs to install the OPC server and the HMI software before running WaterGEMS/CAD SCADA
simulations. The server can be set up on the computer running the model or hosted on another computer networked to
the model.
It is best to use the same versions of the server and software that the system operators are using so that users will be
familiar with the software. It may be possible to make a copy of the server and display files for use with the model.
However there is not a one-to-one relationship between model parameters and values that are displayed in the operator's
HMI. The model can calculate far more properties at more location than the SCADA system but the model is not
concerned with non-hydraulic properties. This can be visualized as shown below. The properties in the blue box are an
example of information that can be provided to the HMI from the model that is not available from the SCADA system.

108
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Once the OPC server is set up, the user can define the tags that are to be published from each model run. These would
normally include the hydraulic properties that are displayed in the SCADA system but can include a wide variety of
values that the model can generate. (These are essentially "software sensors" as opposed to the physical sensors in the
field.) Before associating model element with SCADA tags, the user must set up the tags in the SCADA OPC server in
accordance with the procedures for that server.
The mappings from the model to the server are set up by selecting Analysis > SCADAConnect Simulator > SCADA
Results Publishing ( in the Configure tab of the SCADAConnect Simulator dialog).
This opens the SCADA Results Publishing table where the user defines which properties are associated with each tag in
the server. The first time this is done, the user must first pick the OPC server by selecting the fourth button.

109
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If the server is on a different computer than the model, the user identifies this by checking the Host box and navigating
to the server location using the ellipse button.
The user can also specify the units associated with the values in the OPC server which may be different from the values
in the model.

The user then fills in the SCADA Results Publishing Table by specifying which model element and property are
associated with each tag. If the user does not wish to use to publish the result for a given property in a given run, the
Enable box should be unchecked.

110
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Once the mappings are complete, when a model run is completed, the results can be published to the OPC server for
use in the HMI.
When model results are associated with a tag in the OPC server, the user must define how the result value is displayed
in the HMI. It is best to model this behavior after the actual HMI although, as stated above, not all the values in the
HMI are hydraulic values and the model can populate more tags than the actual HMI. The user can create a new set of
HMI screens or can modify the existing screen to accept additional values.
Model to HMI Work Flow
Once the mappings from the model to the OPC server and on to the HMI display have been completed, the results of
any model run, for which the Calculation Type is designated as SCADAConnect Simulator, are available for display.
At the start of a SCADA runs, a series of checks are made to determine such things as whether a tag is available in the
OPC server for each mapped property or if a model element is active for each tag. Any errors or warnings can be found
in the SCADA Log which is shown in the Configure tab of the SCADAConnect Simulator dialog.
When the HMI is started, the results will be those corresponding to time 0. To advance to different times or run
continuously, the user must open the Time Browser (Analysis > Time Browser). The user can advanced time using the
buttons at the top of the dialog or pick a specific time to view from the list of times in the lower portion of the dialog.

111
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The controls for the HMI such as panning, switching screens etc. depend on the brand and version of the HMI and
instructions can be found with that software.

SCADAConnect Results Publishing Dialog

Model results can be published to an OPC server for display in a Human Machine Interface (HMI). The user must
identify the mapping between the model element and the tag/signal in the OPC server. The hydraulic models do not
directly display their results in the HMI but instead publish the results to any OPC compatible server. The HMI then
reads from the server and display the results. When the model Time Browser advances to a new time, the published
results are updated. The signal mappings to the server are explained below.
In most cases, the OPC server to HMI programming already exists for the real SCADA system and can be used as an
example when setting up model to HMI mappings. The difference is that the model is only interested in hydraulic
properties and can display far more hydraulic properties at more locations than the actual SCADA system.
The SCADA results publishing dialog can be accessed using Analysis > SCADAConnect Simulator and picking the
sixth button (SCADA Results Publishing) in that dialog:

112
WaterGEMS CONNECT Edition Help
Modeling Capabilities

This opens up the Results Publishing Dialog. The first step is to identify the OPC server to be used. This is done by
picking the fourth button on top of the dialog, Define OPC Server Connection.

This opens the dialog below where the user identifies the OPC server to be used. If the server is hosted on a different
computer, the user should check the box labelled Host and search for the computer on the network. If the server is
located on the user's computer, the user need only search from the drop down list of servers.

113
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The other buttons at the top if the dialog include, Open an addition signal to model mapping, Delete a mapping and
Duplicate a mapping.
Before opening this table, the signals/tags need to be identified in the OPC server. This varies between OPC servers and
the user needs to consult the documentation for the specific brand and version of the server.
The columns in the table include:
Enable which when checked indicates that the row in this table is to be used for publishing. Unchecked, the results are
ignored.
Element indicate which model element is to be used for the mapping. The Element Type is automatically populated as a
read-only field.
The Result Attribute identifies which property from the model element is to be mapped to the OPC tag.
The OPC Tag is the tag/signal name of that property in the OPC server. These tags should be established before
opening this table.

114
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Picking OK sets up the mappings in the model such that as the Time Browser is advanced, the correct value is
published to the OPC server.

SCADA Log
On occasion, the SCADA to model connections generate error/information messages. These messages are displayed in
the SCADA Log which can be accessed by Analysis > SCADAConnect Simulator and selecting View Log button in the
Configure tab.
This opens the SCADA Log. The log is a text file which can be helpful in diagnosing problems and communicating
with Bentley Technical Support. It can be viewed with Notepad or other similar programs.

SCADA Signals Dialog

The SCADA Signals dialog enables the user to associate a SCADA data source with a model and then map the
individual signals to signal elements in the model.

The buttons on top of the left pane are described below:

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. [xref to those help topics]
Edit enables the users to view and modify previously defined database or OPC sources by opening the detailed dialogs.
Delete deletes the existing highlighted datasource or signal.
Rename allows the user to rename the selected data source or signal.
Duplicate enables the user to duplicate an existing datasource.
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.

115
WaterGEMS CONNECT Edition Help
Modeling Capabilities

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.

116
WaterGEMS CONNECT Edition Help
Modeling Capabilities

SCADAConnect Toolbar
When the user selects Tools > 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.
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.
The fourth button creates a SCADAConnect log which enables the user to view what SCADAConnect did and is
helpful in debugging problems.
The fifth button opens this Help topic.

Historical OPC Source Dialog

When the user selects Historical OPC source as the signal source, the program can pull current data directly from and
OPC server. The following dialog opens:

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.

117
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Real-time OPC Source Dialog

When the user selects Real-time OPC source as the signal source, the program can pull current data directly from an
OPC server. The following dialog opens:

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.
The real time OPC signal values can be viewed in the SCADA Signals dialog as shown below:

Citech Connection Dialog

When the user picks a Citech connection, it is established in the dialog below:

118
WaterGEMS CONNECT Edition Help
Modeling Capabilities

When Remote server is checked, the use must enter the computer name. If unchecked, the server is assume to be on the
same computer as WaterGEMS CONNECT. Authentication can be specified for those servers requiring it.

Flushing Simulation

WaterGEMS CONNECT flushing module can be used to simulate the effect of flushing water distribution systems.
There are several purposes for flushing distribution systems including increasing velocity to scour pipes, reducing water
age, testing operation of hydrants, etc. The WaterGEMS CONNECT implementation of flushing is oriented toward
increasing velocity in mains to flush out solids and stale water. The primary indicator of the success of flushing is the
maximum velocity achieved in any pipe during flushing operation.

Type of Flushing
The basic concept in flushing is an "Event". This corresponds to one snapshot during a flushing program. Flushing
analysis consists of simulating many flushing events.
WaterGEMS CONNECT can analyze two general types of flushing, Conventional and unidirectional:
• Conventional flushing consists of opening up hydrants or blowoffs one at a time without any isolation valve
operation.
• unidirectional flushing (UDF) consists of one or more hydrants or blowoffs while isolation valves (or pipes) may be
closed to control the direction of flow.
Depending on the target velocities and layout of the system, conventional flushing is often adequate. unidirectional
flushing will improve velocity although it requires additional labor. A recommended workflow is to first simulate
conventional flushing and then identify areas which are not adequately flushed and require unidirectional flushing. If a
secondary goal is to test the operation of every hydrant, then conventional flushing is usually adequate while if valve
exercising is also a goal, unidirectional flushing becomes more attractive.

Starting Model

119
WaterGEMS CONNECT Edition Help
Modeling Capabilities

For flushing analysis, it is best to start from an all-pipe model. Small pipes without a means of flushing (e.g. 2 in. pipes)
can be excluded. Ideally, the model will also contain every hydrant and isolating valve at its exact location. This is
especially important for UDF because the location of a hydrant relative to the closed valves is very important.
If a model does not contain hydrant elements, junction nodes can be used as flushing points. The error should be small
for conventional flushing although for UDF a valve may be closed between the hydrant and junction. If hydrant
elements are used, it is not necessary in explicitly include the hydrant lateral in the model because the lateral length and
its associated head losses can be accounted for within the hydrant element.
If isolating valves are not included in the model, the user can simulate valve closing by closing pipes, although it is up
to the user to insure that a valve is actually available in the field to close the pipe.

Specifying hydrant flows

Hydrant flows may be specified directly in flow units or as an emitter coefficient. Because hydrant flow is a function of
pressure and the user does not usually know the pressure at the hydrant beforehand, it is more accurate to specify the
emitter coefficient. For standard North American hydrants that comply with AWWA Standard C502 or C503, the
emitter coefficient would be 150-180 gpm/psi0.5 (11-14 L/s/m0.5) for the 2.5 in. (63 mm) outlet and 380-510 gpm/
psi0.5 (30-40 L/s/m0.5) for the 4.5 in. (115 mm) outlet depending on the model of hydrant, size of barrel and length of
barrel. See Advanced Water Distribution Modeling and Management (p 451-453) for more discussion on this. In terms
of flow units, free discharge from a hydrant can vary from 500 to 1500 gpm (32-95 L/s) depending primarily on the
strength of the distribution system at that point.

Flushing Manager
The Flushing Manager is used to set up flushing events, evaluate their effects and set up reports which can be given to
operators to carry out flushing programs. The flushing manager can be opened by selecting Analysis > Flushing
Manager or picking the flushing manager button from the Analysis toolbar.

Flushing in WaterGEMS/WaterCAD is designed to simulate the kinds of flushing performed to increase velocity or
shear stress in pipes to remove any deposits and thus improve water quality. Velocity or shear stress can be compared
with target values to determine if flushing was successful. This type of flushing is based on steady analysis. If flushing
is being performed to decrease water age, it is best modeled by setting up an extended period simulation run to view the
changes in water age or some other constituent.
Upon opening the manager, the user should select the New button. This will enable the user to start a new flushing
study. Within a study, the user would usually specify Areas which correspond to work done for example in one area of
the distribution system or during one shift.

Note: For users of WaterGEMS and WaterCAD SS3 and earlier, flushing was controlled in the flushing alternative.
For SS4 and later, this functionality was moved to the Flushing Manager and a large number of additional
features were added. Opening a file created in SS3 or earlier will result in the information from the flushing
alternative being transferred to the Flushing Manager.

The following Help topics provide details on the steps involved with setting up flushing and viewing results.

Flushing Terminology

120
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Some terms used in flushing are explained below:

• Event refers to a single operation of a flowed hydrant(s) with any associated valve operation. It corresponds to a
single steady state simulation with a flowed hydrant(s). Events may be conventional or unidirectional.
• Conventional event refers to opening a single hydrant with no associated valve operation (valves are set according
to the representative scenario). A user selects a set of flushing nodes (hydrants or junctions). Each of these nodes are
treated as separate events, making it very easy to set up a large number of conventional events (as opposed to the
more detailed steps needed for unidirectional flushing). The user may wish to quickly assess the performance of
conventional flushing as a first step before moving to unidirectional flushing.
• Unidirectional flushing (UDF) refers to flushing where isolation values (or pipes) may be closed and more than one
hydrant may be flowed. UDF can generate higher velocities and shear stress. The goal is to reach high velocity in a
series of pipes referred to as a Pipe Run which is specified to each UDF event. The user can compare with
conventional flushing to determine if the additional effort is justified.
• Pipe run refers to the collection of pipe links that a user wishes to flush in a UDF event. The volume of water in the
pipe run is used as the minimum amount of water that must be flushed and the time to flush that volume is used as
the minimum time of flushing. A pipe run should consist of pipes in series from the flowed hydrant. There is no
pipe run for a conventional event since flow direction cannot be controlled. Pipes in a pipe run should also be part
of the pipe set (see below) for an area.
• Flushing Area (or Area) refers to a set of flushing events that are usually focused on a given portion of the system.
By computing an area, every event in that area is simulated. An area is associated with a single representative
scenario which controls boundary conditions. An area might consist of a neighborhood to be flushed or a collection
of events that can be run by a crew in a single shift. In general flushing areas should not significantly overlap.
• Pipe set refers to the pipes that the user wants to flush in a given area. These are the pipes considered when
determining properties like "Pipe length met target". The Pipe set should encompass all pipe runs in the area. A pipe
set is a required input. It is created by picking the ellipse button next to pipe set. It is advisable to create a selection
set corresponding to each pipe set before starting the flushing manager. These can be useful for reviewing results.
• Nodes of Interest are nodes for which auxiliary results are saved. These are useful for monitoring nodes than may
have low pressure during flushing. Nodes of interest are an optional input.
• Flowed elements can be either junction nodes or hydrant nodes. For conventional flushing with no valve closure,
hydrants are generally close enough to nodes that the results are virtually the same. However, in UDF where a valve
may be closed between the hydrant and junction, it is important to represent the location of the flowed hydrant
explicitly in the model.
• Controlled (Closed) elements can be represented either by a closed isolation valve or a closed pipe element in UDF.
(There are no closed elements in conventional flushing.) Closing an isolation valve is a more precise way of
modeling UDF but some models do not contain isolation valves. When a pipe element is closed, it is assumed that
an operable valve is present. A closed pipe cannot be part of a pipe run.
• Flushing study refers to a group of areas that possibly cover the entire system. Computing a study will run all of the
events in all of the areas in the study. A set of studies may be used to compare different approaches to flushing a
system. One study may rely heavily on conventional flushing while another may rely on UDF. There needs to be at
least one study with at least one area containing at least one event.
• Representative scenario refers to the existing scenario that established the boundary conditions and demand that
relate to a flushing area. This determines which pumps are operating, what the demands are and what tank levels are
set to during the flushing analysis. These should be steady scenarios. If they are EPS scenarios, then the zero time is
used unless the user specifically sets a time.
• Output scenario is the name given to the scenario that contains the results of the flushing analysis. There is one
output scenario per area and the current scenario should be set to the output scenario to view results in the flushing
result browser once the user leaves the flushing manager.

Flushing Work Flow

121
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Before setting up flushing events in the model, the user should decide on the criteria for flushing, the portion of the
system that will be flushed, and have some idea of the approach to be used. The user may want to initially try
conventional flushing to determine if adequate velocity can be achieve with that approach. Then areas with inadequate
velocity can be addressed using uni-directional flushing in another "study" within the flushing manager. However, the
user may use uni-directional flushing the start, if high velocities are required.
The overall work flow for modeling flushing is shown below:

To perform an analysis of a set of flushing events (i.e. a flushing area), the user must create flushing events. Upon
opening the flushing manager initially and selecting New, there will be a default study "Flushing Study" which will
have one area called "Base Flushing" in the left pane.
The user creates new studies or areas by right clicking on the study node in the left pane. Right clicking on the area
node creates new areas or events.
Within a flushing area, the user defines the representative scenario, target velocity and shear stress, pipe set, method to
determine flow (emitter or flow) and auxiliary output if desired. It is a good idea to create a selection set corresponding
to the pipe set before entering the flushing browser.
The user then creates events within an area. Conventional events are made up of the hydrant (or junction) to be flowed
while UDF events are made up of flowed elements, controlled (closed) elements and pipe runs. The user can also
identify the extent of the drawing that will appear in the optional reports.
Once the events have been defined, the user can compute the flushing events for either the study, the flushing area, or
an individual event depending on which row of the left pane is highlighted when the Compute button is picked. The

122
WaterGEMS CONNECT Edition Help
Modeling Capabilities

results can be reviewed with the Flushing Results Browser which presents results based on events or the Flushing
Results Flex Table which presents results based on pipes.
The user can then optionally prepare a report for the operators who will conduct the flushing containing instructions
and drawings for each event.
When creating areas and events, the user is encouraged to use the Notes fields provided to give field operators
information as to the location of elements to be operated. For example, an operator may not know where hydrant H-237
is but can find "Hydrant on south east side of intersection of Cherry St. and Ford Road".
For best performance, it is recommended that the user have dual monitors such that the model can be shown on one
monitor while the managers and dialogs are shown on the other.
Before opening the Flushing Manager, it is best to set up the color coding that will be used to view flushing. Pipes can
be colored by velocity or shear stress. Junctions can be colored by demand so that the flowed hydrant shows up large
and colorful next to the other junctions. It is best to use both color and size

Starting Flushing Manager

The Flushing Manager can be started by selecting Analysis > Flushing Manager or picking the Flushing Manager
button from the calculation toolbar.
The Flushing Manager opens and the user much create a study and a flushing area. This can be done by picking the
New button from the top of the left pane and selecting New Study or New Area. An area is a subset of a study. A study
or area can also be created by right clicking on a study node in the left pane.
When the study node is highlighted in the left pane, the right pane lists the flushing areas that are associated with that
study. The user can edit the Representative Scenario in the right pane.
Right clicking on the study node opens a list containing
• Add - create new study or area
• Delete - delete the study
• Rename - renames the study
• Compute - computes all of the active events in the study
• Zoom To - zooms to the extents of the elements in the study
• Highlight - highlights the elements in the study
• Expand Children - expands the tree view of areas in the study
• Collapse Children - collapses the tree view of areas in the study

Flushing Area Options

When the flushing area is selected in the left pane, the user can set up global options for the events within that area.
Most of these are set in the options tab in the right pane for the area. The most important is the Representative Scenario
which establishes the boundary conditions (tank levels, pump status, demands) for the area.
The Output Scenario is the scenario where the results of the flushing analysis will be stored. The output scenario is
created automatically the first time the area is computed.
The Target Velocity is the velocity that should be exceeded for the flushing to be considered successful for that pipe.
The user may specify a Target Shear Stress as well as a Target Velocity or in addition to a Target Velocity. If both are
specified, both must be satisfied for a pipe to be considered successfully flushed.

123
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Safety Factor (Flushing Time, Volume) is a multiplier by which the Time (Minimum Flushing) and Volume
(Minimum Flushing) are multiplier to obtain Time (Recommended Flushing) and Volume (Recommended Flushing) in
the Flushing Results Browser.
The Pipe Set is the collection of pipes for which the target velocity will be compared with the maximum velocity
achieved by flushing. It is created by clicking the ellipse button and entering the pipe set dialog. To create a Pipe Set,
pick the ellipse button and then the Select from Drawing button. Picking the Select from Drawing button enables the
user to select the pipes to be included in the set using the standard element selection dialog.
The first toolbar button is used to select elements from the drawing. The standard select from drawing toolbar is
displayed when in selection mode. Only pipes can be selected for this dialog.

(It may be advisable to create a selection set of pipes before entering the flushing manager.) The delete button can
remove individual elements while the Remove All button removes all at once.

The Nodes of Interest ellipse operates similar to the Pipe Set except that it selects nodes that will always appear in the
auxiliary results. Most nodes will not have data saved for each flushing event. Only those that meet the auxiliary results
criteria or appear in the Nodes of Interest will be included.
Boundary elements are pipes or isolation valves which are closed for all of the events in an area. This is used for "back
door" feeds to the area to ensure that all of the flow will enter the pipe run from the desired direction.

124
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Under flushing flows, the user can specify either the emitter coefficient for the hydrant or junction being flowed or the
actual flow rate. Because flow rate depends on pressure and the user does not usually know the flow rate ahead of time,
it is usually more accurate to specify and emitter coefficient. Typical values in North America are 250 gpm/psi0.5 (20
L/s/m0.5). See page 453 of Advanced Water distribution Modeling and Management (Bentley). Do not specify both an
emitter coefficient and a flow.
Depending on the selection from the drop down menu "Apply Flushing Flow By", the hydrant flow can be added to the
node demand or used in place of the nodal demand.
Under Auxiliary Output, the user can save values for all elements for each event. However, in most cases the user is not
interested in values for properties in elements far from the flushing. The user must therefore specify condition for
which element data are saved and available for display for individual events. If the box, "Includes nodes with pressure
less than?" is checked, properties for elements with pressure less than the specified value are saved for display/ If the
box, "Include pipes with velocity greater than?" is checked, properties of pipes with high velocity are saved. This
makes it possible to use color coding to display results of flushing without saving a great deal of unneeded values.
The Events tab enables the user to get a quick view of the events that are contained in the area and if desired, make
events active or inactive for the next run. Click the Conventional Event Quick Edit button to open the Conventional
Event Quick Edit dialog, allowing you to globally edit local flows and emitter coefficients across multiple events.
The Notes tab enables the user to enter a text description of the area.
Right clicking on an area in the left pane opens the following options
• Add - create new event
• Delete - delete the area
• Rename - renames the area
• Compute - computes all of the active events in the area
• Shift Up - moves the area up the list of areas
• Shift Down - moves the area down the list of areas
• Zoom To - zooms to the extents of the elements in the area
• Highlight - highlights the elements in the area
• Expand Children - expands the tree view of areas in the area
• Collapse Children - collapses the tree view of areas in the area
In the left pane, the type of event and its status is designated by the icon representing that event

- conventional active

- UDF active

- conventional inactive

125
WaterGEMS CONNECT Edition Help
Modeling Capabilities

- UDF inactive

The event Active check box is on the top of the right pane when the event is highlighted in the left pane. Inactive events
are not computed.

Boundary VALVES

This dialog allows you to assign boundary valves for a flushing event.
On the Elements to Close tab you can specify the elements to close for a given area.
Click the Select From Drawing button to select the valves you want to serve as boundary valves. Highlight a valve and
click the Remove button to remove it; click Remove All to remove all valves from the list.
Boundary valves can be any of the six standard valve types, isolation valves and pipes.
Each individual element can have their own notes. An ellipsis [...] button is provided that opens the notes editor.
As there is for events, there is a primary view for the boundary valves. In the Report View tab, you can override the
default primary view and specify your own user defined primary view by clicking the Primary Report View button and
dragging a box in the drawing view to define the view, or by checking the "Is User Defined?" checkbox, which makes
the 4 coordinate fields editable, allowing you to manually enter in values.
You can also define Secondary Views in the bottom pane of the tab.

126
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Flushing Event Creation

Once a study has been defined, the areas that make up the study can be created, and the user can create individual
events. Events are created by picking the New button at the top of the left pane when the area is highlighted and
selecting Conventional or UDF, or right clicking on an area and selecting Conventional or UDF. It is assumed that the
flushing events are conducted in the order in which they are listed. The key to order is usually to flush from pipes with
clean water into un-cleaned areas.
Conventional Flushing
Conventional flushing events have the advantage of being very easy to set up a large number of conventional events in
essentially one step. When conventional is selected as the type of event, the user sees the Selection dialog where
individual junctions of hydrants are selected, junctions or hydrants can be selected by polygon or they can be selected
based on a selection set that has been previously defined. Having a selection set already defined if not all the nodes in a
polygon are to be flowed can be helpful. Each node that is select corresponds to a single event. The selection dialog is
shown below:

Uni-directional Flushing
UDF events can only be created one at a time because the user must select flowed elements, controlled elements and
optionally the pipe run to be flushed. In this case a special form of the select dialog is opened.

While closed/operated elements and pipe run can be specified in any order, it is best to specify the pipe run first to
identify the target pipes of the event and use the pipe run highlighting to visualize the elements to be operated.
The first button is the Select button and should be used when the user has completed making selections and wants to
leave this dialog and keep the selections. The x in the upper will close without saving.
The second button enables the user to define a pipe run. If the user selects a junction at the end of the run and pipe at
the beginning, the model will fill in the pipes in between. The user can also pick the pipes in a run manually one by
one. In general, the pipes in a run should be connected in series. If the user picks the fourth button, individual elements
can be removed from the run.
The third button enables the user to pick which hydrants/junctions are to be flowed and optionally which valves are to
be opened or closed since the previous event. If the model does not contain isolation valves or if the user wants to close
a pipe without using the isolation valve, the user can manually pick a pipe. It is up to the user to ensure that the pipe can
actually be closed.
If a node element is selected, it is considered to be flowed if it is a hydrant or junction and if it is an isolation valve or
control valve is selected, it is considered to be closed.
The fourth button enables the user to remove elements from the selected elements while the fifth will undo the last
selection.
The sixth button directs the model to automatically select vales to be closed to isolate the pipe run. The user can use
this instead of manually picking valves to close with the third button. The user should check to ensure that no demand
nodes are isolated using the auto valve selection.

127
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The Highlight Previous button highlights the previous event (the bottom most active event in the current Area tree OR
the previous most active event from the selection event) in the Drawing Pane. This button is a toggle button; when it's
displaying the highlight, it disables the rest of the buttons in the toolbar (disabling the current selection interaction
mode). The user must un-toggle the button to resume the selection of pipe runs or operational elements.
Resume Selection button is used in the ArcGIS platform when the program switches out of the selection mode.
The Report Views node in the left pane contains a list of drawing views that will be included in the Operator Report.
The report views show the coordinates of the corners of the view. The primary view is created initially automatically
based on the extent of the elements involved in an UDF event and the flowed hydrant with a buffer around it (default =
300 ft) for a conventional event.
Once an event is created, if the event is expanded in the left pane, there is one row for each element that is flowed,
closed or part of a pipe run. The following icons are displayed
When an event is highlighted, the right pane displays details of the elements included in that event.
The events can be edited in the right pane. For example, the flow rate or emitter coefficient for the flowed element can
be modified from the global value by checking the "Specify Local Flows" box and entering a new value. Any fields that
do not have a yellow background can be edited.
This dialog is the place where the user can add notes to any operated elements to give the exact locations (e.g. valve in
front of 37 Green St.) to help field operators locate the model element. The wording in the notes will appear in the
operators report.
In the right pane, pipes can be closed or part of a pipe run. Isolation valves can be open, closed, or reopened (opened
from previous run). Entire rows can be removed from the right pane by highlighting the row and picking the delete
button on top of the dialog.
An entire event can be eliminated from a run by unchecking the Activate button. It can be reactivated by checking the
box. This differs from deleting it from the Area because deleting would not allow it to be reactivated readily.
The element label and type are properties of the element selected and status is an editable field indicating if the element
is open/closed, flowed or part of a pipe run. The user can overwrite the flow emitter or flows specified in the area tab
by checking the Specify Local Flows check box for that element and inserting a different flow or emitter for that
element.
Notes fields are very important if the results of the flushing analysis are to be given to operators to locate elements to
operate. This might include "Southwest side of Adams St. and 3rd Ave." as a hydrant description or "In front of 319
Penn Ave. - watch out for big dog" as the location of a valve that needs to be closed.

Flushing Manager Toolbar Buttons

The buttons at the top of the left pane in the flushing manager are described below:

New - creates new study, area or event depending on which node is highlighted.

Delete - deletes the highlighted study, area or event.

Rename - start editing of highlighted study, area or event.

Duplicate - creates a copy of the highlighted area or event.

128
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Compute - starts analysis of highlighted study or area.

Flushing Browser - opens up flushing browser for the selected scenario.

Report - opens up preview of operator report.

Move Up - moves selected area or event up the list.

Move Down - moves selected area or event down the list.

Zoom - zooms to extent of selected study, area or event.

highlights elements in selected study, area or event, as follows:

• Circles with an X represent closed nodes
• Circles represent open nodes
• Dashed lines represent Pipes
• Solid lines represent Pipe-Runs

Expand/Collapse - expands or collapses selected node.

Options - enables user to set default colors and extent of view in conventional flushing.

Help - opens flushing help.

Flushing Results Browser

The flushing results browser contains the results of a flushing run listed by event. It is assumed that the flushing events
were conducted in the order in which they are listed. The content of the browser corresponds to the current scenario. If
it is not a flushing output scenario, no events would be displayed.
The display in the flushing browser corresponds to the current scenario which needs to be a flushing output scenario.
The scenario can be switched to the flushing browser in the main drawing or by picking the button "Make Output
Scenario Current" next to the output scenario selection in the right pane of the flushing manager.
Before opening the browser it is helpful to set up color coding and annotation that will highlight the flushing events.
Usually color coding pipes by velocity or shear stress and junctions and hydrants by demand will be the most useful.
For example, pipes with a velocity over 4 ft/s (1.2 m/s) might be red with thickness three times that of other pipes.
Toolbar buttons at the top of the browser enable the user to:
• Zoom - zooms to extent of flushing event
• Highlight - highlights elements in flushing event. In highlighting, the pipe run color will override element
symbology color coding
• Reset - cancels out the selected event and displays results for representative scenario
• Report - opens preview of flushing browser report

129
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Help - opens flushing help

The columns listed in the browser include:
• Label - the event label
• Flushing Type - conventional or UDF
• Pipe Length Met Target - length of pipe in flushing area that met both velocity and shear stress target during event
• Cumulative Pipe Length Met Target - sum of length of pipe in flushing area that met target of all events up to
current event
• Incremental Pipe Length Met Target - difference between cumulative length for this event and previous event. If
pipe length that me target is large but incremental length is small, event may be duplicating effects of other prior
events
• Minimum Pressure Node - node with lowest pressure in the flushing area or nodes of interest
• Minimum Pressure - pressure at node in previous column
• Travel Time (Pipe Run) - minimum flush volume divided by hydrant flow
• Volume (Minimum, Pipe Run) - volume of water in pipe run that must be flushed (0 if no run specified)
• Flow (Pipe Run) - flow in the pipe run that must be flushed
When an event is highlighted, the property grid and flex tables will contain values corresponding to that event. If
elements are not associated with the event, they will have NA in many fields.
To view flushing by pipes instead of by event, use the Flushing Area Report (Flex Table).

Flushing Area Report (Flex Table)

While the flushing results browser displays flushing results on an event basis, the flushing area results flex table
presents the results on a pipe basis listing whether the pipe met the flushing target and which event was the most
effective in flushing that pipe.
The flushing flex table can be opened as any other flex table by selecting View > Flex Table > Flushing report when the
current scenario is a flushing output scenario. By default, the table will open with all pipes. It is usually helpful in large
models to make a selection of elements and pick "Open on Selection" (right click on flushing area report button) when
opening the flex table.

Flushing Options Dialog

The flushing options dialog enables the user to set the highlight color for operational or pipe run elements or bounding
boxes for views. The user can also set the bounding box size for the operator report for conventional flushing.
The dialog displays the current color settings. The user can change the color by picking the ellipse button, next to the
type of highlighting and select a preferred color from the color palette that appears.
The user can control the symbol and line size from this dialog.
This dialog also enables the user to globally choose the amount of space around the flushing event that will display in
the operator's report. The user can also set this on a page by page basis in the event in the Report Views in the left pane
for each event.
The Highlight Options drop down menu at the top of the dialog enables the user to set the current options as the default
or revert to the factory defaults.

130
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Flushing Notifications
Several notifications can be generated during a flushing run. They are listed below:

Notification Text Notification Category Response

Pipe set not specified. Error Specify pipe set.

At least one flushing event element is Warning Elements must be active to affect
not active during the flushing run. flushing results. Have you deleted any
pipes since pipe set was created?

At least one run pipe is not included Information Ideally, pipes in a run should be
in flushing pipe set. included in pipe set.

At least one run pipe is closed during Warning Pipes in run should not be closed.
the flushing run.

At least one event contains a pipe run Warning Check for gaps in the pipe run.
that is not continuous.

Flushing Operator's Report

The output report is intended to be prepared by a modeler and given to field operations crews so that they have explicit
direction on which elements to operate. Before opening the operator's report button, the modeler should:
1. Set up the desired background layer.

131
WaterGEMS CONNECT Edition Help
Modeling Capabilities

2. Decide the extent of the view to display and, if additional more detailed views are desired, set up those views.
3. Include detailed notes to help the operators locate the elements (e.g. an operator may not know where H-21 is
located but will know "Hydrant in front of 31 Elm St."). Use the Notes field to specify this text.
The operator report consists of three types of pages for each event:
1. Tabular description of the event indicating which elements to operate.
2. Plan of the entire event.
3. (Optional) Additional detailed plan secondary views of intersections where more detail is desired.
In addition to the default drawing of the event, the user can create "Secondary Views" which may for example, zoom in
to details of a complex intersection. To do this, right click on Report Views in the left pane and pick Add Secondary
View. The draw a box around the extents of the secondary view and click Select New Report View.
The view that appears when the report is opened is called a Preview. With this preview it is possible to:
• Change page setup
• Print
• Export to a variety of file formats including pdf and txt file
• Transmit via email
The report can be saved and it is possible to zoom and pan within the document.
The report by default is set up for landscape printing. However, the user has a great deal of flexibility in printing, (e.g.
printing two landscape pages on a simple portrait page) using the buttons on top of the report preview.
In addition to instructions to operators, the report also contains fields where operators can record the event such as time
of flushing and actual flushing flows.
The reports are intended for color printing as it may be difficult to distinguish between elements in grayscale.

Report Layout

This dialog allows you to select the facing page layout for the Flushing Field Report, so that when printing the pages
face one another correctly. Select whether to start events on an even or odd page using the menu, then click OK.

Flushing Emitter Coefficients

Use of emitter coefficients instead of directly specifying flow rate enable the discharge during flushing to be sensitive
to pressure in the distribution system. Some typical values for hydrants found in North America are given in the table
below. In other areas with different hydrants, users are encouraged to calibrate their local hydrants.

Outlet Size, in. Emitter Coefficient, gpm/psi 0.5 Emitter Coefficient, L/s/m 0.5

2.5 150-180 11-14

Two 2.5 outlets 167-185 13-15

4.5 380-510 30-40

See page 453 of Advanced Water distribution Modeling and Management (Bentley) for additional background. Do not
specify both an emitter coefficient and a flow.

132
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Flushing Area Summary Table

The flushing area summary table is an alternative to the flushing operator's report. The table provides a complete
summary of the events. If you select a flushing study it will include the active events for the areas of that study. If you
select a single flushing area it will include only those events in that area.
The information contained in the flushing area summary table is identical to that of the flushing operator's report. The
only difference is that no plan views are included in the table.
The following columns are included in the flushing area summary table:
• Flushing Area: This is the label of the flushing area.
• Sequence: Starting at 1, the sequence increments for each event. The sequence resets to 1 for each subsequent
flushing area. Sequence 0 is reserved for boundary elements if defined for the flushing area.
• Type: There are several types that organize the information in a cleaner fashion:
• Boundary Element: If there are any boundary elements specified for the flushing area, these are listed first.
These actions should be taken before any actions for any individual event for the flushing area.
• Event: This row will show the label of the event along with some results for that event if results are available.
These results include Minimum Flushing Time, Recommended Flushing Time, Minimum Volume and
Recommended Volume. The "Pipe Run to be Cleaned" is also included on this row.
• Flushing Element: This is either the junction or hydrant being flushed for this event.
• Isolating Element: This is an element that should be closed or opened in order to fulfill the needs of the flushing
for this event.
• Final Action: These are actions that should be completed at the end of the final event. This normally includes
reopening valves that were initially closed or closing valves that were initially opened. Any boundary elements
that were initially closed are listed to be reopened here.
• Flushing Event: The label of the current event. Corresponds with the sequence. Final Actions do not show a
flushing event label.

Note: The first flushing event in the area will have no additional information in the table. For subsequent
events (Event 2+), the immediate previous *active* event will be looked at to determine if any additional
rows need to be added. The additional rows added will be read-only.
• Element ID: The ID of the element for the row. Events do not show an ID.
• Element: The element label. Events do not show a label.
• Element Type: The type of element corresponding to the Element ID and Element columns. This is left blank for
events.
• Operation: Determines what operation should be taken on the element.
• Flowing: This is the junction or hydrant to be flushed.
• Close: Close this element.
• Reclose: Previously opened but needs to be closed.
• Closed (prior): This element was closed previously. No further action required.
• Open: This element should be opened.
• Reopen: Reopen this element as it was previously closed.
• Predicted Flow, Predicted Pressure: Results on the flowing element only, if available. All other element shows a
blank.
• Minimum Flushing Time, Recommended Flushing Time, Minimum Volume, Recommended Volume: Results on
the event itself, if available. Shown only on the event row.

133
WaterGEMS CONNECT Edition Help
Modeling Capabilities

• Pipe Run to be Cleaned: Shows a comma delimited list of pipes that will be cleaned for this event. Shown only for
the event row.
• Comments: The notes for various elements. For the boundary element, comments will be from the boundary
elements table on the flushing area. Event will show event specific comments. Individual comments will be shown
from their respective rows in the flushing events table. Comments for final actions will be used from the individual
elements.
The information is presented in a simple tabular format. You can access the table from the report drop-down menu and
selecting "Flushing Area Summary Table". This option is available when you have either a flushing study or flushing
area selected.

In the dialog you have several ways of getting the information into Excel or another spreadsheet program. You can use
the Copy button. The copy drop-down provides copying to the clipboard with and without the headers. First menu item,
Copy, copies without headers. The second menu item, "Copy With Headers", copies to the clipboard with column
headers.
You can also export the data to a CSV file. This export will export as a comma delimited file. Any hard returns in
strings will be removed during export. Export will always include the headers.

Modeling Tips

134
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The paragraph presents some FAQs related to modeling water distribution networks with WaterGEMS CONNECT.
Also, please keep in mind that Bentley Systems offers workshops in North America and abroad throughout the year.
These workshops cover these modeling topics in depths and many more in a very effective manner. The following
modeling tips are presented:

Modeling a Hydropneumatic Tank

Hydropneumatic tanks can be modeled using a regular tank element and converting the tank pressures into equivalent
water surface elevations. Based on the elevation differences, the tank’s cross-sectional area can then be determined.
For example, consider a hydropneumatic tank that operates between 50 psig and 60 psig. The tank’s storage volume is
approximately 50 cubic feet.
The tank base elevation is chosen to be equal to the ground elevation, and the pressures are converted into feet of water
(1 psi = 2.31 feet). It is apparent that the tank operates between levels of 115.5 feet and 138.6 feet. The difference
between the levels is 23.1 feet, which brings us to a needed cross-section of 2.16 square feet.

Modeling a Pumped Groundwater Well

A groundwater well is modeled using a combination of a reservoir and a pump. Set the hydraulic grade line of the
reservoir at the static groundwater elevation. The hydraulic grade line can be entered on the reservoir tab of the
reservoir editor dialog box, or under the Reservoir Surface Elevation column heading in the Reservoir Report.
Pump curve data can be entered on the Pump Tab of the Pump Editor. The following example will demonstrate how to
adjust the manufacturer's pump curve to account for drawdown at higher pumping rates. Drawdown occurs when the
well is not able to recharge quickly enough to maintain the static groundwater elevation at high pumping rates.
Pump Curve Accounting for Drawdown:

The pump manufacturer provides the following data in a pump catalog:

Head (ft.) Discharge (gpm)

1260 0

1180 8300

1030 12400

Based on field conditions and test results, the following drawdown data is known:

Drawdown (ft.) Discharge (gpm)

40 8300

135
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Drawdown (ft.) Discharge (gpm)

72 12400

To account for the drawdown, the pump curves should be offset by the difference between the static and pumped
groundwater elevations. Subtract the drawdown amount from the pump head, and use these new values for your pump
curve head data.
The following adjusted pump curve data is based on the drawdown and the manufacturers pump data:

Head (ft.) Discharge (gpm)

1260 0

1140 8300

958 12400

Modeling Parallel Pipes

With some water distribution models, parallel pipes are not allowed. This forces you to create an equivalent pipe with
the same characteristics.
With this program, however, you can create parallel pipes by drawing the pipes with the same end nodes. To avoid
having pipes drawn exactly on top of one another, it is recommended that the pipes have at least one vertex, or bend,
inserted into them.

Pipe Bends

Modeling Pumps in Parallel and Series

Note: With pumps in series, it is actually more desirable to use a composite pump than to use multiple pumps in
the network. When pumps shut off, it is easier to control one pump. Several pumps in series can even cause
disconnections by checking if upstream grades are greater than the downstream grade plus the pump heads.

Parallel pumps can be modeled by inserting a pump on different pipes that have the same From and To Nodes. Pumps
in series (one pump discharges directly into another pump's intake) can be modeled by having the pumps located on the
same pipe. The following figure illustrates this concept:

136
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If the pumps are identical, the system may also be modeled as a single, composite pump that has a characteristic curve
equivalent to the two individual pumps. For pumps in parallel, the discharge is multiplied by the number of pumps, and
used against the same head value. Two pumps in series result in an effective pump with twice the head at the same
discharge.
For example, two pumps that can individually operate at 150 gpm at a head of 80 feet connected in parallel will have a
combined discharge of 2·150 = 300 gpm at 80 feet. The same two pumps in series would pump 150 gpm at 2·80 = 160
feet of head. This is illustrated as follows:

Modeling Hydraulically Close Tanks

If tanks are hydraulically close, as in the case of several tanks adjacent to each other, it is better to model these tanks as
one composite tank with the equivalent total surface area of the individual tanks.
This process can help to avoid fluctuation that may occur in cases where the tanks are modeled individually. This
fluctuation is caused by small differences in flow rates to or from the adjacent tanks, which offset the water surface
elevations enough over time to become a significant fluctuation. This results in inaccurate hydraulic grades.

Modeling Fire Hydrants

Fire Hydrant flow can be modeled by using a short, small diameter pipe with large minor loss, in accordance with the
hydrant’s manufacturer. Alternatively, hydrants can be modeled using Flow Emitters.

Modeling a Connection to an Existing Water Main

If you are unable to model an existing system back to the source, but would still like to model a connection to this
system, a reservoir and a pump with a three-point pump curve may be used instead. This is shown below:

137
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The reservoir simulates the supply of water from the system. The Elevation of the reservoir should be equal to the
elevation at the connection point.
The pump and the pump curve will simulate the pressure drops and the available flow from the existing water system.
The points for the pump curve are generated using a mathematical formula (given below), and data from a fire flow
test. The pipe should be smooth, short and wide. For example, a Roughness of 140, length of 1 foot, and diameter of 48
inches are appropriate numbers.
Please note that it is ALWAYS best to model the entire system back to the source. This method is only an
approximation, and may not represent the water system under all flow conditions.
Qr = Qf * [(Hr/Hf)^.54]
Where:
• Qr = Flow available at the desired fire flow residual pressure
• Qf = Flow during test
• Hr = Pressure drop to desired residual pressure (Static Pressure minus Chosen Design Pressure)
• Hf = Pressure drop during fire flow test (Static Pressure minus Residual Pressure)

Top Feed/Bottom Gravity Discharge Tank

A tank element in WaterGEMS CONNECT is modeled as a bottom feed tank. Some tanks, however, are fed from the
top, which is different hydraulically and should be modeled as such.

To model a top feed tank, start by placing a pressure sustaining valve (PSV) at the end of the tank inlet pipe. Set the
elevation of the PSV to the elevation of the inlet to the tank. The pressure setting of the PSV should be set to zero to
simulate the pressure at the outfall of the pipe.
Next, connect the downstream end of the PSV to the tank with a short, smooth, large diameter pipe. The pipe must have
these properties so that the headloss through it will be minimal.
The tank attributes can be entered normally using the actual diameter and water elevations.
The outlet of the tank can then proceed to the distribution system.

138
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Estimating Hydrant Discharge Using Flow Emitters

Another way to model the discharge from a hydrant is to use flow emitters. A flow emitter relates the discharge to
pressure immediately upstream of the emitter using:

The pressure exponent, n, is a variable that can be set in the Hydraulic Analysis Options section of the Calculation
Options dialog box. The default value is 0.5, which should be used when using flow emitters to model hydrant outlets.
You should be able to model a hydrant as a flow emitter and enter the appropriate value for K. Not all of the energy
available immediately upstream of the hydrant is lost, however. Instead, some of the energy is converted into increased
velocity head, especially for the smaller (2.5 in, 63 mm) hydrant outlet.
In order to accurately model a hydrant, the model must be given an overall K value, which includes head loss through a
hydrant and conversion of pressure head to velocity head. AWWA Standards C502 and C503 govern the allowable
pressure drop through a hydrant. For example, the standards state that the 2.5 in. outlet must have a pressure drop less
than 2.0 psi (1.46 m) when passing 500 gpm (31.5 l/s).
The energy equation can be written between a pressure gauge immediately upstream of the hydrant and the hydrant
outlet:

139
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The difference between K and k is that K includes the terms for conversion of velocity head to pressure head. k is
known, but K is the value needed for modeling.
A typical hydrant lateral in North America is 6 in. (150 mm) and typical outlet sizes are 2.5 in. (63 mm) and 4.5 in.
(115 mm). Values for k vary from minimum values, which can be back calculated from AWWA standards, to much
higher values actually delivered by hydrants. Values for K for a range of k values for 6 in. (150 mm) pipes are given
below.

The coefficients given are based on a 5 ft. (1.5 m) burial depth and a 5.5 in. (140 mm) hydrant barrel. A range of values
is given because each manufacturer has a different configuration for hydrant barrels and valving. The lowest value is
the minimum AWWA standard.

Modeling Variable Speed Pumps

Since WaterGEMS CONNECT, it is possible to model the behavior of variable speed pumps (VSP), whether they are
controlled by variable frequency drives, hydraulic couplings or some other variable speed drive. Workarounds that
were previously used, such as pumping through a pressure-reducing valve, are no longer needed.
The parameter that is used to adjust pump speeds is the relative speed. The relative speed is the ratio of the pump’s
actual speed to some reference speed. The reference speed generally used is the full speed of the motor. For example, if

140
WaterGEMS CONNECT Edition Help
Modeling Capabilities

the pump speed is 1558 rpm while the motor is a 1750-rpm motor, the relative speed is 0.89. This relative speed is used
with the pump affinity laws to adjust the pump head characteristic curve to model the pump.
If only a steady state run is being made and the pump relative speed is known, the speed of the variable speed pump can
be set in the General tab of the pump dialog box. However, if the conditions that control the pump are not known at the
start or an EPS run is being made, then variable speed behavior must be described in more detail.

Types of Variable Speed Pumps

The behavior of the VSP is set under the VSP tab within the pump dialog box. There are two ways to control a variable
speed pump. One is to provide a Pattern of pump relative speeds. This is best used for cases where you are trying to
model some past event where the pump speeds are known exactly or where the pump is not being controlled by some
target head. This would be the case where human operators set speed based on a combination of time of day, weather
and other factors.
The second type of control is Fixed Head control, where the pump speed is adjusted to maintain a head somewhere in
the system. For water distribution pumping into a pressure zone with no storage, this is usually some pressure sensor on
the downstream side of the pump. For wastewater pumping, the pump may be operated to maintain a constant wet well
level on the suction side (i.e., flow matching).
To indicate that a pump is behaving as a VSP, first check the box next to Variable Speed Pump? at the top of the VSP
tab. This will change the remaining boxes on the tab from gray to white.

Pattern Based
If you want to provide the actual pump relative speeds, Pattern Based should be selected from the VSP Type menu. The
default pattern is Fixed, which corresponds to constant speed performance at a speed from the General tab.
Usually, you will want to specify a series of pump relative speeds. To do this, click the Ellipsis (…) button next to
Pump Speed Pattern. This will open the Pattern Manager dialog box. Click the Add button, and the Pattern Editor
dialog box will appear. From this dialog box, you can assign a label (name) to the new Pattern and complete the series
of multipliers (i.e., relative speeds) versus time. Clicking OK twice will return you to the VSP tab.
A difficulty in using Pattern Based speeds is that the pattern that would work well for one scenario may not work well
for other scenarios. For example, tanks will run dry or fill and shut off for a slightly different scenario than the one for
which the pattern was created.

Target Head
Target head control is achieved by selecting Target Head from the VSP Type? menu. Once Target Head is selected, you
must describe how the control is implemented.
You must identify a node that controls the pump. This is the node where some type of pressure or water level sensor is
located. This can be done by
• Using the menu and picking the node from the list
• Clicking the Ellipsis (…) button and using the Select Element dialog box.
• Clicking the Select From Drawing button and picking the node from the drawing.
In selecting the control node, you must choose a node that is actually controlled by the VSP. For example, the selected
node must be in the same pressure zone (i.e., one that is not separated from the pump by another pump or PRV) and
should not have a tank directly between the node and the pump.

141
WaterGEMS CONNECT Edition Help
Modeling Capabilities

If the node selected for control is a tank, then as the Target Head the initial head in the tank and the target head type
with the corresponding target head or pressure value didn't show up in the property grid. Else you must select the target
head type (Pressure or Hydraulic Grade). Dependent on this selection either the pressure or the hydraulic grade to be
maintained at that node must be selected. The pressure or head must be a feasible head. If a physically infeasible
pressure or head is given, the problem may not be solved or some unrealistic flow may be forced to meet this head (e.g.,
backward flow through pump).
You also have the option of setting the maximum relative speed of the pump, which would usually correspond to the
rated speed of the motor. The default value for this is 1.0. You can have the model ignore this limit by placing a large
value in the field for maximum speed.

Note: If the suction head is greater than target head, then pump head will be reported as zero and the speed
value will not be meaningful.

Fixed Head
Fixed head control is achieved by selecting Fixed Head from the VSP Type? menu. Once Fixed Head is selected, you
must describe how the control is implemented.
You must identify a node that controls the pump. This is the node where some type of pressure or water level sensor is
located. This can be done by:
• Using the menu and picking the node from the list
• Clicking the Ellipsis (...) button and using the Select Element dialog box
• Clicking the Select From Drawing button and picking the node from the drawing
In selecting the control node, you must choose a node that is actually controlled by the VSP. For example, the selected
node must be in the same pressure zone (i.e., one that is not separated from the pump by another pump or PRV) and
should not have a tank directly between the node and the pump.
You must then select the head to be maintained at that node. If the node selected for control is a tank, then the Target
Head is set as the initial head in the tank. If a junction node is selected, the head must be a feasible head. If a physically
infeasible head is given, the problem may not be solved or some unrealistic flow may be forced to meet this head (e.g.,
backward flow through pump).
You also have the option of setting the maximum relative speed of the pump, which would usually correspond to the
rated speed of the motor. The default value for this is 1.0. You can have the model ignore this limit by placing a large
value in the field for maximum speed.

Note: If the suction head is greater than target head, then pump head will be reported as zero and the speed
value will not be meaningful.

Controls with Fixed Head Operation

Note: There should only be a single VSP serving a given pressure zone. If more than one VSP tries to use the
same node as a control node, then the model will issue an error message and not solve. If you try to use two
different nodes that are very close hydraulically, an error will also result.

When the relative pump speed reaches maximum speed (usually 1.0), the model treats the pump essentially as a
constant speed pump. In the case of pumps controlled by a junction node, when the conditions warrant, the pump will
once again behave as a VSP.

142
WaterGEMS CONNECT Edition Help
Modeling Capabilities

However, for pumps controlled by tanks, the pump will run at a maximum speed for the remainder of the EPS run, once
they reach maximum speed. To get the pump to switch back to variable speed operation, you need to insert a control
statement that switches the pump back to variable speed. Consider the example below:
PMP-1 tries to maintain 280 ft. discharge at node T-1 on the discharge side of the pump, but pump (PMP-1) switches to
full speed when the flow is so great that it cannot maintain 280 ft. In that case, the water level drops below 280 ft. As
demand decreases, the level increases until it reaches 280 ft., at which time variable speed operation begins again. To
make this occur in the model, you must use a logical control to restore variable speed operation:
IF (HGL T-1 >= 280 ft) THEN (PMP-1 = ON)

Parallel VSPs
Variable speed pumps (VSPs) can be run in parallel. This allows you to model multiple VSPs operated at the same
speed at one pump station. To model this, one VSP is chosen as a "lead VSP", which will be the primary pump to
deliver the target head. If the lead VSP cannot deliver the target head while operating at maximum speed, then the
second VSP will be triggered on and the VSP calculation will determine the common speed for both VSPs. If the target
head cannot be delivered while operating both VSPs at the maximum speed, then another VSP will be triggered on until
the target head is met with all the available VSPs.
All VSPs that are turned on are operated at the same speed. VSPs are to be turned off if they are not required due to a
change in demand. If all standby VSPs are running at the maximum speed but still cannot deliver the target head, the
VSPs are translated into fixed speed pumps.
The number of available parallel VSPs at a certain time step may vary depending on the status (either initially or set by
a control) of the VSPs and their discharge/suction pipes. For example an initially closed VSP cannot not be used until
the VSP is turned on by a control. In addition, when a lag pump is turned on by a control, this doesn't necessary mean
that the lag pump will run. It will only run if needed. An initially closed suction/discharge pipe also prevents the related
VSP from turning on.
The main difference between a VSPB and a group of parallel VSPs is the possibility to control the number of available
parallel VSPs over time using controls. It's possible to limit the usage of a specified pump for a certain time range or a
tank level.
To correctly apply the VSP feature to multiple variable speed pumps in parallel, the following criteria must be met:
1. Parallel VSPs must be controlled by the same target node;
2. Parallel VSPs must be controlled by the same target head;
3. Parallel VSPs must have the same maximum relative speed factors;
4. Parallel VSPs must be identical, namely the same pump curve;
5. Parallel VSPs must share common upstream and downstream junctions within 3 nodes (inclusive) of the pumps in
order for them to be recognized as parallel VSPs.
6. All upstream pipes should have the same diameter, roughness, length and minor loss coefficient, the same for all
downstream pipes within the parallel VSP group. As opposed to the first five criteria a difference in these attribute
values will not stop the calculation run. Only a warning user notification is generated for each attribute with at least
one deviation. Note that the results within the suction and the discharge junction of the parallel VSP group will not
be completely correct in this case.

Note: If there are more than 3 nodes between the pumps and their common node, upstream and downstream,
the software will treat them as separate VSPs. Since separate VSPs cannot target the same control node, this will
result in an error message.

Below is a list of user notification messages related to parallel VSPs with an explanation how to correct the incorrect
model data:

143
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Parallel VSPs are not allowed to be controlled by Correct the control node to match the control node of the
different nodes. parallel lead pump.

Parallel VSPs are not allowed to have different maximum Correct the maximum speed factor to match the
pump speed factors. maximum speed factor of the parallel lead pump.

Parallel VSPs are not allowed to have different pump Correct the pump type to match the pump type of the
curves. parallel lead pump.

Parallel VSPs are not allowed to have different target Correct the target head to match the target head of the
heads. parallel lead pump.

Parallel variable speed pumps cannot be connected to Remove suction pipe(s) of the VSP until only one suction
common node by more than one pipe on the suction side. pipe remains.

All discharge or suction pipes in parallel VSP group Correct pipe diameter to match the diameter of the other
should have the same diameter. suction or discharge pipes within the VSP group.

All discharge or suction pipes in parallel VSP group Correct pipe length to match the length of the other
should have the same length. suction or discharge pipes within the VSP group.

All discharge or suction pipes in parallel VSP group Correct pipe minor loss coefficient to match the minor
should have the same minor loss coefficient. loss coefficient of the other suction or discharge pipes
within the VSP group.

All discharge or suction pipes in parallel VSP group Correct pipe roughness to match the pipe roughness of the
should have the same roughness. other suction or discharge pipes within the VSP group.

Headlosses for all pump pipework are based on the Run a validation to find out for which pipes the hydraulic
physical characteristics of the lead pump pipework. At attributes didn't match.
least one discharge or suction pipe in a parallel VSP
group has different pipe attributes. Run a full validation
for more information.

VSP Controlled by Discharge Side Tank

The improvement allows users to choose a tank at the downstream side of a pump as the control target. Once a user
selects a tank as the control node for a VSP, the control target head is set to the initial tank head by default. The VSP
algorithm will calculate the required relative pump speed to maintain the tank level. If the tank level drops below the
target level, the VSP will be forced to increase the speed, up to the maximum allowable speed as specified, to meet the
target tank level. If the tank level is greater than the target level, the VSP speed will be reduced or shut off to permit the
tank supply system demand and thus the tank level can be gradually lowered to the target level.
To set up a discharge side tank as the VSP control node:
1. Click on a VSP or VPSB.
2. In the Properties editor, set the attribute Is Variable Speed pump? to True.
3. Set VSP Type as Fixed Head.
4. Choose a desired discharge side tank as Control Node.
5. Specify the maximum relative speed factor and set Is Suction Side Variable Speed Pump to False.

144
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Note: When the target level is missed due to either too high demand or too much inflow into the wet well, the
VSP will be operating at the fixed speed until the target level can be reestablished, however, the reestablished
target level may not be exactly the same as the initial target head. This is because the VSP is forced back by using
the given time step, the pump is operated as a fixed speed pump to move the amount of water within one time
step, so that the level cannot be exact unless the time step is small enough to ensure the exact amount of water
is moved out the tank to maintain the exact target. The smaller the time step, the closer it will be to returning to
the target.

VSP Controlled by Suction Side Tank

Similar to the function of a VSP controlled by a discharge side tank, a vsp can also be controlled by a tank at the
upstream of pump, that is the suction side of a pump. This is the typical use case for a sewer forcemain sub-system,
where a wet well (essentially a tank) is usually located at the suction side of a pump. In this case, the control target is to
maintain a fixed water level at the wet well. When a VSP is installed at the downstream side of a wet well to pump the
flow out of the well and also to maintain a fixed wet well water level, WaterGEMS CONNECT can be used to model
the control scenario.
Unlike the vsp controlled by discharge side tank, when the wet well level is below the target level, suction side
controlled vsp will slow down in speed to allow the water level to increase to the target level. When the wet well water
level is above the target level, a vsp will speed up to move the flow out of well in order to reduce the water level at the
wet well.
The workflow is the same as the VSP controlled by a discharge side tank, except that the user needs to set the attribute
of Is Suction Side Variable Speed Pump to True in the property grid.

Note: When the target level is missed due to either too high demand or too much inflow into the wet well, the
VSP will be operating at the fixed speed until the target level can be reestablished, however, the reestablished
target level may not be exactly the same as the initial target head. This is because the VSP is forced back by using
the given time step, the pump is operated as a fixed speed pump to move the amount of water within one time
step, so that the level cannot be exact unless the time step is small enough to ensure the exact amount of water
is moved out the tank to maintain the exact target. The smaller the time step, the closer it will be to returning to
the target.

Fixed Flow VSP

Fixed flow VSP enables the user to model a pump that is controlled to deliver a desired amount of flow. This can be a
typical control case when a pump is supplying water to an "open" system where a tank is located in the downstream
distribution system. It is unlikely that a pump is expected to supply the fixed flow to a "closed" system where no tank is
located at the downstream of a pump.
WaterGEMS CONNECT facilitates the fixed flow VSP modeling. It automatically calculates the required pump speed,
up to the maximum relative speed factor, to move the required flow through a pump. Multiple vsps can be in parallel
and expected to deliver different target flows. To apply this feature, follow the steps below:
1. Click on a VSP.
2. Set the attribute Is Variable Speed pump? to True.
3. Set VSP Type as Fixed Flow.
4. Specify the maximum relative speed factor.
5. Specify the Target Flow for the vsp.
In the case of a VSPB, the target flow will be evenly divided among all the lead and lag VSPs.

145
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Note: In some cases, you may encounter a high-frequency oscillation effect when a tank is used as the control
node. If this occurs, it is suggested that you use a node near the tank as the control node, rather than the tank
itself.

Resolving ‘Unbalanced Network’ Errors

For complex systems (e.g. with many pipes and a lot of controls) it can take more than the standard 40 iterations to
converge on a good solution. In cases like this, sometimes increasing the number of Trials in the Calculation Options
will allow the model to converge to a good solution. However we often find that models that give the ‘unbalanced
network’ error have data entry errors (high friction coefficient, etc.) so it is always a good idea to check your data input
carefully."

Pipe Renewal Planner

Pipe Renewal Planner provides the user with a tool to calculate a weighted score for each pipe based on whatever
aspects the user chooses. Scoring pipes is highly system specific depending on the issues in that system and the
availability of data. Pipe Renewal Planner can include any aspect that can be entered for a pipe or calculated for the
pipe.
Scores that can be calculated for a pipe include:
1. Capacity
2. Criticality
3. Projected pipe breaks
Scores that can be based on properties include standard WaterGEMS CONNECT properties such as:
1. Year installed
2. Material
3. Zone
Or Use Data Extensions such as:
1. Type of surface activity
2. Depth of cover
3. Relation to water quality complaints
Each of the properties used above (e.g. capacity, material, and cover) is referred to as an aspect. The first set of aspects
are calculated in special routines and are referred to as "Predefined Aspects" since there are WaterGEMS CONNECT
analyses that are used to determine the scores. See the Help for each of those individual aspects.
The overall process for determining the "Pipe Score", which is the final result of this analysis, is:
1. Build model with sufficient information to calculate aspect of interest
2. Optionally run capacity, criticality and pipe break analysis
3. Start Pipe Renewal Planner by selecting Analysis >Pipe Renewal Planner or picking the Pipe Renewal
Planner button.
4. Pick the New button to create a new Pipe Renewal analysis
5. Select aspects to be used and weights for each
6. Set up scoring to convert raw score/property values into individual aspect scores
7. Compute Pipe Renewal Pipe Scores

146
WaterGEMS CONNECT Edition Help
Modeling Capabilities

8. Review results
Each of these steps is described in more detail below.
Pipe Renewal Planner - methods used
The result of the Pipe Renewal Planner analysis is a pipe score for each pipe. This is calculated for the j-th pipe using

Score (j) = wiRij

Where wi is the weight for the i-th aspect and Rij is the score for the j-th pipe for the i-th aspect.
The intent is that the individual scores (R values) are on a scale of 0 to 100 (100 being the worst). The w's should add
up to 1 so that the overall score will also be on a 0 to 100 scale.
The scores for the individual aspects are determined on a continuous or a stepwise scale as appropriate for that type of
aspect.

Aspects such as pipe break and criticality use the continuous function while user defined properties such as year
installed and material use the stepwise function. The horizontal axis is described by some raw values such as pipe break
rate in breaks/year/mile or maximum velocity (ft/sec) in pipe during fires or year installed.
Pipe Break: For the pipe break aspect, the user should run the Pipe Break Analysis to calculate the projected break rate
for each pipe. The individual pipe break score is calculated as:

Where breakj = break rate in j-th pipe, and breakmax = maximum break rate in all pipes.
Criticality: The criticality score is based on the shortfall in meeting demand as calculated by the WaterGEMS
CONNECT criticality analysis. Criticality may be based on taking an individual pipe element out of service or more
accurately in taking a distribution segment out of the system (see criticality help for more discussion on this as well as
details of calculating criticality below). The score for criticality is:

147
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Where criticality is the shortfall due to an outage of the j-th pipe and criticalitymax is the greatest shortfall from any
pipe.
Capacity (fire flow): Assigning fire flow scores to a pipe is somewhat more difficult in that fire flows are node, not
pipe, properties. The goal is to identify which pipes serve as bottlenecks in the system. These are pipes which have high
velocity or head loss gradient when a downstream node fails the meet needed fire flow. The determination of a
shortcoming in capacity is defined as the maximum difference between the target velocity and actual velocity for the
worst fire flow event for each pipe. The user defines a velocity that would make a pipe a candidate for being a
bottleneck (say 5 ft/s).
For each pipe, the raw score is defined as:
rj=max[v-vt]
Where v = velocity, ft/s, vt = target velocity, ft/s
The target value used is taken as the velocity specified in the "Use Pipe Velocity Greater Than" field of the auxiliary
output section of the fire flow alternative.
The scaled score for pipe j would be:

Where rmax is the amount the velocity exceeds the target at the pipe with the highest velocity.
The calculations are similar for hydraulic gradient except that there is no target value (i.e. zero).
It may be necessary to eliminate small pipes (e.g. 2 in. pipes) from this calculation since they are not expected to carry
fire flow. It may also be necessary to eliminate nodes from the fire flow analysis in areas where fire flows are not to be
provided. Selecting the target velocity also involves some judgment in that too low of a value will point out some pipes
that normally have a high velocity as being bottlenecks and too high of a will mean that virtually no pipes will have a
non-zero value for Rij.
It is usually preferable to base capacity score on headloss gradient as it is sensitive to pipe roughness while velocity is
not. Using hydraulic gradient produces a higher score for rougher pipes which is desirable.
Discrete aspect: In the case of aspects whose score is based on some pipe property, the user selects some function and
manually enters the function using a table such as shown below:

Using the Pipe Renewal Planner

Before using Pipe Renewal Planner, the user needs to identify which aspects will be used in scoring pipes and which
properties are going to be used as a basis for calculating the aspect scores.

148
WaterGEMS CONNECT Edition Help
Modeling Capabilities

(It may be necessary to define new properties in User Data Extensions and import values for properties from external
data sources using ModelBuilder or copy/paste features. In order to import values, it is essential that there exist a
common key field shared by the WaterGEMS CONNECT model and the external data source.)
Calculation of raw scores for aspects such as capacity (fire flow) and criticality (shortfall) can be time consuming such
that it may be advisable to have already run these analyses before starting the Pipe Renewal Planner and noting which
scenario was used. However, if any properties are changed that may affect scores, it may be necessary to rerun the
scenario from within Pipe Renewal Planner.
The user can start Pipe Renewal Planner by selecting Analysis > Pipe Renewal Planner or picking the Pipe Renewal
Planner button. This opens the welcome dialog if no analyses have already been run.

Select the New button on top of the left pane to create a new analysis. It opens with the following default values:

The user can rename the analysis by selecting the third button over the left pane.
The user should select the Representative Scenario which need not necessarily be the current scenario. This scenario
will be used as the source of property values and the location to save results except for those places where another
scenario is explicitly called out.
General Tab: In the General tab in the right pane the user can create new aspects or delete aspects using the buttons on
top of the dialog.
The Use button determines which aspects are to be included in the pipe score calculation as indicated by the check.
Under the Aspect column, the user can define new aspects. The default Aspects - Pipe Break, Criticality and Capacity
(Fire Flow) -- are automatically included in the list although they can be deleted. To create a new Aspect, click inside a
blank cell in the Aspect column and select the ellipse (...) button. This will open the dialog below where the scoring for
the new aspect can be defined by first selecting the New button, then naming the Aspect.

149
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The user then picks which field is to be used as the basis for this Aspect, initializes the values and sets the scores. If the
property is a numerical value, then the value in the Value column is the upper limit of the range (above) while if the
property is text, the list of possible text values is displayed (below).
The Selection Set column determines whether the Pipe Renewal Planner will be run for the entire network (default) or
some previously defined selection set of pipes.
The Weight column is the place where the user defines the weights assigned to each aspect. Ideally, the weights should
add up to 1 but the user may use some other weighting system.
The Compute Scenario box when checked means that WaterGEMS CONNECT will recalculate the indicated scenario
when it calculates the Pipe Score. If unchecked, the Pipe Renewal Planner will use the most recent results from that
scenario.
The Scenario column indicates which scenario is to be used to calculate the raw score for that Aspect. It is important
that the user pick the correct type of scenario. For example, if the Aspect is criticality, the scenario selected should be
one containing the results of a criticality run.
Predefined Aspects Tab: The Predefined Aspects Options tab gives the user additional control over the handling of the
three predefined aspects - Pipe breaks, Criticality and Capacity. In each of those sub-tabs, the user can decide whether
to calculate the score on a continuous scale (default) or set up some stepwise function to convert the raw score into a
scaled score to the overall pipe score. The user indicates this by selecting:
Use continuous scale
Or
Use Stepwise scale
If the user selects the continuous scale, then no additional information is necessary. If the user selects the stepwise
scale, then he must define the scale as done for other aspects.

150
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The criticality and capacity score provide the user with additional capability to specify some additional options.
In calculating the criticality score, the shortfall may be calculated based on distribution segments rather than pipe
elements. (Segments are the minimum portion of the system that can be isolated by valving. See help topic on
segments.) There is not a one-to-one association between segments and pipes. A pipe may be made up of several
segments depending on valving. The user has the ability to control how the segment shortfall is transformed into pipe
shortfall. In the figure below, there are two segments than overlap pipe 102-a short one and a long one.

The user has three ways to handle multiple segments:

1. Use the average shortfall weighted by the length of each segment (default)
2. Ignore small segments below a certain size (called minimum stub length)
3. Use the shortfall corresponding to the worst segment in the pipe
For the example above, suppose pipe 102 is 200 ft long and 195 ft are in Segment B (criticality = 10) while the
remaining 5 ft are in segment A (criticality = 60). The corresponding scores would be:
1. (195/200)10 + (5/200)60 = 11.25
2. 10 (if minimum stub length is greater than 5 ft)
3. 60
, depending on the user's choice.

151
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The capacity score as described in the "Pipe Renewal Planner - methods used" topic, is based on the maximum extent
that the velocity exceeds the target velocity in a fire flow analysis. Because some pipes are small and not intended for
fire flow, those pipes can be excluded from the analysis using the minimum diameter value (default = 2 in). Pipes that
small or smaller will not have a capacity score calculated for them.

The velocity used in the calculate is the velocity that will occur when the residual pressure meets the required residual.
For pipes with large capacity, this value will be much greater than the needed fire flow. If the user wants the velocity to
simply meet the needed fire flow, then the "Fire Flow (Upper Limit)" parameter in the fire flow alternative should be
set to a value just slightly above the needed fire flow.
Results Tab
To run the pipe scoring calculation, the user would pick the green compute button on the top of the left pane. To simply
validate that the calculation is runable, pick the small drop down arrow next to the compute button and pick Validate.
Once the run is complete, a summary results table is displayed with the following columns:
• Pipe ID and Label
• Pipe Score - The overall pipe score which is a weighted sum of the individual aspect scores. A higher value
indicates a pipe with potential problems in need of repair, rehabilitation, replacement or some other remedial action.
Scores are generally presented on a 0 to 100 scale unless the user has set up some different scaling. This is followed
by summaries for each of the aspects used:
• Raw score pipe break (breaks/yr/mi) -The result for the pipe break analysis.
• Score Pipe Break - The score for the pipe break aspect on a 0-100 scale.
• Score Criticality - The score for criticality on a 0 to 100 scale.
• Raw score criticality - The percent shortfall for that pipe being taken out of service as calculated in the associated
criticality scenario.
• Score Capacity - The score for capacity on a 0 to 100 scale.

152
WaterGEMS CONNECT Edition Help
Modeling Capabilities

The next several columns contain a pair of columns for each user created aspect if there are any. The first column is
the raw score for the property while the second is the score on a 0 to100 scale.
• The final columns contain the diameter, length, material and installation year for each pipe.

Hydraulic Risk
Instead of considering pipe breaks and criticality as separate aspects in an additive manner, some users prefer to
consider the product of likelihood (pipe break) and consequences (criticality) as a single aspect called risk. This can be
done by including Hydraulic Risk as an aspect either in addition to or in place of the pipe break and consequences
aspects as long as the weighting adds to one.
The pipe risk score is calculated as
Hydraulic Risk Score = Pipe Break Score x Criticality Score/100
Hydraulic risk is handled like any other aspect except that it doesn't have a scenario associated with it as the scenarios
are associated with the pipe break and criticality scores.

Aspects Dialog Box

The Aspects dialog box allows you to identify which aspects will be used in scoring pipes and which properties are
going to be used as a basis for calculating the aspect scores.

For each Aspect you create, select which field is to be used as the basis for the Aspect, initialize the values and set the
scores. If the property is a numerical value, then the value in the Value column is the upper limit of the range (above)
while if the property is text, the list of possible text values is displayed (below).

Pipe Break Analysis

153
WaterGEMS CONNECT Edition Help
Modeling Capabilities

655
WaterGEMS CONNECT Edition Help
Modeling Capabilities

656
WaterGEMS CONNECT Edition Help
Modeling Capabilities

657
WaterGEMS CONNECT Edition Help
Modeling Capabilities

658
WaterGEMS CONNECT Edition Help
Modeling Capabilities

659
WaterGEMS CONNECT Edition Help
Modeling Capabilities

660
WaterGEMS CONNECT Edition Help
Modeling Capabilities

661
WaterGEMS CONNECT Edition Help
Modeling Capabilities

Pipe Break Group Dialog Box

The Pipe Break Group dialog allows you to add pipes to a pipe break group by either:
1. Picking a previously created selection set using the selection set button.
2. Picking pipes individually from the drawing using the select from drawing button.
The assumption is that pipes in a group have similar properties with respect to pipe breakage. These properties would
include similar age, material, laying condition and loading and period of break records. It is usually best to create
selection sets of such pipes before starting the pipe break analysis. Name the group with a label that reflects the pipes in
the group. If a pipe is not assigned to a group, its individual break rate will be used as the scaled break rate.
The dialog consists of a list pane on the left that displays all of the pipe breaks that have been created for the current
hydraulic model and the detail pane on the right that displays the pipes that are included in the group that is currently
highlighted in the list pane, along with the following controls:
• New: Creates a new pipe break group.
• Delete: Deletes the currently highlighted pipe break group.
• Rename: Renames the currently highlighted pipe break group.
• Add Pipes From Selection Set: Allows you to add pipes to a group using a previously created selection set.
• Add Pipes From Drawing: Allows you to add pipes to a group by picking them in the drawing view.

Pick A Selection Set Dialog Box

This dialog allows you to choose a predefined selection set. Select the desired selection set from the list and click OK.

Pipe Break - Leak Size

The following table provides pipe break leak size guidance:

Flow Emitter at 40m/40psi

L/s gpm L/s/sqrt (m) gpm/sqrt (psi)

Leaky Faucet 0.1 1.5 0.015 0.25

Garden Hose 1 15 0.15 2.5

Gutter During Heavy 10 150 1.5 25

Rain

Flowing Hydrant 100 1500 15 250

Small Stream 1000 15000 150 2500

662
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Note: To prevent negative demands, use the emitter coefficient or use Pressure Dependent Demands.

Calibrating Your Model with Darwin Calibrator

Note: Calibrator (as well as Designer and Skelebrator) are components that initialize their data when first used,
so one needs to at least open the component for those database fields to be created in the current model.
As an example, if you are trying to use ModelBuilder to import calibration data but have never opened Calibrator
in this particular model, you will not see the "Field Data Snapshot" model type in the dropdown list for Table
Type. This is because that database type and its associated fields haven't been initialized yet. You would click on
Analysis > Darwin Calibrator first in the main menu. Once this is done, the Field Data Snapshot and other
Calibrator related fields are created, and those options will then appear in the ModelBuilder dialogs.

The Bentley WaterGEMS CONNECT Darwin Calibrator provides a history of your calibration attempts, allows you to
use a manual approach to calibration, supports multiple field data sets, brings the speed and efficiency of genetic
algorithms to calibrating your water system, and presents several calibration candidates for you to consider, rather than
just one solution. You can set up a series of Base Calibrations, which can have numerous Child Calibrations that inherit
settings from their parent Base Calibrations.
Use Base and Child Calibrations to establish a history of your calibration trials to help you derive a list of optimized
solutions for your water system. Inheritance is not persistent. If you change the Base Calibration, the change does not
ripple down to the Child Calibrations.

You can adjust your model to better match the actual behavior of your water distribution system by using the Darwin
Calibrator feature. It allows you to make manual adjustments on the model as well as adjustments using genetic
algorithm optimization.
The left pane of the Darwin Calibrator dialog box displays a list of each calibration study in the current hydraulic
model, along with the manual and optimized runs and calculated solutions that make up each study.
The following controls can be found above the list pane:

663
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

New Clicking the New button opens a submenu containing the

following commands:
• New Calibration Study - Creates a new calibration
study.
• New Optimized Run - Creates a new optimized run.
Use this command if you want WaterGEMS to
efficiently process and evaluate numerous trial
calibrations of your water system. You can set the
optimized calibration to deliver several solutions for
you to review.
• New Manual Run - Creates a new manual run. Use
this command if you want to test fitness by adjusting
roughness, demand, or status manually. If you have
specific solutions in mind, Manual Calibration might
let you quickly narrow-down or refine the number and
measure of adjustments before you use the genetic
algorithm.

Delete Deletes the calibration study, manual run, or optimized

run that is currently highlighted in the list pane. Deleting
a study will also delete all runs that are a part of that
study. Deleting a run will also delete any child runs based
on it.

Rename Renames the calibration study, manual run, or optimized

run that is currently highlighted in the list pane.

Compute Opens a submenu containing the following commands:

• Compute: Computes the optimized or manual run that
is currently highlighted in the list pane.
• Hierarchy: Computes the highlighted optimized or
manual run as well all the optimized or manual runs
branching from it hierarchically.
• Children: Computes the highlighted optimized or
manual run as well as all the calibration runs derived
from it.
• Batch Run: Opens the Batch Run Dialog, allowing
you to select multiple runs to compute together.

Export to Scenario Opens the Export to Scenario dialog box, allowing you to
export the solution that is currently highlighted in the list
pane to a new or existing scenario, alternative, and/or set
of alternatives.

Report Opens the Report Viewer, which displays a detailed

report of the solution that is currently highlighted in the
list pane.

664
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Graph Opens the Correlation Graph dialog box, which displays a

graph of the solution that is currently highlighted in the
list pane.

Help Opens the online help.

The right side of the dialog contains controls that are used to define settings and input data for Calibration Studies and
their component Manual and Optimized Runs. The controls available on the right side of the dialog box will change
depending on what is highlighted in the list pane:
Calibration Studies (on page 7)
Optimized Runs (on page 7)
Manual Runs (on page 7)
Calibration Solutions (on page 7)

Calibration Studies

A Calibration Study is the starting point for all calibration operations. A Calibration study consists of the following
components:
• Roughness Groups
• Demand Groups
• Status Elements
• Notes (Optional).

Field Data Snapshots Tab

The Field Data Snapshots tab allows you to input observed field data for the calibration study that is currently
highlighted in the list pane.
The following controls, located above the Field Data Snapshots list pane, allow you to manage your field data
snapshots:
• New: Creates a new field data snapshot.
• Duplicate: Duplicates the currently highlighted field data snapshot.
• Delete: Deletes the currently highlighted field data snapshot.
• Renames the currently highlighted field data snapshot.
After a field data snapshot has been created, highlighting it in the list pane allows you to define or modify the following
data:
Representative Scenario
Choose the scenario that will be used as the base data for the calibration study.
Snapshot Data
Enter the following Snapshot data:
• Label: Enter a label for the field data snapshot.
• Date: Set the date of the observations and field tests.

665
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

• Time: Set the time of the observations and field tests. When using the pull down menu to select a time using the up
and down arrows, hit the Enter key when you have selected the time you want to accept the change.
• Time from Start: Displays the time difference from the time you set for the field data set to the time defined as the
start of the scenario.
• Override Scenario Demand Alternative?: Check this box to override the displayed Demand Alternative and use a
different demand alternative or to use the specified Demand Multiplier. Clear this check box if you want to use the
displayed alternative or if you do not want to use the Demand Multiplier.
• Demand Alternative: Displays the Demand Alternative associated with the selected set of observations. If
the Override Scenario Demand Alternative? box is checked, you can choose a different demand alternative
here.
• Demand Multiplier: Set a demand multiplier that is applied to your water model. For example, if you have
knowledge that your demand is higher or lower by a specific percentage, you can set that value here. If the
multiplier is set to zero, the demand will also be zero. By default this value is set to 1.
• Notes: Use the Notes field to enter any comments you want saved with the field data snapshot.

Note: Field data set time is important since Calibrator uses the specified time to determine nodal demands from
the represenative scenario by applying pattern multipliers for the specified times. To that end be sure to specify
the time that corresponds to the time the field data was acquired.

Observed Target
The Observed Target tab allows you to input calibration target values (node pressure and hydraulic grade line, as well
as pipe flows) that the calibration operations will be attempting to match. Each row in the table represents a single
target observation. The following controls are available in this tab:
• New: Creates a new target observation for the Field Data Snapshot that is currently highlighted in the list.
• Duplicate: Makes a copy of the currently highlighted target observation for the Field Data Snapshot that is currently
highlighted in the list.
• Delete: Deletes the currently highlighted target observation.
• initialize Table from Selection Set: Opens the Initialize From Selection set dialog, allowing you to choose a
selection set. After a selection set is specified, this command generates a target observation for each element in the
selection set.
• Select From Drawing: Opens the Select dialog box, allowing you to select elements in the drawing view.
For each target observation, the table contains the following columns:
• Field Data Set: Displays the field data set to which the target observation belongs.
• Element: Select the element for which you want to enter observed data.
• Attribute: Select the attribute for which you have observed data. Different attributes are available for each element
type.
• Value: Select a value from the drop-down list or enter in a value for the selected attribute.
Boundary Overrides
Observed boundary conditions such as tank level, pump status and speed and valve settings are entered in the Boundary
Overrides tab. Each row in the table represents a single boundary override. The following controls are available in this
tab:
• New: Creates a new boundary override for the Field Data Snapshot that is currently highlighted in the list.
• Duplicate: Makes a copy of the currently highlighted boundary override for the Field Data Snapshot that is currently
highlighted in the list.
• Delete: Deletes the currently highlighted boundary override.

666
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

• Initialize Table from Selection Set: Opens the Initialize From Selection set dialog box, allowing you to choose a
selection set. After a selection set is specified, this command generates a boundary override for each applicable
element in the selection set.
• Select From Drawing: Opens the Select dialog box, allowing you to select elements in the drawing view.
For each boundary observation, the table contains the following columns:
• Field Data Set: Displays the field data set to which the boundary override belongs.
• Element: Select the element for which you want to enter a boundary override.
• Attribute: Select the attribute for which you have a boundary override. Different attributes are available for each
element.
• Value: Select a value from the drop-down list or type in a value for the selected attribute.
Demand Adjustments
Use the Demand Adjustments tab to adjust demand for individual elements, such as flow from a hydrant. Additional
demands (e.g., fire flow tests) are in addition to, not in lieu of, demands already calculated from pattern multipliers.
Each row in the table represents a single demand adjustment. The following controls are available in this tab:
• New: Creates a new demand adjustment for the Field Data Snapshot that is currently highlighted in the list.
• Duplicate: Makes a copy of the currently highlighted demand adjustment for the Field Data Snapshot that is
currently highlighted in the list.
• Delete: Deletes the currently highlighted demand adjustment.
• Initialize Table from Selection Set: Opens the Initialize From Selection set dialog, allowing you to choose a
selection set. After a selection set is specified, this command generates a demand adjustment for each applicable
element in the selection set.
• Select from Drawing: Opens the Select dialog, allowing you to select elements in the drawing view.
For each demand adjustment, the table contains the following columns:
• Field Data Set: Displays the field data set to which the demand adjustment belongs.
• Element: Select the element for which you want to enter a demand adjustment.
• Additional Demand: Type in a value for the demand adjustment.

Adjustment Groups
Adjustment groups are groups of elements whose attributes are adjusted together during the calibration process. You
must be careful to group similar elements and not dissimilar ones. You can adjust the properties for a group as a whole
but not for individual members of the group.
There are three kinds of adjustment groups, each of which are created and modified in their respective calibration study
settings tab:
• Roughness Groups - Add, edit, delete, or rename Roughness adjustment groups in the Roughness tab. Each
roughness group should comprise elements that have similar attributes, such as pipes in a location of a similar
material and age. Adjustments made to a group are applied to every element in the group. Click the Export Groups
button to export the Calibration Group ID data to an automatically created user defined attribute. All elements
within a calibration group will have an identical Calibration Group ID. This allows you to color code by calibration
roughness group.
• Demand Groups - Add, edit, delete, or rename Demand adjustment groups in the Demand tab. Adding Demand
Calibration adjustment groups introduces more unknowns into a calibration problem. If available, you should enter
more accurate demand data into your Bentley WaterGEMS model, rather than adding Demand Adjustment Groups.
Consider creating Demand Groups based on usage patterns. Click the Export Groups button to export the

667
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Calibration Group ID data to an automatically created user defined attribute. All elements within a calibration group
will have an identical Calibration Group ID. This allows you to color code by calibration demand group. You can
automatically create demand groups from selection sets using the Group Generator. To open the Group Generator
click the Create Multiple Design Groups button.
• Status Elements - Add, edit, delete, or rename Status Element adjustment groups in the Status Elements tab. Status
indicates whether a pipe is open or closed. GA-optimized calibration will identify the status of each pipe within the
status group so that the chosen objective function is minimized. Status groups are generally used when a particular
area of the system is believed to contain a closed pipe or valve. We recommend that Status Groups comprise, at
most only a few pipes, or one pipe. Click the Export Groups button to export the Calibration Group ID data to an
automatically created user defined attribute. All elements within a calibration group will have an identical
Calibration Group ID. This allows you to color code by calibration status group.
Each adjustment group tab consists of a table that lists the adjustment groups, a New button to add groups to the table,
and a Delete button to remove the currently selected group from the table. The table consists of the following columns:
• ID: The automatically assigned ID of the adjustment group.
• Label: The user-defined name of the adjustment group. To change the label, click on it and type a new name.
• Element IDs: The elements that are contained within the adjustment group. Clicking the ellipsis button in this field
will open the Selection Set dialog, which allows you to add and remove elements by selecting them in the drawing
view.
• Notes: Use the Notes field to enter any comments you want saved with the adjustment group.

Note: Decide on your Adjustment Groups first and then collect the Field Data to support the number or groups,
rather than letting available data determine how many Adjustment Groups you have.

Group Generator Dialog Box

The Group Generator allows you to automatically create multiple design groups based on existing selection sets, or by
selecting a group of elements from the drawing.

668
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

The dialog consists of a list of elements that will be used to create demand groups (one element per group) and a menu
that allows you to select the elements that are included in the list. The menu contains a list of all existing selection sets.
Click the elipsis button to select elements from the drawing directly. When the list contains all of the elements that you
want to be included in demand groups, click OK.

Calibration Criteria
Use the Calibration Criteria tab to set up how the calibrations are evaluated.

The options you specify are applied to every calibration trial in the Calibration Study. The Calibration Criteria tab
contains the following controls:

669
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

• Fitness Type - Select the Fitness Type you want to use from the drop down list. In general, regardless of the fitness
type you select, a lower fitness indicates better calibration. Fitness Types include: Minimize Difference Squares,
Minimize Difference Absolute Values, and Minimize Maximum Difference. For more information, see Calibration
Criteria Formulae (on page 7).
• Minimize Difference Squares - Uses a calibration designed to minimize the sum of squares of the discrepancy
between the observed data and the model simulated values. (Model simulated values include hydraulic grades
and pipe discharges.) This calibration favors solutions that minimize the overall sum of the squares of
discrepancies between observed and simulated data.
• Min. Diff. Absolute Values - Uses a calibration designed to minimize the sum of absolute discrepancy between
the observed data and the model simulated values. This calibration favors solutions that minimize the overall
sum of discrepancies between observed and simulated data.
• Minimize Max. Difference - Uses a calibration designed to minimize the maximum of all the discrepancies
between the observed data and the model simulated values. This calibration favors solutions that minimize the
worst single discrepancy between observed and simulated data. Note that the Minimize Maximum Difference
Fitness Type is more sensitive to the accuracy of your data than other Fitness Types.
• Head/Flow per Fitness Point - Head and Flow per Fitness Type provide a way for you to weigh the importance of
head and flow in your calibration. Set these values such that the head and flow have unit equivalence. You can give
higher importance to Head or Flow by setting a smaller number for its Per Fitness Point Value.
• Flow Weight Type - Select the type of weight used: None, Linear, Square, Square Root, and Log. The weighting
type you use can provide a greater or lesser fitness penalty.
In general, measurements with larger flow carry more weight in the optimization calibrations than those with less
flow. You can exaggerate or reduce the effect larger measurements have on your calibration by selecting different
weight types. For example, using no weighting (None) provides no penalty for measurements with lesser flow
versus those with greater flow. Using log and square root reduces the fitness penalty for measurements with lesser
flow, and using linear or square increases the fitness penalty for measurements with less flow.

Note: If you change the Calibration Options, any fitness values you get are not comparable to fitness values
obtained using different Calibration Options settings.

Calibration Criteria Formulae

670
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

671
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Optimized Runs

Note: The Roughness, Demand, and Status tabs display the groups you added when setting up your Adjustment
Groups (for more information, see the Adjustment Groups topic). If a tab is empty, then you did not create a
group for the condition represented by that tab.

A genetic-algorithm Optimized Run consists of categorized data split among the tabs listed below:

Roughness Tab
The Roughness tab allows you to select the roughness adjustment groups (which were defined in the Calibration Study)
and the operations to perform during the manual run.
The Roughness tab consists of a table containing the following columns:
• Roughness Adjustment Group - Displays the name of the roughness adjustment group.
• Is Active? - If this box is checked, the associated adjustment group will be considered during calibration. If the box
is cleared, it will be ignored.
• Operation - Select the operation you want the calibration to perform.
• Minimum Value - Enter the minimum value that you want the genetic algorithm to use as a lower boundary when
calculating fitness solutions.
• Maximum Value - Enter the maximum value that you want the genetic algorithm to use as an upper boundary when
calculating fitness solutions.
• Increment - Set the increment as the intervals at which you want the GA to test. Try to choose an increment that
gives the least number of possible alternatives. You may need to decrease the range between your upper and lower
limits to do this.

Note: When using Darcy Wesibach as the headloss formula and using the SET option for applying roughnesses to
calibration groups, the expected unit of the input for Darcy Weisbach e is millifeet.

Demand Tab
The Demand tab allows you to select the demand adjustment groups (which were defined in the Calibration Study) and
the parameters to use during the optimized run.
The Demand tab consists of a table containing the following columns:
• Demand Adjustment Group - Displays the name of the demand adjustment group.
• Is Active? - If this box is checked, the associated adjustment group will be considered during calibration. If the box
is cleared, it will be ignored.
• Operation - Select the operation you want the calibration to perform.
• Minimum Demand Multiplier - Enter the minimum demand multiplier that you want the genetic algorithm to use as
a lower boundary when calculating fitness solutions. This field will only be editable for Multiply Original Demand
Operations.
• Maximum Demand Multiplier - Enter the maximum demand multiplier that you want the genetic algorithm to use as
an upper boundary when calculating fitness solutions. This field will only be editable for Multiply Original Demand
Operations.

672
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

• Demand Multiplier Increment - Set the increment as the demand multiplier intervals at which you want the GA to
test. Try to choose an increment that gives the least number of possible alternatives. You may need to decrease the
range between your upper and lower limits to do this. This field will only be editable for Multiply Original Demand
Operations.
• Minimum Emitter Coefficient - Enter the minimum emitter coefficient that you want the genetic algorithm to use as
a lower boundary when calculating fitness solutions. This field will only be editable for Set Emitter Coefficient and
Detect Leakage Node Operations.
• Maximum Emitter Coefficient - Enter the maximum emitter coefficient that you want the genetic algorithm to use
as an upper boundary when calculating fitness solutions. This field will only be editable for Set Emitter Coefficient
and Detect Leakage Node Operations.
• Emitter Coefficient Increment - Set the increment as the emitter coefficient intervals at which you want the GA to
test. Try to choose an increment that gives the least number of possible alternatives. You may need to decrease the
range between your upper and lower limits to do this. This field will only be editable for Set Emitter Coefficient and
Detect Leakage Node Operations.
• Number of Leakage Nodes - The maximum number of leakage nodes possible for the demand group when
calculating fitness solutions. This field will only be editable for Detect Leakage Node Operations.

Status Tab
Use the Status tab to see the initial status of each of the pipes in each of the Status Element adjustment groups which
were defined in the Calibration Study. For each of the elements, if the Is Active? box is checked, the associated element
will be considered during calibration. If the box is cleared, it will be ignored.

Field Data Tab

The Field Data tab displays all the field data snapshots you have entered for the calibration. Click the Is Active? check
box next to the name of each of the field data snapshots you want to use for the calibration trial. Field data snapshots
that have unchecked boxes next to them will not be used to test fitness when you Compute.

Options tab (Optimized Run only)

The Options tab is where you define the parameters for the genetic algorithm. Options relate to optimized design runs
only and therefore are not available for manual design runs. Use these settings to fine-tune the way the GA finds
results. If adjusting a particular GA control gives you better results, pursue the approach to maximize your design.

673
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Stopping Criteria Max. Trials - Set the maximum number of calibration

trials you want the GA to process before stopping. Non-
Improvement Generations - Set the number of maximum
number of non-improvement generations you want the
GA to process without calculating an improved fitness. If
the GA makes this number of calculations without finding
an improvement that is better than the defined Fitness
Tolerance, the GA will stop. Non-Improvement
Generations works in conjunction with Fitness Tolerance.

Top Solutions Solutions to Keep - Select the number of solutions you

want to keep. For a design type of Minimize Cost or
Maximize Benefit, Darwin Designer retains the top
feasible solutions according to the value of the objective
function. If the user-specified number of top solutions is
greater than the number of feasible solutions found,
Darwin Designer reports all the feasible solutions found.

Notes Tab
Type any notes that you want associated with the calibration.

674
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Manual Runs

Note: The Roughness, Demand, and Status tabs display the groups you added when setting up your Adjustment
Groups (for more information, see the Adjustment Groups topic). If a tab is empty, then you did not create a
group for the condition represented by that tab.

A Manual calibration run consists of categorized data split among the tabs listed below:

Roughness Tab
The Roughness tab allows you to select the roughness adjustment groups (which were defined in the Calibration Study)
and the operations to perform during the manual run.
The Roughness tab consists of a table containing the following columns:
• Roughness Adjustment Group - Displays the name of the roughness adjustment group.
• Is Active? - If this box is checked, the associated adjustment group will be considered during calibration. If the box
is cleared, it will be ignored.
• Operation - Select the operation you want the calibration to perform.
• Value - Type the value you want to be used in conjunction with the operation during the manual calibration run.

Demand Tab
The Demand tab allows you to select the demand adjustment groups (which were defined in the Calibration Study) and
the parameters to use during the optimized run.
The Demand tab consists of a table containing the following columns:
• Demand Adjustment Group - Displays the name of the demand adjustment group.
• Is Active? - If this box is checked, the associated adjustment group will be considered during calibration. If the box
is cleared, it will be ignored.
• Operation - Select the operation you want the calibration to perform.
• Minimum Demand Multiplier - Enter the minimum demand multiplier that you want the genetic algorithm to use as
a lower boundary when calculating fitness solutions. This field will only be editable for Multiply Original Demand
Operations.
• Maximum Demand Multiplier - Enter the maximum demand multiplier that you want the genetic algorithm to use as
an upper boundary when calculating fitness solutions. This field will only be editable for Multiply Original Demand
Operations.
• Demand Multiplier Increment - Set the increment as the demand multiplier intervals at which you want the GA to
test. Try to choose an increment that gives the least number of possible alternatives. You may need to decrease the
range between your upper and lower limits to do this. This field will only be editable for Multiply Original Demand
Operations.
• Minimum Emitter Coefficient - Enter the minimum emitter coefficient that you want the genetic algorithm to use as
a lower boundary when calculating fitness solutions. This field will only be editable for Set Emitter Coefficient and
Detect Leakage Node Operations.
• Maximum Emitter Coefficient - Enter the maximum emitter coefficient that you want the genetic algorithm to use
as an upper boundary when calculating fitness solutions. This field will only be editable for Set Emitter Coefficient
and Detect Leakage Node Operations.

675
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

• Emitter Coefficient Increment - Set the increment as the emitter coefficient intervals at which you want the GA to
test. Try to choose an increment that gives the least number of possible alternatives. You may need to decrease the
range between your upper and lower limits to do this. This field will only be editable for Set Emitter Coefficient and
Detect Leakage Node Operations.
• Number of Leakage Nodes - The maximum number of leakage nodes possible for the demand group when
calculating fitness solutions. This field will only be editable for Detect Leakage Node Operations.

Status Tab
Use the Status tab to view and modify the initial status of each of the pipes in each of the Status Element adjustment
groups which were defined in the Calibration Study.
For each of the elements, if the Is Active? box is checked, the associated element will be considered during calibration.
If the box is cleared, it will be ignored.
To change the initial status of a pipe, click the associated Element Status field and select the new status. When an initial
status has been changed, the associated Changed? check box will be checked.

Field Data Tab

The Field Data tab displays all the field data snapshots you have entered for the calibration. Click the Is Active? check
box next to the name of each of the field data snapshots you want to use for the calibration trial. Field data snapshots
that have unchecked boxes next to them will not be used to test fitness when you Compute.

Notes Tab
Enter any notes that you want associated with the calibration.

Calibration Solutions

After computing an optimized or manual run, one or more solutions will appear in the calibration study list pane.
Highlighting a solution makes the following tabs available on the right side of the dialog:
Solution Tab - The Solution tab displays the adjusted values for each adjustment group along with a comparison of the
original and adjusted value for each element within each adjustment group. The solution results are filtered by
Adjustment Group Type; click the desired type in the Adjustment Group Type pane.

676
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Simulated Results Tab - The Simulated Results tab displays the simulated HGL or flow against the observations you
recorded in your field data and the difference between the observed and simulated values. The solution results are
filtered by attribute type; click the desired type in the Attribute pane.

677
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Additionally, when a solution is highlighted in the calibration study list pane, the following controls become available:
• Export to Scenario - Click the Export to Scenario button to export the currently selected Calibration solution to the
water flow model. This opens the Export Calibration to Scenario dialog box (for more information, see Calibration
Export to Scenario Dialog Box (on page 679)).
• Report - Click the Report button to display a print preview of the solutions data window.
• Graph - Click Graph button to see a graph of your observed data sets versus the HGL correlation between the
Simulated and Observed HGL.

Correlation Graph Dialog Box

This dialog displays a graph that shows the correlation between the Simulated and Observed HGL.

678
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Copy
Copies the current graph to the clipboard
Print Preview
Displays a preview of the graph as it will look when printed.
Options
Opens the chart options to allow the graph display to be customized.
Close
Closes the graph window.
Help
Opens the help for the Correlation Graph dialog box.

Calibration Export to Scenario Dialog Box

Darwin field data snapshots can be imported via ModelBuilder, the field data needs to be prepared in a certain format
for a different collection of data. Let's take Excel as a data source example; the import process from other data sources
will be very similar to this too.

Importing Field Data into Darwin Calibrator Using ModelBuilder

Darwin field data snapshots can be imported via ModelBuilder, the field data needs to be prepared in a certain format
for a different collection of data. Let's take Excel as a data source example; the import process from other data sources
will be very similar to this too.

Note: As an example, if you are trying to use ModelBuilder to import calibration data but have never opened
Calibrator in this particular model, you will not see the "Field Data Snapshot" model type in the dropdown list

679
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

for Table Type. This is because that database type and its associated fields haven't been initialized yet. You
would click on Analysis > Darwin Calibrator first in the main menu. Once this is done, the Field Data Snapshot
and other Calibrator related fields are created, and those options will then appear in the ModelBuilder dialogs.

Import Snapshots
Multiple snapshots can be imported into calibration study in Darwin Calibrator; the data should be prepared in a format
as in the table below:

Snapshot Label Time Owner

highupstream leak hr 18test 2 18:00 New Calibration Study - Imported

Data

highupstream leak hr 5test 5:00 New Calibration Study - Imported

Data

even leak hr 8test 8:00 New Calibration Study - Imported

Data

even leak hr 18test 18:00 New Calibration Study - Imported

Data

highupstream leak hr 8test 8:00 New Calibration Study - Imported

Data

highdownstream leak hr 8test 8:00 New Calibration Study - Imported

Data

highdownstream leak hr 18test 18:00 New Calibration Study - Imported

Data

Once the data source is connected within ModelBuilder, make sure that the attribute is correctly mapped as follows:
1. Highlight the Snapshot table in the left panel.
2. Select Field data Snapshot for Table Type under Setting Tab on the right.
3. Map the correct attribute for the snapshot data fields.
Example is given as below:

680
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

Import Observed Target

Darwin Calibrator employs a powerful competent genetic algorithm search method based on the principles of natural
evolution and biological reproduction. This kind of search algorithm is well suited to optimization of problems of a
non-convex and multiple local-optimal solution nature. Calibration of a hydraulic model falls into this problem
category and, as a result, a GA-optimization based search tool, such as Darwin Calibrator, is a sound choice for
hydraulic model calibration.
Despite all the good features of GA there are, however, some issues to consider:
• A solution is fitter only in relation to other known solutions and, consequently, a GA has no test for true optimality.
As a GA only knows the best solution relative to others, a GA has no precise rule for when to stop. This means that
heuristic methods must be used to determine whether to stop a GA run. In Darwin Calibrator you can set a GA run
to stop either by:
• Clicking Stop.
• Setting a maximum number of trial solutions.
• Setting a maximum number of non-improvement generations, whereby if the fitness of the best solution does not
improve by more than a specified tolerance in a set number of generations, then the GA stops.
• A GA is a non-deterministic method that relies to a certain extent on its initial random population (starting locations
in the solution space). Thus, each GA run performed may produce different solutions. (If you keep all GA
parameters and fitness settings the same, the method is deterministic and will produce identical solutions every
time.) Given the fact that a GA has no true test for optimality, after stopping a GA and producing a particular result,

681
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

there is always the possibility that if you run the GA again you may find a better solution. In fact, it is good practice
to run a GA a number of times, each time modifying something about the GA run (e.g., GA parameters, fitness
weightiness, or adjustment group settings), in order to produce another set of potentially better results. At a
minimum, the random number seed should be changed for each individual run so that the GA search initiates
differently and therefore concludes differently.
• The GA calculates fitness of each trial solution according to the defined objectives for the optimization problem.
GA only uses objective means to decide what constitutes a fit solution and what constitutes a less fit solution. The
GA has no way of subjectively assessing a solution other than the methods (weightings) built into the definition of
the fitness calculation. The best solution found by a GA shouldn’t be blindly accepted as being correct. To any
single optimization problem there are likely to be many solutions that closely match the required objectives. Due to
the fact that the GA has no concept of what constitutes a fit solution, other than its performance against the defined
objectives, the GA may produce solutions that are impractical. That is, the GA cannot think for the engineer, it can
only search the combination of choices that are presented to it. If the engineer doesn’t provide the GA with high
quality data and enough or sufficiently flexible options to consider, then the GA may not be able to find a
satisfactory solution. Conversely if the GA is presented with too many possibilities to try (e.g., in Darwin
Calibrator, if you define excessively large adjustment group ranges combined with small adjustment increments and
a large number of adjustment groups), then the efficiency of the GA search is reduced, and the likelihood that the
GA will find the correct answer is also greatly reduced. GA is a highly sophisticated search technique, but despite
all of its great features, GA still must be used with a degree of engineering judgment and skill. Only then can the
engineer expect the GA to find solutions that are not only fit but are practical and likely to represent the real life
situation as accurately as possible.
• Uncertainty in field observations should be assessed before these observations are used in an optimization. It is not
uncommon for errors in measurement of head loss to be on the same order of magnitude or larger that the actual
head loss (Walski, 2000). Such values should not be used in calibration because the calibration algorithm will
dutifully try to match the field observations even if they are erroneous. To ensure that head loss is adequate to
exceed measurement error, it is helpful to collect data when velocities in pipes are appreciable. In some systems
sized for fire protection, demands (and velocities and head losses) are so low most of the time that head loss
measurements are meaningless, other than to check pressure gage elevations. Another problem that occurs when
calibrating a model is that some of the parameters determined are fixed and knowable at the time the data were
taken (roughness, valve status), while others are merely a random observation from a stochastic process (water use).
If a C-factor is determined as 90, then that value will be true in the not to distant future. If water use during a
pressure observation is determined to be 100 gpm (6.3 l/s), is that value the demand that should be used in
modeling, given that it is only one observation from a distribution? The actual water determined from calibration
may not be the best value to use for representing the current year status of the system. You need to decide if the
water use observed during calibration is the water use that should be used as a basis for future modeling.

GA-Optimized Calibration Tips

Darwin Calibrator employs a powerful competent genetic algorithm search method based on the principles of natural
evolution and biological reproduction. This kind of search algorithm is well suited to optimization of problems of a
non-convex and multiple local-optimal solution nature. Calibration of a hydraulic model falls into this problem
category and, as a result, a GA-optimization based search tool, such as Darwin Calibrator, is a sound choice for
hydraulic model calibration.
Despite all the good features of GA there are, however, some issues to consider:
• A solution is fitter only in relation to other known solutions and, consequently, a GA has no test for true optimality.
As a GA only knows the best solution relative to others, a GA has no precise rule for when to stop. This means that
heuristic methods must be used to determine whether to stop a GA run. In Darwin Calibrator you can set a GA run
to stop either by:
• Clicking Stop.

682
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

• Setting a maximum number of trial solutions.

• Setting a maximum number of non-improvement generations, whereby if the fitness of the best solution does not
improve by more than a specified tolerance in a set number of generations, then the GA stops.
• A GA is a non-deterministic method that relies to a certain extent on its initial random population (starting locations
in the solution space). Thus, each GA run performed may produce different solutions. (If you keep all GA
parameters and fitness settings the same, the method is deterministic and will produce identical solutions every
time.) Given the fact that a GA has no true test for optimality, after stopping a GA and producing a particular result,
there is always the possibility that if you run the GA again you may find a better solution. In fact, it is good practice
to run a GA a number of times, each time modifying something about the GA run (e.g., GA parameters, fitness
weightiness, or adjustment group settings), in order to produce another set of potentially better results. At a
minimum, the random number seed should be changed for each individual run so that the GA search initiates
differently and therefore concludes differently.
• The GA calculates fitness of each trial solution according to the defined objectives for the optimization problem.
GA only uses objective means to decide what constitutes a fit solution and what constitutes a less fit solution. The
GA has no way of subjectively assessing a solution other than the methods (weightings) built into the definition of
the fitness calculation. The best solution found by a GA shouldn’t be blindly accepted as being correct. To any
single optimization problem there are likely to be many solutions that closely match the required objectives. Due to
the fact that the GA has no concept of what constitutes a fit solution, other than its performance against the defined
objectives, the GA may produce solutions that are impractical. That is, the GA cannot think for the engineer, it can
only search the combination of choices that are presented to it. If the engineer doesn’t provide the GA with high
quality data and enough or sufficiently flexible options to consider, then the GA may not be able to find a
satisfactory solution. Conversely if the GA is presented with too many possibilities to try (e.g., in Darwin
Calibrator, if you define excessively large adjustment group ranges combined with small adjustment increments and
a large number of adjustment groups), then the efficiency of the GA search is reduced, and the likelihood that the
GA will find the correct answer is also greatly reduced. GA is a highly sophisticated search technique, but despite
all of its great features, GA still must be used with a degree of engineering judgment and skill. Only then can the
engineer expect the GA to find solutions that are not only fit but are practical and likely to represent the real life
situation as accurately as possible.
• Uncertainty in field observations should be assessed before these observations are used in an optimization. It is not
uncommon for errors in measurement of head loss to be on the same order of magnitude or larger that the actual
head loss (Walski, 2000). Such values should not be used in calibration because the calibration algorithm will
dutifully try to match the field observations even if they are erroneous. To ensure that head loss is adequate to
exceed measurement error, it is helpful to collect data when velocities in pipes are appreciable. In some systems
sized for fire protection, demands (and velocities and head losses) are so low most of the time that head loss
measurements are meaningless, other than to check pressure gage elevations. Another problem that occurs when
calibrating a model is that some of the parameters determined are fixed and knowable at the time the data were
taken (roughness, valve status), while others are merely a random observation from a stochastic process (water use).
If a C-factor is determined as 90, then that value will be true in the not to distant future. If water use during a
pressure observation is determined to be 100 gpm (6.3 l/s), is that value the demand that should be used in
modeling, given that it is only one observation from a distribution? The actual water determined from calibration
may not be the best value to use for representing the current year status of the system. You need to decide if the
water use observed during calibration is the water use that should be used as a basis for future modeling.

Darwin Calibrator Troubleshooting Tips

If you've found your way to this section, then you are probably looking for an answer to a problem that you cannot find
elsewhere. Please refer to the list below if you are having problems running Darwin Calibrator (you keep getting
unsatisfactory solutions) or if you receive this message while running a calibration: The calibration engine was
unsuccessful. See the help system for troubleshooting tips.
If you are receiving the engine unsuccessful message, try the following:

683
WaterGEMS CONNECT Edition Help
Calibrating Your Model with Darwin Calibrator

• Take note of the error message that is provided along with the calibration engine was unsuccessful message. It may
provide a clue as to why your calibration didn't run and save you from having to go any further through this list!
• Ensure that the scenario model upon which the calibration is based will run properly in WaterGEMS CONNECT .
Select Analysis > Compute, select the steady state button, and click GO. If the run obtains either a yellow or green
light, then the hydraulic model runs and this is not the problem.
• Ensure that all your roughness and demand group settings are valid and reasonable. For example, ensure that
roughness adjustments and/or demand adjustments are not such that your hydraulic model might have difficulty
converging. For example, make sure that you are not allowing demands to be set too high or pipes too rough,
causing excessive amounts of head loss.
• If you have a large number of pipes assigned to status groups, review the need to include all of those pipes as status
decisions and try to minimize the number of pipes in status groups.

Note: Virtual memory settings should only be adjusted by advanced users or system administrators.
• You may be experiencing low system memory. When running Darwin Calibrator, be sure to close any other unused
applications and if adjusting advanced GA parameters ensure that you are using a cut probability of more than a few
percent, and a splice probability of less than 90 percent. If your system doesn't have much RAM (<128Mb), you
may also wish to increase the amount of allocated virtual memory that your system is using. Please see your
Microsoft Windows documentation for information on virtual memory settings specific to your operating system.
If you are having problems getting reasonable calibration solutions, try the following:
• Ensure that the Time field for each of your field data measurement sets corresponds to the time of day that your
measurements were taken. The reason being that the time entered in your field data set is used to determine demand
multipliers (from hydraulic patterns), which are in turn used to calculate the junction demands that will be simulated
within the GA calibration engine. (The demand at a junction during a GA calibration run is the product of its
baseline demands and the demand factors at the time specified for the field data set.) Pump settings and control
settings, etc., are also determined from the time setting you specify. Demand multiplier adjustments and additional
junction demands (e.g., fire flow tests) are in addition to, not in lieu of, junction demands already calculated from
pattern multipliers. Also note that a steady state run in WaterGEMS will run with only junction baseline demands
applied, whereas a GA calibration run based on a steady state scenario will still use pattern multipliers for the
specified time.
• Modifying the status of a link can have significant effects on hydraulic results and your chances of finding good
calibration solutions. If you are using a number of status group adjustments, you should review why you need those
adjustment groups. It may be better to experiment with these kinds of adjustments manually, or get somebody to
find out whether that valve really is closed and remove the status decision from the GA calibration. In general, try to
keep status adjustment decisions to a minimum.
• Make sure that your adjustment groupings are logical. For example, junctions are grouped by similar pattern or
demands for demand groups and pipes are grouped by similar size, age and location for roughness groups.
• Ensure that you do not have too many adjustment groups or the allowable ranges and increments for those groups
do not allow too many choices for each group. For example, a roughness group allowed to vary between a Hazen-
Williams C of 80 and a Hazen-Williams C of 130, with an increment of 0.1 equates to 500 different possible
roughness settings for one group. This is far too high! Try to choose lower and upper bounds, and an increment that
will give you no more than 10-12 possible values. If need be, you can start off with course settings (say 80 to 130
with an increment of 5) initially, and gradually refine the allowable range and increment to refine your calibration
solutions. This applies to both roughness adjustment groups and also to demand adjustment groups.
• Make sure that you have sufficient and quality field data and that it has been entered correctly. In general, it is a
good idea to have as many (or more) field data measurements as adjustment groups for the calibration, or else your
calibration problem is under-specified. This means that there is likely to be multiple calibration solutions that
produce the same or very similar hydraulic results (e.g., solutions that exhibit compensating errors). In theory, there
is only one correct solution, however, due to limits observed for many practical model calibrations, the more quality
field data you can provide, the better chance you have of finding a solution that is close to the real situation. When

684
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

assessing the number of field observations that you have, consider that each individual observation should
contribute unique and accurate information to the calibration. For example, pressure measurements made at two
junctions in different parts of the distribution system are likely to be more valuable than two measurements made at
locations close to each other in the distribution system. In fact, the two measurements taken at points close together
may only be as good as one measurement. That is, both measurements say the same thing about the system. Simply,
the field data you collect and enter into Darwin Calibrator should be data that represents times when your system is
experiencing high demand, even if it is only the result of such activities as fire flow tests. The reason for this is that
during times of normal demands, the head loss across the system is usually on the same order of magnitude as the
error in measuring head loss. Therefore, small errors in measurement can lead to huge errors in roughness
coefficient or demand.
• Make sure that you haven't entered field data observations that are made impossible to achieve by any observed
boundary conditions, such as an observed grade out for a PRV set to a different grade.

Note: Tank levels, pump speed settings, valve settings, and reservoir HGL are all used by the calibration
engine as boundary conditions and as such these field data entries will not appear in the calibration report
summary. That is, these quantities are set as fixed in the calibration simulations and the calibration does not
try to match these data. All other quantities are used as observed quantities that the calibration engine tries
to match by adjusting parameters defined in your adjustment groups.
• Make sure you are using the correct boundary conditions. If you have entered observations for tank levels etc.,
ensure that you have not made any errors in entering the data.

Optimizing Capital Improvement Plans with Darwin Designer

Learn more about optimizing capital improvement plans using Darwin Designer by clicking the links below:

Darwin Designer

Darwin Designer allows you to design new pipe layouts or pipe rehabilitation for existing pipes. A genetic-algorithm
based approach avoids a manual trial and error approach to finding the most efficient design. Solutions and costs
calculated using Darwin Designer can be exported back to any scenario.
To open Darwin Designer
1. Start WaterGEMS CONNECT.
2. Go to Analysis > Darwin Designer.

3. Click New Designer Study.

685
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Design Study

A design study is a top-level grouping of the pipe design and rehabilitation you want to do for one complete design
hydraulic model. A design study should be used to represent a real hydraulic model unit, such as a system expansion,
main replacement, system augmentation, etc. For different or unrelated projects-such as a main replacement hydraulic
model and a hydraulic model to design a new service area-you should use different, new design studies.
To start using Darwin Designer, you must first create a design study. All Darwin Designer data exists within design
studies.

686
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

A design study includes the following:

687
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

1. A description of the events that serve as the basis for design.

2. A set of pipes being sized or rehabilitated.

3. Constraints you must meet, which are defined in a design event.
4. A range of design sizes or rehabilitation options.

688
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

5. Cost data for use in the optimization.

6. Genetic algorithm options.

7. A number of design runs to test the design.

8. The results of design runs.

It is apparent that one or more of these items will be different between different design studies, hence the ability to
create as many design studies as you need.
You can create more than one design study. Each design study can include one or more design runs. Each design run is
manual or optimized. The particular events and groups are specified by making them active. You may create many
design runs within a design study.
In the design study, create the groups of pipes for design and rehabilitation, define the design/rehab options (costs and
sizes, etc.), and define constraints and parameters for your designs. These items get used in the design runs and the
computations that produce your design results.
• New: Clicking New opens a submenu containing the following commands:

689
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

• New Designer Study - More than one design study can be added and design studies are not related.
• New Optimized Design Run - Add an optimized design run. Optimized design runs use a genetic algorithm.
• New Manual Design Run - Add a manual design run for specific solution alternatives for trial-and-error
calculations.
• Delete: Click to delete the selected design study.
• Rename: Click to change the name of the selected design study.
• Compute: Click to compute the run.
• Export to Scenario: Click to export your results as an alternative to your scenario. Export creates a new scenario and
then can export the following data to alternatives:
• Physical Alternative data: diameter, roughness, and material.
• Active Topology Alternative: If the pipe diameter is 0, the pipe is made inactive in the active topology
alternative.
• Report: Click to present the data in the Report Viewer.
• Graph: Click to display a graph of the results.
• Help: Click to open the online help.

Design Events tab

The Design Events tab displays a list of the events you have set up. Select the check boxes to set as Active those criteria
that you want to be used in the calculation of your design run. Your design run must have at least one active design
event in order to be calculated without error.

Design Events Lists the design event.

Is Active? Select the check box for the design events to be included
in the current design run.

Boundary Overrides tab

Boundary overrides are explicitly specified for each design event and used for evaluating a trial design solution for a
design event.
Boundary conditions can be used to override initial settings from the design representative scenario for a design event.
For example, if you want to simulate a pipe break, you can set the status of a pipe to closed for a pipe-outage design
event. Similarly, valve settings can be applied, tank levels, and so on. Without a specified boundary condition for a
design event, Darwin Designer will apply the initial settings from the representative scenario when evaluating the
corresponding design event.
When calculating an EPS model to get boundary conditions, Darwin Designer uses the sizes, demands, etc., that are
present in the representative scenario. If the representative scenario includes lots of unsized pipes, then you will need to
override the appropriate boundary conditions (such as, a tank in a new part of the model). If you do not specify a time
step on the Demand Adjustments tab, the initial conditions at time 0 will be used.
You only need to explicitly state a boundary condition if you wish to change it from the default. Do not try to look at
boundary conditions by selecting All Pipes or All Pumps because this sets all pipes to Closed or all pumps to Off.

690
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Click to add a new design event. Opens the Select

Snapshot box where you can select a new design event or
New an existing design event.

Click OK after you make a selection.

Click to create a copy of the selected design event. This

can be an efficient way to create a new design event that
Duplicate has many of the attributes of an existing event.

Click to delete the selected design event.

Delete

Click to open the Initialize Table from Selection Set box

where you can choose the Selection Set and the Design
Initialize Table from Selection Set Event.

Click OK to run.

691
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Click to open the Load from Model box. Load settings

and conditions for your elements at a time from start that
Load from Model you specify. For example, if your peak time is 6 pm, you
can load the settings for your elements from the model at
that time.

Click OK to run.

Design Event The name of the event.

Element Click the ellipsis to select from the drawing the type of
element to set a boundary condition: pump, tank, pipe, or
valve.

Attribute The attribute list reflects your selection of an element

type.

Value Open, Closed, On, Off, or a numeric value depending on

the selected attribute.

Demand Adjustments tab

The sizing of pipes in designer is driven by demands. By default, the demands used will be those associated with the
representative scenario. However, you may want to use different demands, such as fire flows or peaks.

692
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Click to add a new design event. Opens the Select

Snapshot box where you can select a new design event or
New an existing design event.

Click OK after you make a selection.

Click to create a copy of the selected design event. This

can be an efficient way to create a new design event that
Duplicate has many of the attributes of an existing event.

Click to delete the selected design event.

Delete

Click to open the Initialize Table from Selection Set box

where you can choose the Selection Set and the Design
Initialize Table from Selection Set Event.

Click OK to run.

Design Event The name of the event.

Node Click the ellipsis to select the node from the drawing.

693
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Additional Demand Fire flows or other special cases can be achieved by

adding demand adjustments to individual junctions: by
selecting the junction and specifying the additional
demand. If necessary, demands can also be subtracted by
specifying a negative number. Be sure to enter demands
in the correct flow units.

Pressure Constraints Tab

Use this tab to define pressure constraints for all junctions or a set of junctions.

Click to add a new design event. Opens the Select

Snapshot box where you can select a new design event or
New an existing design event.

Click OK after you make a selection.

Click to create a copy of the selected design event. This

can be an efficient way to create a new design event that
Duplicate has many of the attributes of an existing event.

Click to delete the selected design event.

Delete

Click to open the Initialize Table from Selection Set box

where you can choose the Selection Set and the Design
Initialize Table from Selection Set Event.

Click OK to run.

694
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Design Event The name of the event.

Node Click the ellipsis to select the node from the drawing.

Min. Pressure Set a minimum pressure that you require for the selected
set of junctions. Violations of this boundary are displayed
when you calculate your network.

Max. Pressure Set a maximum pressure that you require for the selected
set of junctions. This value cannot be lower than the
minimum pressure you set. You can set this to an
unusually high value if you are unconcerned with
maximum pressure. Violations of this boundary are
displayed when you calculate your network.

Consider Pressure Benefit? Select this check box if you want the genetic algorithm to
consider the benefits provided to your design by higher
system pressures.

Flow Constraints Tab

Use this tab to define flow boundary conditions for a junction or set of junctions.
• New: Click to add a new design event. Opens the Select Snapshot box where you can select a new design event or
an existing design event.
• Duplicate: Click to create a copy of the selected design event. This can be an efficient way to create a new design
event that has many of the attributes of an existing event.
• Delete: Click to delete the selected design event.
• Initialize Table from Selection Set: Click to open the Initialize Table from Selection Set box where you can choose
the Selection Set and the Design Event.
The table consists of the following columns:
• Design Event: The name of the event.
• Pipe: Click the ellipsis to select the pipe from the drawing.
• Min. Velocity: Set a minimum velocity that you require for the selected set of pipes. Violations of this boundary are
displayed when you calculate your network.
• Max. Velocity: Set a maximum velocity that you require for the selected set of pipes. You can set this to an
unusually high value if needed. Violations of this boundary are displayed when you calculate your network.
• Consider Pressure Benefit?: Select this check box if you want the genetic algorithm to consider the benefits
provided to your design by higher system pressures.

695
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

To create a new Design Event:

1. Select the Scenario to base your design.
2. Click New.
3. Select the new event in the Label field and click rename.
4. Type a name for the design event and then click OK.
5. Enter the data to define the design event.

Design Groups tab and Rehab Groups tab

Darwin Designer determines the size or rehab action for pipes. It is unlikely, however, that a large pipeline will change
diameter every block along its route. Plus, if fewer pipes were being sized, optimization will happen faster than if a
larger number of pipes were sized. Therefore, Darwin Designer uses the idea of a pipe group or rehab group to group
pipes that will attract the same design decision. At the end of a run, all of the pipes in the same design group are given
the same diameter, and all of the pipes in the same rehab group receive the same rehab action. This is both logical and
more efficient from a computational standpoint.
For a pipe to be considered a candidate for design or rehab, it must be placed in a group. This is done on the Design
Groups or Rehab Groups tab when the Design Study is highlighted. (When the Design Run is highlighted, you choose
which groups are to be considered during that run.)
You must insert at least one pipe in each design group. There is no absolute rule for deciding which pipes belong in a
given group. Usually it is the set of pipes that will be laid with the same diameter and at the same time, but it can also
be smaller groups than that, and in the case of smaller design problems or academic exercises, it may be only 1 pipe per
group, which is easily expedited with the Create Multiple Design Groups selection. The down side of adding every
pipe to its own group, however, is that this can be computationally inefficient and potentially leads to a pipeline that is
say 12 in. for one block, 8 in. for the next, 6 in. the next, etc., which may be a theoretically least-cost design but is not a
solution that is likely to be installed. Ultimately the choice comes down to a trade-off between number of pipe groups
(and size of the optimization problem) versus constructability of the design through the potential for different pipe sizes
adopted for each group.
Design Groups tab

New Click to add a new demand group.

Delete Click to delete the selected demand group.

Label Type in the field to rename the demand group.

Rehab Groups tab

696
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

New Click to add a new roughness group.

Delete Click to delete the selected roughness group.

Label Type in the field to rename the roughness group.

To add a new design or rehab group

1.
Click New .
2. Type in the Label field to rename the demand group.
3. In the Element ID field, click the ellipsis to select the pipes included in the group.

4. The Selection Set box opens.

697
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Click Select.
5. Use the Select box to either choose items from the drawing to include in the group, or click Queryy to build a query
for this group.

Click Done when finished.

6. Click OK to create the group or Cancel to exist without creating the group.

7. The Element ID field will show the new Collection and the Element IDs <Count> field will show the number of
pipes in the group.

To make changes to a design or rehab group

1.
Click the ellipsis in the Element ID field.
2. In the Selection Set box, you can either remove the pipes and/or junctions you want to include in your group, or add
additional pipes and/or junctions.
3. After you have selected the elements, click OK to apply your changes to the group or click Cancel to exit without
making any changes.

Rehabilitation Group Designer Dialog Box

698
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

This dialog allows you to create rehabilitation groups by selecting elements from the drawing or by using predefined
selection sets.

Choose a predefined selection set from the Selection Set list, use all elements by selecting <All Available>, or click the
ellipsis button to pick a group of elements from the drawing. The elements that are part of the group are displayed in
the list pane at the bottom of the dialog.

Costs/Properties Tab
Costs/Properties are used by Darwin Designer to determine the hydraulic effect and calculate the capital cost of the
solutions it generates. Cost/Properties come in two types: Design Option Groups (new pipes) and Rehab Option Groups
(rehabilitation actions).
Design options (new pipe sizes and associated roughness, material type and unit cost) are defined by adding design
option groups

Rehab Options (rehab actions and associated post action functions) are defined by adding rehab option groups.

699
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Each option group contains a set of options that Darwin Designer can select from in order to create its hydraulic
solutions. Design Option Groups are used where you are designing a new system or part of a system and brand new
pipes need to be installed. Rehab Option Groups are used when you are examining the effect of rehabilitating (cleaning,
lining, etc.) existing pipes.
Adding and Editing Design Option Groups
Design Option Groups are used to define a selection of pipes that can be used in your design. You may choose to use as
much or as little detail as you wish. For example, for a rough cut design, you may simply wish to use nominal
diameters and estimated unit rates, but for a detailed design you may wish to use internal pipe diameters and even
distinguish between different materials. The new pipe option group is set up to allow you to adopt either approach.
In setting up option groups, you can set up as many groups as needed to describe the different cost situations in your
hydraulic model. For example, you may decide that you have three different cost types that need to be considered:
Residential, Greenfields and Commercial. In this case, you can set up three different option groups to reflect the
different in-ground costs for each of the three different cost types. For example, Greenfields would be cheaper than
Residential, where the additional costs of breaking the road and resurfacing need to be included. Not all groups need to
include the same pipe sizes either, so you may choose to use different option groups as a way of limiting certain pipe
groups to being able to attain only certain sizes. For example, there is not much point allowing a transmission main to
be sized as a 6-in. pipe, where a consumer connection pipe might be acceptable as a 6-in. pipe.
Darwin Designer has the ability to not only size new pipes from a range of possible available pipe sizes, but it can also
determine whether a particular pipe needs to be constructed at all. To get Designer to determine whether a pipe needs to
be constructed at all, simply add a zero diameter option to the pipe option group. The zero diameter option should also
attract a cost of zero (in this case, roughness is redundant). The zero size option can be used to size parallel pipes and it
can also be used to determine the optimal design layout, whereby more pipes are being sized than are necessary to
service all demands.
For pipes that are essential for service and that must be sized, define and use a pipe-option group that contains no zero
diameter option.

700
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

New Click to add a new option group.

Duplicate Click to create a copy of the selected option group. This can be an efficient way to create a new option
group that has many of the attributes of an existing event.

Rename Click to change the name of the selected option group.

Delete Click to delete the selected option group.

For Design Option Groups

New/Delete Click New or Delete to add or remove rows from the table.

Material Click the ellipsis to open the Engineering Libraries box to select the pipe material.

Diameter Type a diameter for the pipe

Hazen Type the roughness value for the pipe.

Williams C
Factor

Unit Cost Type the unit cost value for the pipe.

For Rehab Option Groups

701
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

New/Delete Click New or Delete to add or remove rows from the table.

Action Type the name of the rehabilitation action you are creating.

Pre-Rehab Select or create the function to use for the rehabilitation action you are creating. This function describes
Diameter the pre- and post-rehabilitation pipe diameters. You must create at least one function for pre-
vs. Post rehabilitation diameter versus post-rehabilitation diameter.
Rehab
Diameter
Function

Pre-Rehab Select or create the function to use for the rehabilitation action you are creating. This function describes
vs. Post- the cost of the action per length for pipe of a given pre-rehabilitation diameter. You must create at least
Rehab Cost one function for diameter versus cost.
Function

Pre-Rehab Select or create the function to use for the rehabilitation action you are creating. This function describes
Diameter the pre-rehabilitation diameter versus the post-rehabilitation pipe roughness. You must create at least
vs. Post one function for diameter versus roughness.
Rehab
Function

Rehab Option Groups are used to define the selection of rehab actions that can be used in the design. You may choose
to use as much or as little detail as you want. You can set up as many groups as you need for different cost types, and
not all groups need to include the same rehabilitation options.
Rehab option groups define the selection of rehab actions that can be used in the design. There can be as much detail as
needed, as many groups have different cost types, and not all groups need to include the same rehab options.
In setting up option groups, you can set up as many groups as needed to describe the different cost situations in your
hydraulic model.
To define a rehab option group
1. Click New > Rehab Option Group or right-click Rehabilitation > New Rehabilitation.
2. Click to rename and type the name.
3. Type a name in the Action field.
4. Select the three functions that describe the pre- and post-rehabilitation conditions. You must select one of each type
of function for a rehabilitation action.
a. Click the arrow to select a previously defined function.

702
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

b. Or click the Ellipsis (...) to open the Rehab Function manager where you can define a new function.

5. As needed, click New or Delete to add and remove rows.

6. Create as many rehabilitation actions as needed.

Rehabilitation Functions
Use the Rehabilitation Functions manager to create a rehabilitation function.
To create a rehabilitation function from within a table in the Cost/Properties tab
1. Click in one of Pre-Rehab fields and click the ellipsis (...) to open the Rehab Functions Manager.

703
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

2. Click New to open the menu and select one of the options.
3. Type in the necessary information in the corresponding field.
4. Click Close.

Design Type tab

The Design Type tab allows you to design and weigh benefits so the genetic algorithm knows better what your design
priorities are.

704
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Design Objectives Objective Type - the overall priority of the design. Select
one of the following: Minimize Cost sets price as your
primary concern and the genetic algorithm will consider
costs most heavily. Maximize Benefit sets the
performance of the system as the highest priority. The
system performance is measured by the pressures at
specified junctions using pressure benefits. Multi-
Objective Trade-off allows the genetic algorithm to
consider where the best compromise lies between cost
and pressure benefit. This selection has higher
computational requirements than the other design types.
Available Budget - Type a dollar amount. This field is not
available for Minimize Budget.

Benefit Type Select Dimensionless or Unitized benefit for Maximized

Benefit or Multi-Objective Trade-off. Dimensionless - If
pressure improvement is not a primary concern,
dimensionless benefit considers the ratio of pressure
improvement to minimum pressure for selected junctions.
Multi-Objective Trade-off - If you are looking for a
specific pressure improvement from your system, unitized
benefit considers the average pressure increase for
selected junctions.

Pressure Benefit Set the Pressure Benefit Coefficient and the Pressure
Benefit Exponent. These increase the weighted value of
pressure in your network. Exponent has a larger affect on
the weighted value than the same number for the
coefficient.

Notes Tab
Use the Notes tab to type comments about your hydraulic model and read things like log entries and dates.

Initialize Table From Selection Set Dialog Box

This dialog is used to load data from an existing selection set into the current table. The dialog consists of the following
controls:
In Designer:
Selection Set - This menu contains a list of selection sets. Choose the one that contains the data you want to load.
Design Event - This menu contains a list of the design events. Choose the destination for the selection set data
initialization.
In Darwin Calibrator:
Selection Set - This menu contains a list of selection sets. Choose the one that contains the data you want to load.
Owner Element - This menu contains a list of the field data snapshots. Choose the destination for the selection set data
initialization

705
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Load From Model Dialog Box

Click to open the Load from Model box. Load settings and conditions for your elements at a time from start that you
specify. For example, if your peak time is 6 pm, you can load the settings for your elements from the model at that
time.

Optimized Runs

Note: The Roughness, Demand, and Status tabs display the groups you added when setting up your Adjustment
Groups (for more information, see the Adjustment Groups topic). If a tab is empty, then you did not create a
group for the condition represented by that tab.

A genetic-algorithm Optimized Run consists of categorized data split among the tabs listed below:

Design Events tab

The Design Events tab displays a list of the events you have set up. Select the check boxes to set as Active those criteria
that you want to be used in the calculation of your design run. Your design run must have at least one active design
event in order to be calculated without error.

Design Events Lists the design event.

Is Active? Select the check box for the design events to be included
in the current design run.

Design Groups tab

You must have at least one active design or rehab group set to a valid design or rehab option group.

Design Pipe Group Lists the names of the design pipe groups.

Is Active? Select the check box for the design groups to be included
in the current design run.

706
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Design Group Option For each design group, you must select the design option
group (set of possible pipe sizes) you want to use.

Rehab Groups tab

You must have at least one active rehab group set to a rehab option group.

Rehabilitation Group Lists the names of the roughness groups.

Is Active? Select the check box for the design groups to be included
in the current design run.

Design Option Group For each design group, you can select the design option
group you want to use.

Options tab (Optimized Run only)

The Options tab is where you define the parameters for the genetic algorithm. Options relate to optimized design runs
only and therefore are not available for manual design runs. Use these settings to fine-tune the way the GA finds
results. If adjusting a particular GA control gives you better results, pursue the approach to maximize your design.

707
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Stopping Criteria Max. Trials - Set the maximum number of calibration

trials you want the GA to process before stopping. Non-
Improvement Generations - Set the number of maximum
number of non-improvement generations you want the
GA to process without calculating an improved fitness. If
the GA makes this number of calculations without finding
an improvement that is better than the defined Fitness
Tolerance, the GA will stop. Non-Improvement
Generations works in conjunction with Fitness Tolerance.

Top Solutions Solutions to Keep - Select the number of solutions you

want to keep. For a design type of Minimize Cost or
Maximize Benefit, Darwin Designer retains the top
feasible solutions according to the value of the objective
function. If the user-specified number of top solutions is
greater than the number of feasible solutions found,
Darwin Designer reports all the feasible solutions found.

Notes Tab
Use the Notes tab to type comments about your hydraulic model and read things like log entries and dates.

708
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Manual Design Run

Manual selections are used to force Darwin Designer to use specific designs in calculating costs of a network. The
difference between a manual design run and an optimized design run is the Manual Selection column in the Design
Groups and Rehab Groups tab for the run. After you select a table to use for a group, you then must set that group to
use a specific pipe size or specific rehabilitation action.

Examples of why you might use a manual design

• You might use a manual design to test some hand calculations you have made or to reproduce an optimized design
that you want to force manual overrides.
• You could create a manual design run in which you force the groups of pipes to specific sizes.
• You might create a rehabilitation design that forces groups to use specific actions.

Design Pipe Group (Design Groups tab) Lists the names of the design pipe groups.

Rehabilitation Group (Rehab Groups tab) Lists the names of the roughness groups.

Is Active? Select the check box for the design groups to be included
in the current design run.

Design Option Group For each design group, you can select the design option
group you want to use.

Manual Selection Forces a particular action for the selected group.

Note: You must have at least one active design or rehab group set to a valid design or rehab option group.

Compute the Design Run

After you set up your design run, click Compute to compute the results of your design.

709
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

After you have computed your design run, Solutions is added to the hydraulic model list.

Solution The list of solutions

Fitness Fitness is the overall score given a solution by Darwin

Designer. For Minimize Cost solutions, a lower fitness is
best. Otherwise, higher fitness indicates the best solution.

Total Benefit This only has a value for Maximize Benefit and Multi-
Objective Trade-off calculations. This is a score of the
calculated benefits, with a higher value indicating more
benefit in terms of improved network pressure.

Total Cost Total Cost displays the sum of rehabilitation and design
costs.

To view more information on the Solution

1. Click on one of the Solutions to view the Solution Browser.

710
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

2. Click the Solution tab to view Pipe Group Type information for Design Groups and Rehab Groups.

711
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

3. Click the Simulated Results tab to view Constraint Type information on Pressure and Flow.

712
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

The Design Groups tab in the Solutions area displays

• Design group name
• Pipe label
• Hazen-Williams C
• Diameter
• Cost.
The Rehab Groups tab in the Solutions area displays
• Rehabilitation group name
• Pipe label
• Design Rehabilitation action taken
• Cost.
The Pressure tab in the Solutions area displays information about junction pressures
• Design event name
• Element
• Required minimum pressure
• Required maximum pressure
• Simulated pressure

713
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

• Violation - any calculated pressures that fall below the minimum or above the maximum (as a negative number if
below the minimum, as a positive one if above the maximum).
The Flow tab in the Solutions area displays information about junction pressures
• Design event name
• Element
• Minimum velocity
• Maximum velocity
• Simulated Flow
• Violation - any calculated velocities that fall below the minimum or above the maximum (as a negative number if
below the minimum, as a positive one if above the maximum)

Report Viewer
You can view, print, and search reports you create about you optimization.
You can select the following options from within the Report Viewer:

Print Prints your report to an installed printer.

Copy Copies the report to the clipboard to paste into another program.

Find Searches for text in your report. Report Viewer highlights the texts as it finds it.

Single/Multiple Page Displays one of your report pages or several pages at once.

Zoom Out/Zoom In Magnifies or reduces the display of your report for better viewing.

Previous Page/Next Page Pages through your report. You can also use the <Page Up> and <Page Down> keys
on your keyboard.

Backward/Forward Navigates between pages you have just viewed.

714
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

To create a report of your solution

1. Select a Solution and in the Solution Browser select Design Groups.

2.
Click Report .
3. The Report Viewer opens.

715
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Graph Viewer Dialog Box

Using the Graph Viewer dialog box you can view the results of the water quality batch run.

716
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

The following controls are available:

Graph Tab

Allows you to export the Graph Image and/or the Graph

Data.
Export

Prints the current view in the graph display pane.

Print

Opens the Print Preview dialog box to view the current

image and change the print information.
Print Preview

717
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Graph Tab

Zooms in on a section of the graph. When the tool is

toggled on, you can zoom in on any area of the graph by
Activate/Deactivate Zoom clicking on the chart to the left of the area to be zoomed,
holding the mouse button, then dragging the mouse to the
right (or the opposite extent of the area to be magnified)
and releasing the mouse button when the area to be
zoomed has been defined. To zoom back out, click and
hold the mouse button, drag the mouse in the opposite
direction (right to left), and release the mouse button.

Zooms out so that the entire graph is displayed.

Zoom Extents

Updates the graph to reflect any changes in the underlying

data.
Refresh

Allows you to modify the graph settings. See Chart

Options Dialog Box (on page 847) for more details.
Graph Options

Displays the graph data as a series of bar charts

Bar Chart

Displays the graph data for a selected junction as a series

of pie charts. When this button is clicked a menu
Pie Charts containing the available junctions will appear, allowing
you to select the desired one.

Opens the online help.

Help

Time (VCR) Controls Evaluate plots over time. If you click Play, a vertical line
moves across the graph and the Time field increments.
Click the down arrow button next to the play button to
open the Animation Options dialog. If you click Go to
Start, the Time resets to zero and the vertical line that
marks time resets to the left edge of the Graph display. If
you click Step Backwards the time goes back one
increment. You can seelct a specific time using the time
display pulldown menu. If you click Step Forwards the
time moves forward one increment. If you click Go to
End, the Time goes to the last time step and the vertical
line that marks time resets to the right edge of the Graph
display. Change the increment of the animation time step
using the right-most menu.

718
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Graph Tab

Data Tab

Data Table 850_GraphDialog_002.bmp

The Data tab displays the data that make up the graphs. If
there is more than one item plotted, the data for each plot
is provided. You can copy and paste the data from this tab
to the clipboard for use in other applications, such as
Microsoft Excel. To select an entire column or row, click
the column or row heading. To select the entire contents
of the Data tab, click the heading cell in the top-left
corner of the tab. Use <Ctrl+C> and <Ctrl+V> to paste
your data. The column and row headings are not copied.

Export to Scenario
Use Export to Scenario to pass your results and optimized network for use in Bentley WaterGEMS V8i.
1. Expand the Solutions folder and select one of the solutions to export.

2.
Click Export to Scenario .
3. The Export Design to Scenario dialog box opens.

719
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

4. By default, Bentley WaterGEMS V8i uses the name of the design run as the name for the scenario and alternatives
you export. In order to rename the scenarios and alternatives using the same name, not the design run name, check
the Use Scenario Name for Alternatives box and type in the Export to Scenario Name field; the text boxes for the
alternatives will match what you type.

5. Select the check boxes for the items to export.

720
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

6. Click OK to export the scenarios and alternatives.

7. To view the exported scenario go to Analysis > Scenarios

8. To view the exported alternatives, click on the Alternative tab in the Scenario manager.

721
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Note: If you export a Designer solution to the scenario manager, the extra demand adjustments and boundary
(initial) conditions aren't exported (only physical properties, active topology, and capital cost alternatives can be
exported). Given this, to recreate simulation runs that are equivalent to each Design Event, it is necessary for you
to build a corresponding demand and initial alternative that reflects any additional demand adjustments and any
boundary conditions.

Schema Augmentation
The Schema Augmentation dialog box opens if the WaterGEMS CONNECT file does not contain the Darwin Designer
schema.
A schema is the series of tables and table cells that contain your data. A schema change typically means a table or table
cells have been added, usually by an update to the software.
When you use Schema Augmentation, WaterGEMS CONNECT adds any missing tables to the schema of the file you
are using. Updating a schema should not damage your data but we do recommend you create a backup. Select the
Create backup: *.bak check box to create a backup of your existing database. It will be saved in its current directory but
will have .BAK appended to the filename.
To restore the backup, delete or move your current .sqlite file and then rename your backup file by deleting the .BAK
extension, so the extension becomes only .sqlite.

Set Field Options

Right-click on the Demand Multiplier field .

You can set the value, precision, and format for the data:

722
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Scientific
Scientific numbers use the form, 1.111 E+111.
Fixed Point
Fixed point numbers use the form 111.111.
General
General format uses the most compact of either fixed-point or scientific notation
Number
Numbers use the form 1,111,111.111, where number separators are used.

Verification Summary
If you try to calculate a network using invalid Darwin Designer settings, the Designer Data Verification Summary
displays. This dialog box means that there are some invalid settings in your run that prevent Darwin Designer from
calculating your solution.

If the Designer Engine Error Message opens

• Do your groups reference elements that are inactive in your Representative Scenario? Check the scenario you are
using. Make sure your scenario uses only active pipes.
• Does your design run have an Active Design Event? It should.
• Do you have active design groups that are assigned to valid design option tables? You need at least one active
design group that corresponds to a design option table.

723
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

• Is it possible that elements have been deleted from the model from another client application? If so, close Darwin
Designer and re-open it. Darwin Designer will update itself based on the latest GEMS model, deleting any
references to deleted elements.

Manual Cost Estimating

Cost calculations are performed in WaterGEMS in Darwin Designer based on the formula:
Cost = Unit Cost x Length
for each pipe element, where the unit cost is a function of the pipe diameter. The total costs are the sum of the costs for
each element.
The user specifies the cost functions and has the option of having different cost functions for different locations (e.g.
new developments, central city, stream crossing). The user must identify which pipes are to be included in the estimate
and which pipes are assigned to each cost function.
An overview of the steps consists of:
1. Create scenario(s)
2. Start Darwin Designer
3. Create cost functions
4. Identify groups of pipe to use each function
5. Pick scenario
6. Pick pipes to be include in this cost calculation
7. Run cost calculation
The detailed steps are listed below.

Initiating Costing Runs

Unless the user wants to manually enter pipe diameters in the cost estimating run, the user should have already created
the scenarios for which the costs are to be run before entering Darwin Designer.
To develop a cost estimate for new piping, start Darwin Designer using Analysis > Darwin Designer and create a New
Design Study, if none exists, by picking New > Create Design Study above the left pane. (Users with a limited features
version of the software may not be able to use all the optimization features in Darwin Designer but will be able to use
manual cost estimating.)

Building A Cost Function

The first step is creating unit cost functions to be used in the cost estimating.
Click the Cost/Properties tab from the right pane and click the New button in the right pane to create a new cost
function. It is advisable to give each function a more useful name than the default "New Pipe-1". For example use
"congested urban area", "new subdivision," "state highway", or "open field" as cost function names.

724
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

There must be a unit cost for each diameter that is included in the cost calculation. No interpolation is done. For
example, if a 10 in. (250 mm) pipe is included in the scenario for which costs are calculated but a unit price for a 10 in.
pipe is not included in the cost function, the cost calculation will fail and an error "Unable to match at least one
scenario derived pipe diameter to the specified cost table" will appear under user notifications. To correct this, add the
unit cost for that diameter.

Identifying Elements for the Cost Calculation

To identify pipes to include in the cost calculation, click the Design Group tab and assign a name to the group. Then in
the Element ID column, create a group by clicking the ellipsis (...) button and selecting the pipes from the drawing to be
included in this group. Once done, click the green check and the list of elements appears.

725
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Each group should be created so that the individual pipes in the groups will share the same cost function.

When doing manual cost estimating, there is no need to use the tabs for Design events, Rehabilitation Groups, Design
Type or Notes.

Calculating Costs
To perform the cost calculation, select New > New Manual Cost Estimate Run from above the left pane.

726
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Then select which groups are to be included by checking "Is active" for those groups, the cost function to use for each
group, and the diameter for each group. When the boxes under Is Active? Are checked, the corresponding pipe group is
included in the cost calculation
By default, the check box labeled "Use Diameters from Representative Scenario" is checked. This means that costs are
based on the diameter from the current scenario for any pipes in the groups that are checked and the column labeled
"Manual Selection" is not used. If this box is unchecked, the user must enter the diameter in the "Manual Selection"
column in the dialog.
To perform the cost calculation, click the green Go arrow button above the left pane. When the calculation is complete,
click Close in the calculation progress dialog box and the results will appear under Solution. When the calculations are
complete, two new lines will appear in the left pane, one titled Solutions which gives the total cost summed over all
elements, and a second called Solution 1 which gives the cost of each pipe. There will only be a single solution for a
manual cost run. The Solutions display looks like the one below.

A detailed breakdown by pipes is given by picking Solution 1.

727
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Advanced Darwin Designer Tips

1. How do I consider fire flows in my design?

You may consider fire flows by one of two methods:
a. Use the demand adjustments feature in the required design event to add additional demand to the specific
junctions at which fires are to be fought.
b. In WaterGEMS CONNECT, create a child demand alternative of the demand alternative referenced by the
representative scenario, and then add the fire flows as fixed pattern flows to the appropriate junctions. Next, in
Darwin Designer, set up a design event and select the Override Scenario Demand Alternative check box, and
select the new child demand alternative you created.
Of the two methods, the second one is preferred, since, after you have exported your design from Darwin
Designer to a new scenario, you will most likely want to verify the performance of the design directly within
WaterGEMS CONNECT. If you have used method one to add fire flows, then you will have to add those fire
flows to your current (or new) demand alternative in order to simulate the design against the same demands as in

728
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

your design event. If you had used method two, however, then you would not need to create any additional
demand alternatives, since you had already done that.
2. Where should I set fire flows in my system to achieve a good design?
Fire-flow design event can be set up by using one of two methods in Question 1. To achieve a good design, you
need to ensure that a design can funcion under the most important fire-fighting scenarios. This will be different from
system to system. When you set a fire-flow design event, Darwin Designer optimizes the system capacity (pipe
sizes) to meet the additional demand requirement for the portion of a system where a fire flow is set up. The other
portion of the system may have inadequate capacity. To improve the system-wide emergency response capability, it
is recommened that fire flows are set at the outskirts of a distribution grid; this will allow Darwin Designer to
optimize the systemwide supply capacity.
3. How do I consider emergency conditions and facility outages?
Emergency conditions, such as pipe breaks and facility outages, can be handled in Darwin Designer by using the
boundary-conditions feature of a design event to close pipes that would normally be open. For example, you may
want to consider the effect of a water treatment plant being out of service. This can be achieved by adding any
connecting pipes to the design-event boundary conditions and setting their status to closed.
4. Designer only sizes or rehabilitates pipes. How can I consider the inclusion of new facilities?
Selection of new facilities may be achieved by using various modeling techniques, an example of which follows.
Selecting the location of a new tank:
a. You can select the location of a new tank modeling the new proposed tank in the representative scenario. Given
a specific tank location you will need to enter the tank elevation, diameter, and other size information as if it
existed—but, connect the tank to the system with a short small diameter pipe. Give the new pipe an obvious
label such as New Tank Connector.
The pipe that connects the tank to the system should have a length of 1 and a diameter of 0.01.
b. Create a new Design group and label it as New Tank Connector, or something similar, and add the connecting
pipe to the new group.
c. In Darwin Designer, create a new pipe option group, label it New Tank, or something similar, and add the
following data:

Diameter Cost

0 0

X Cost of Tank

Where, X is some large diameter sufficient for the expected flows to and from the tank.
d. In your local design run group, enable the new pipe group by clicking Active and select the New Tank option
group.
Darwin Designer can now connect the tank to the system and incur the cost specified in the above table, or it
will construct a 0 diameter pipe (no pipe) and the tank will not be included in the system. Note that it is up to
you to make sure that sufficient demand cases are investigated to verify the tank's design and that tank operation
is independently verified through an EPS simulation.
Using similar logic Designer could be used to consider the inclusion exclusion of pump stations, valves, water
treatment facilities, reservoirs and so on.
5. Designer keeps coming up with strange results. What am I doing wrong?

729
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

There are a number of things that could be causing you get strange or unexpected results with Darwin Designer.
Before calling technical support, please take the time to review this list to see if any of these things may apply to
you.
a. Make sure you are using the correct design data. Make sure you are using the correct representative design
scenario and that scenario includes all pipes to be sized by Darwin Designer.
b. Make sure that the representative design scenario runs successfully within WaterGEMS CONNECT . If it
does not, then Designer will not be able to function correctly.
c. Make sure that the correct demands are present. For EPS representative scenarios, make sure your patterns
are correct and that you are using the correct time from start value in your design events.
d. Make sure that you have applied the correct and necessary boundary conditions. For example, if you are
designing for a 7 a.m. peak-flow condition, make sure that you have boundary conditions specified for all
necessary tank levels, pump operation, etc. For designs that include a significant amount of new infrastructure or
completely new designs, tank levels have to be assumed tank levels.
e. Make sure that the range of pipe sizes and rehab actions you are using are reasonable. For example, make
sure that you are allowing Darwin Designer a sufficient range of pipe diameters to come up with a reasonable
design. While Darwin Designer does perform an initial feasibility check (it uses the largest pipe sizes and checks
minimum pressures), too few pipe choices may artificially restrict the flexibility of the optimization. Conversely,
too many choices may affect the convergence of the optimization on to a good solution. It doesn't make sense,
for example, to allow a rising main from a pump station to be 6 in. or 8 in.
f. Make sure that you have a reasonable number of design and/or rehab groups. As an extreme example,
consider that every pipe to be design was in the same group. Then the only possible solution that the
optimization can arrive at is to construct all of the pipes the same size. While it may still be possible to find a
feasible solution, only having a single design group will restrict the flexibility of the optimization and the ability
of Darwin Designer to find cheaper solutions. Conversely, too many design groups will hinder the convergence
of the optimization and result in sub-optimal solutions. A good number of design groups will depend on the
actual model and design situation, but would lie somewhere between 10 and 100.
g. Make sure you have sufficient and reasonable design constraints in place. The genetic algorithm
optimization engine in Darwin Designer is very powerful. If the objective of the optimization is to minimize
cost, the optimization engine will do everything in its power to minimize cost including unwanted things that
may not have been disallowed by the designer. The worst case scenario is a design with no constraints. If the
design does not have any performance requirements, then the cheapest design is no design at all.
The optimization algorithm only knows the problem that is defined for it, and to that end if you wish to get
meaningful designs from Darwin Designer, you need to constrain your designs appropriately. The idea is to set
up design constraints that corner the optimization algorithm into a region of the solution space (region of all
possible solutions) that makes the most practical sense.
Design constraints can be applied in Darwin Designer by pressures (max. and min.) and also pipe velocities
(max. and min.). An example of an impractical situation in a hydraulic model might be a 1 MG tank that is
draining at far too high a rate. In order to save costs on constructing pipes to a more distant source, the
optimization algorithm may over-use a closer water source.
Another example of a design constraint-other than the pressure and flow constraints-is the number of design
events (and hence demand/operational cases) that the design must meet. The optimal solution to a single demand
case does not fully reflect the real system operating scenarios. If a single load condition is used along with a
zero-diameter as one of possible sizes in a option group, it will most likely result in a branched network design.
Thus, it is necessary for reliability reasons to design systems for multiple demand conditions.
It is up to the engineer to recognize any impracticality of an optimized design and set up the necessary design
constraints to prevent that type of design from being feasible, thus removing that design possibility from the
grasp of the optimization algorithm.
6. How do I include a special cost, such as the cost of a highway crossing or interconnection in my design?

730
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

To do this you need to do three things:

a. • Group together the pipes that will attract the special cost. These pipes can be each in their own groups or all
in one group, but they should be grouped such that they are separate from pipes that won't attract the special
cost.
b. Create a option group (new pipe or rehabilitation option group) that includes the special cost premiums.
c. Assign the special option groups to the associated design groups locally, for the design run you wish to use with
the special costs.
7. Designer keeps coming up with pipe sizes that change up or down in size. I wouldn't construct such a
design; what can I do?
Darwin Designer applies a competent genetic algorithm to optimize the design. It does not require or have any
domain-specific knowledge about the water system, which ensures it is a generic tool, but also causes some side-
effect for some design cases-like giving up-or-down pipe sizes. In particular, the solutions are evaluated by
comparing the fitness values of solutions. Darwin Designer will assume a pipeline with pipe sizes that go up and
down (to meet required pressures as closely as possible) is better than one that has a constant size that exceeds the
pressures at some locations, since there is no specific penalty assigned to the fitness of a solution that has pipes that
change up and down in size. It is, therefore, up to you to control the eventual design and this can be done by
different means, as follows:
a. The first means is simply to make manual adjustments to a design after Darwin Designer has finished, in order
to clean up the design and make it a practical design. Cleaning up a design may technically move you away from
the cheapest design, but an inexpensive design that won't be constructed is of little use. You may find that not
much cleaning up is necessary. Quick edits to diameters or rehab actions like can be performed effectively in
Darwin Designer by using a manual design run.
b. Another thing to consider when analyzing a Darwin Designer design is whether the chosen pipe sizes are a
function of the lengths of pipe in your model.
To better illustrate this concept, consider a run of four pipes in series, each with different lengths. For these four
pipes, the controlling pressure is the downstream-most junction, and all intermediate junctions are well above
the required pressure. Now, after Darwin Designer finishes designing the run of pipe, it selects the first pipe as a
16 in., the second as 12 in., the third as 16 in. and the fourth as 12 in. It is unlikely that this design would be
constructed as-is, but if the pipes themselves represented sufficient length of pipe, then it may be practical to
construct a portion of the pipeline as 16 in. and a portion as 12 in. If this is the case, then you need to look at the
model to determine why Darwin Designer is changing the third pipe back up to 16 in. It may be that since the
downstream-most junction is the only controlling node, that Darwin Designer is merely trying to achieve the
right head-loss in the total pipe length, by choosing the length of pipe that should be 16 in. and the length that
should be 12 in. Of course, it is still constrained by the individual pipe lengths in the model, but if they are
different, the optimization algorithm will use this fact to its advantage. In this case, it may very well be that
Designer is saying construct a total of 1500 ft. of 16-in. and 1000 ft. of 12-in. pipe, and not necessarily 850 feet
of 16-in., 600 feet of 12-in., 650 feet of 16-in., and 400 feet of 12-in. pipe in sections. Use engineering judgment
when analyzing the results.
c. Another means of achieving more constructible designs from Darwin Designer is to group in the same group
pipes that would be constructed the same size. For example, a rising main would most likely be constructed a
single size, and it would thus make sense to include all the model pipes that make up the rising main in the same
design group. What you don't want to do by grouping pipes is artificially design the system even before you
have had a chance to optimize it.
8. When sizing new pipes, Darwin Designer can choose a zero-size, which means, do not construct that pipe.
Is it possible to do a similar thing for rehabilitation actions?
It is possible to do the same thing for rehabilitation actions. To create a rehabilitation action that represents a Do
Nothing option, simply follow these steps:

731
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

a. Create a pre-rehab diameter versus post-rehab diameter function that defines at least two diameters that cover
the domain of diameters in your model. For example, mi.n pipe size through max. pipe size and make the pre-
rehab diameter the same as the post-rehab diameter. This function will define that the diameter of any single
pipe remains the same before and after the rehab action.
b. Create a diameter versus unit cost function that defines at least two diameters that cover the domain of diameters
in your model. E.g., min. pipe size through max. pipe size and make the cost for each diameter zero. This
function will thus define that the cost for the rehab action, regardless of pipe size is zero.
c. Create a pre-rehab diameter versus post-rehab roughness function that defines at least two diameters that cover
the domain of diameters in your model. E.g., min. pipe size through max. pipe size and make the post-rehab
roughness, the roughness of the current pipes to which the Do Nothing option will be an option. This function
will thus define that the resulting roughness stays the same as the original values.
Create a Do Nothing rehab action that references each of the above functions. If selected by Designer, the Do
Nothing action will leave the same diameter, cost nothing, and leave the same roughness: in effect, doing
nothing.
9. Do I have to change the parameters or can I simply use the defaults?
In most circumstances it is not necessary to change the parameters in order to run Darwin Designer, however, you
may wish to modify certain values as follows:
a. Random Seed-The Darwin Designer optimization algorithm depends on the generation of pseudo-random
numbers through a random number generator. The reason the numbers are pseudo-random is that they are
generated by a mathematical formula, and hence the resulting series of numbers is not actually random at all. In
order to make the random numbers different the random number algorithm is initialized with what is known as a
seed. For a different seed value, a different series of pseudo-random numbers will be produced. When no
parameters in the Designer optimization problem change (i.e., no changes at all, including hydraulic model
changes, constraint changes, etc.), running Darwin Designer twice will result in exactly the same result. Darwin
Designer results are therefore repeatable in this way. One way of ensuring a different result (or at least a
different progression to the same result) is by changing the random number seed. Doing this will result in
different optimization results for different runs. By the nature of genetic algorithm optimization, you should not
just accept the result of a single optimization run, but run several runs and make sure that all runs produce
similar results. An easy way to run multiple runs and achieve different results is to change the random number
seed.
b. Penalty Factor-Penalty factor is a weighting that is used in the determination of the fitness value for an hydraulic
solution. In particular the penalty factor is used to discourage the survival of designs that fail the design
constraints. A higher value for penalty factor will put designs that fail the design constraints in greater disfavor,
where as a lower value for penalty factor will place designs that fail the design constraints in less disfavor. A
reasonable default for penalty factor has already been selected for you. However, if you find that Darwin
Designer keeps settling on designs that contain constraint violation, then you may wish to increase the penalty
factor value.
c. Probabilities, Era Numbers, and Population Size-Good defaults have already been selected for you for these
values, but instead of changing the random number seed when conducting multiple optimization runs of the
same design, you may want to change these values. Good ranges for the values are therefore listed below for
your convenience.

Note: The upper limit values for population size, maximum era number, and era generation number are
problem-dependent. For larger design models, you should use greater values than for smaller models.

Population Size: 40 to 200

Cut Probability: 0.5 to 2.5%
Splice Probability: 50 to 80%

732
WaterGEMS CONNECT Edition Help
Optimizing Capital Improvement Plans with Darwin Designer

Mutation Probability: 0.5 to 2%

Maximum Era Number: 4 to 10
Era Generation Number: 50 to 200
10. Is there a way to select design and rehab group pipes from the model drawing?
You cannot select pipes directly from the drawing in this first release of Darwin Designer. For this reason, we
recommend you identify pipe groups and create appropriately-named selection sets before starting Darwin
Designer. When you have defined the necessary selection sets, they can be used directly within Darwin Designer.
Selection sets can also be used to define pressure and flow constraints, and to select boundary condition elements.
11. Darwin Designer cannot find a feasible solution. How do I work out what is going wrong?
It is very likely that in using Darwin Designer, you will encounter situations where Darwin Designer cannot find a
feasible solution. This happens even to those experienced in genetic-algorithm optimization and is due to the fact
that the determination of which designs are feasible and which aren't is assessed by a computer subject to the
information you tell it. That is, the rules are applied, with no exceptions.
For example, if you want a minimum of 20 psi across the board, Darwin Designer will determine as infeasible any
solution that does not have 20 psi at every junction. If you have a couple of junctions that are part of the detail of a
tank inlet valving, for example, then maybe you don't really require 20 psi at those junctions. Perhaps what you
really mean is that you want 20 psi at all service junctions. In that case, you'll find where an engineer would have
said the design is feasible (because the design only fails the 20 psi requirement at non-service junctions), but
Darwin Designer is unable to make that determination, since it was told 20 psi was required at all junctions. The
process by which you can get around these kinds of issues is simply to identify them, correct them, and then re-run
the optimization. For the case of the 20 psi junction example, the fix might be to create a selection set (in
WaterGEMS CONNECT ) of the junctions that are service junctions, and only use those junctions as pressure
constraint junctions. (The selection set can be selected from within Darwin Designer.)
Along these same lines, you may also want to consider if any of the following things might be causing trouble,
before calling technical support:
a. Check for constraint violations in the results. Check both pressure and flow constraints for the presence of
constraint violations. If any violations exist, you will need to determine why the junctions and/or pipes at which
the violations occur are problematic. Maybe a minimum pressure constraint is simply impossible to meet due to
the junction elevation, etc. Other things to check for are the applicability of blanket minimum and maximum
pressures and velocities to modeling elements in detail models of pump stations, and the like. If you find
anything, then you need either to change the model, or modify/remove the offending constraint and run the
optimization again.
b. Make sure you have sufficient design options for a feasible design. That is, make sure that you have a sufficient
range of pipe sizes and/or rehabilitation actions available to Darwin Designer to find a valid design.
c. Make sure that you haven't specified competing design events. While it may be possible to meet one design
event or another separately, it may be impossible to meet two together if they compete with each other. For
example, one design event might specify that a minimum pressure is required, and as such the corresponding
pipe taking the flow to that location needs to be large, however, in the next design event with similar demands, a
minimum velocity constraint means the pipe has to be sized smaller. It may be impossible to meet both design
events with the single pipe size. To test this, build runs up by performing initially with only one design event,
then adding more in. If all of a sudden after adding in a design event no more feasible solutions can be found,
then you can try to work out what in the most recently added design event is causing the problem.
d. For multi-objective and maximum benefit optimizations, make sure you have sufficient budget specified. It may
just be that you have not given Darwin Designer sufficient budget to allow a feasible design to be found. Try
increasing the budget.
For more information, see Designer keeps coming up with strange results. What am I doing wrong? (on page 728).

733
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

Optimizing Pump Operations

Energy Management and Scenario Energy Cost Calculations

There are two levels at which energy costs can be analyzed in WaterGEMS. The tool called Scenario Energy Costs
calculates energy use and cost for a single scenario while Energy Management uses the results of multiple Energy Cost
scenarios to determine energy costs at a higher level of aggregation to determine the energy cost for pump stations (not
just pump-by-pump) for multiple scenarios that can occur over a billing period and determine economic costs such as
net present worth of pumping energy.
The scenario energy cost analysis determines the energy cost by pump for all pumps selected by the user. Pricing for
energy cost is set up in the Pricing button in energy costing. Price functions are assigned to individual pumps in energy
costing. See Scneario Energy Cost for detailed steps in running Energy Costs.
For users interested in a more complete energy analysis, running a single scenario may not be sufficient as block rate
charges must be determined based on energy use over a complete billing cycle which may contain low, average and
high water use periods which should be modeled as separate scenarios. In addition, the scenario corresponding to the
setting of a peak demand charge is usually not an average day but some kind of peak condition that should be modeled
in a separate scenario. In order to deal with the complexities of block rates, multiple scenarios, aggregation of pumps
within a station, and performing present worth calculation, the user needs to use the Energy Management analysis. Such
calculations are usually required because of complex tariffs for electric power.
An important concept in energy management analysis is that of a "Power meter". A Power Meter is the basic unit that is
billed by an electric utility. A Power Meter usually corresponds to a pump station. However, in WaterGEMS, a pump
station is a collection of pumps serving a single pressure zone. Therefore, if a pump station building has a single
electric service but has a set of Low, Medium and High service pumps, for WaterGEMS hydraulic calculations, it is
three Pump Station elements but for energy management, it corresponds to a single Power Meter. The figure below
shows how a single power meter can include multiple pumps and pump stations in a single building.

734
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

Because there may be other energy uses at the pump station besides pumping, the user can specify non-pumping energy
costs to account four uses such as lighting, HVAC, control systems, chemical feed equipment, etc. These costs are
added in on a Power Meter basis. There may also be charges on the power bill that are not associated with individual
pumping operations such as taxes, discounts, lump sum surcharges, etc. These can be added in to the overall cost and
are referred to as "other costs".
The usual work flow for using the energy cost and energy management analyses may be followed as shown below:
• Develop EPS scenarios to be used in energy cost
• Run scenarios
• Start scenario energy cost analysis
• Create price functions and optional carbon emission factors
• Assign price functions to pumps
• Run energy cost for each scenario of interest
• If more thorough analysis is desired, close scenario energy cost analysis and start energy management
• Create new energy management study
• Identify which pump stations/pumps are associated with each power meter
• Specify the mix of scenarios to be analyzed
• Identify interest rate and number of periods if present worth calculations needed
• Compute study
• Review results and rerun or create new studies
The energy manager analysis provides a way to combine the energy use and peak demands from multiple scenarios and
multiple pumps associated with a power meter to display energy and peak demand cost based on pump, pump station,
power meter, scenario or system wide. See Energy Management for detailed steps. Values reported in Energy
Management Analysis are aggregated over time. To view time series energy use, it is necessary to use the Scenario
Energy Cost Analysis.

735
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

Energy Management

To start Energy Management Analysis, the user selects Analysis > Energy Management or picks the button. The
first time the user enters the energy manager for a hydraulic model, the Welcome dialog appears.

To create an energy management study, the user picks the New button .
Once a study has been created, the buttons on top of the left pane enable the user to
• New - create a new study
• Delete - delete an existing study
•
Rename - change the name of a study
•
Compute - run the energy calculations for a study
•
Report - enter the report manager
•
Power Meter - opens dialog for the user to associate pumps and pump stations with power meter and override
some values from the scenario energy cost analysis
•
Help - opens energy management help
The right pane of the energy management dialog contains four tabs. The function of each is described below.
The Options tab is shown below.

736
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

The bottom portion Options tab is the place where the user selects which scenarios are to be included in the analysis,
the percent of the billing period that is represented by each scenario (ideally the values would add to 100%), whether
the energy management analysis should rerun the scenario (check) or use the results from the last computed scenario
(unchecked) and which scenarios should be considered when determining peak demand costs. It is assumed that the
time period over which the energy use is calculated is the same as the model time step. If the peak demand is based on
the peak 15 minutes, the model time step (at least for that scenario should be 15 minutes).
If a scenario is included in the list but is later deleted from the model, a fatal error message will be given unless the
scenario is also deleted from the Options tab list.
When the user picks the Scenario button in the bottom portion of the right pane, the following dialog appears where the
user picks the scenarios to be included in the calculation. Only EPS scenarios can be used. At least one scenario must
be selected.

If the user un-checks "Include in cost calculation", that scenario is not used in the calculation but the scenario name is
not removed from the list.
In the top portion of the right pane, the user specifies the length of the billing period over which the energy costs are to
be aggregated. For example, if the billing period is 30 days, the user should specify 720 hours or 30 days.
Once the energy management analysis calculates the annual energy cost, the user can also determine the net present
worth of energy cost. For this calculation, the user must check the box "Calculate Net Present Value" and enter the
interest rate and number of periods. The Billing period must be greater than 0, interest rate should be between 0 and
100% and the number of periods must be greater than zero.

737
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

In the Power Meter tab for this study, the user can select which pumps or pump stations are to be included in the
analysis and whether the energy price and the energy pricing to be used. The energy price selected can be different than
that used in the scenario energy cost analysis. A warning will be issued if it is. At least one power meter must be
selected or a fatal error message will be issued.

If no Power Meters have been created, the user must first pick the Power Meter button (not to be confused with the
Power Meter tab) on top of the left pane. This opens the Power meter dialog where the user associates pumps and pump
stations with the power meter serving them. The user should either select individual pumps or the pump station in
which the pump is located. If a pump is both selected individually and the pump station it is located in is selected, then
it is not double counted but treated as if it is part of the pump station.

Note: Energy Management only uses the billing period set in the Options tab of the study and does not consider
the period entered in the energy pricing.

Power Meters
This dialog allows you to associates pumps and pump stations with the power meter serving them.

738
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

The dialog consists of a list pane on the left that displays all of the power meters associated with the hydraulic model
and a tabbed section on the right that allows you to assign pumps and other energy costs to the power meter(s).

New: Creates a new power meter.

Delete: Removes currently selected power meter.

Duplicate: Creates a copy of the currently selected power meter.

Rename: Enter a new name for the currently selected power meter.

739
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

After creating a power meter, click Select From Drawing

to assign a pump/pump station to it in the Pumps Tab. Click Delete

to remove the currently highlighted pump from the list. Click Select In Drawing

to select the pump in the drawing view.

The Non-Pumping Energy tab allows you to specify additional energy costs. Enter a base power usage value and then
assign a pattern that will be applied to it.
You can enter informational notes in the Notes tab.

Scenario Energy Cost Manager

The Scenario Energy Cost Manager is used to set up energy cost calculations. To calculate energy costs, the following
information must be supplied:
• Specify the pumps, variable speed pump batteries, and turbines that are to be included in the energy cost
calculations.
• Specify energy costs in the Energy Pricing Manager.
To access the Scenario Energy Cost manager, click the Analysis > Energy Costs command, or click the Energy Costs

button .

740
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

The left pane consists of a tree view that contains the name of the base scenario when it is first opened. Click the
scenario icon to activate controls in the right side of the dialog that will allow you to specify the elements that will be
used in the energy cost calculations.

Use the Compute button to calculate the energy costs based on the information set in the Energy Pricing Manager

(accessed by using the Energy Pricing button for the currently selected scenario; select the scenario to use with the
Scenario pull-down menu).
Before performing energy cost calculations, it is necessary to have run an extended period simulation for the scenario
of interest.
If price of energy is not entered, the scenario energy cost calculations will calculate energy use but now cost.
After energy costs have been computed, the tree view will also contain icons for Pump/Turbine Usage, Storage, and
Peak Demand details. Click on an icon to highlight it and view the associated results in the pane on the right.
To specify the elements that will be considered in the calculation
1. Highlight the scenario icon in the tree view.
2. Click the Pumps tab. All of the pumps in the model are listed in the table. By default, all of the pumps in the model
are included in the energy cost calculations. To disregard a pump during the calculation, clear the Include in Energy
Calculation? check box associated with it.
3. Assign Energy Pricing to each pump that will be included in the calculation. Choose an energy price definition for
each pump from the list in the Energy Pricing column. If no energy price definitions have been defined, click the
ellipsis button to open the Energy Pricing Manager. See the Energy Pricing Manager topic (on page 7) for more
details on creating a new energy pricing definition.
4. Click the Tanks tab. All of the tanks in the model are listed in the table. By default, all of the tanks in the model are
included in the energy cost calculations. To disregard a tank during the calculation, clear the Include in Energy
Calculation? check box associated with it.

741
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

5. If there are VSPB (variable speed pump battery) elements in your model, follow the instructions for Pumps above to
specify which VSPBs are to be included in the calculation and to assign energy pricing definitions to them.
6. If there are Turbine elements in your model, follow the instructions for Pumps above to specify which Turbines are
to be included in the calculation and to assign energy pricing definitions to them. Since turbines generate power, the
results for turbines will be negative numbers.

Note: VSPBs are not included in the pump station calculations.

Energy Pricing Manager

To convert energy use into energy cost, the user must enter the applicable energy price tariff. This is done by picking

the second button above the left pane in the Scenario Energy Cost dialog . This opens the energy pricing dialog.
The left pane provides away for the user a way to create or delete any number of energy price functions (tariffs). Pick
New to begin creating a new tariff in the right pane.

There are two general types of changes for energy: energy cost which depends on the kilowatt hours used (top part of
right pane) and peak demand charges based on the peak kilowatts used (bottom part of right pane).
The tariff type refers to whether the energy tariff:
1. Constant - no variation over time and non-block rate
2. Time of day - energy price varies with time of day
3. Block rate - energy price depends on total energy consumed during billing period

742
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

4. Block rate based on billing demand - energy price depends on total energy consumed and the break point between
the blocks depends on "billing demand" which is the peak energy use

Note: In Storm/Sewer, only Constant and Time of Day Tariff Types are available.

Once the type of tariff has been selected, the data entry table corresponding to that type of tariff is displayed in the
middle of the right pane. For constant price, there is a single value that must be entered. For the others, there is tabular
data entry for the energy price as a function of the parameter that defines the block or the time period.
The bottom part of right pane enables the user to enter a description of any peak demand charges if they apply to this
study by checking the box labeled Include Peak Demand Charge. The user enters the charge in cost units per peak
demand kilowatts. The peak demand is usually taken as the peak demand over some time period and for the calculation,
it is assumed that the model time step corresponds to this time period. The billing period can be entered so that this cost
can be averaged and included in daily cost (but not usage cost).
In some cases, there may be different demand charges for different times of day. The user can enter this type of tariff by
picking Use Multiple Peak Charges for Energy Management. This will open the dialog below where the user can enter
the time of day peak charges either as a function of clock time or simulation time.

In some cases, power is purchased from multiple energy providers each with very different tariffs. For example, energy
may be purchased for an energy generation company while distribution is provided by a different company. If the
tariffs are similar, then the unit prices can be added. However, if they are very different, the user should set up one tariff
for each supplier and run each cost calculation separately.

Unit Carbon Emissions Dialog Box

This dialog allows you to define the amount of carbon emissions per unit of energy usage.

743
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

The dialog consists of a pane listing the Unit Carbon Emissions definitions and the the following controls:

Creates a new Unit Carbon Emissions definition, allowing

you to define a new Carbon Dioxide Emission Factor.
New

Deletes the Unit Carbon Emission definition that is

currently highlighted in the list pane.
Delete

Renames the Unit Carbon Emission definition that is

currently highlighted in the list pane.
Rename

Wehn you highlight a Unit Carbon Emission definition in the list pane, you can edit the Carbon Dioxide Emission
Factor associated with that definition.

Scenario Energy Cost Analysis Calculations

To run the scenario energy cost calculation:
1. Select the scenario name from the menu. The hydraulic calculations for this scenario must already have been run
and the scenario must use EPS hydraulics.
2. Select the price function to use for each pump. If this is not specified you will see a warning message.
3.
Click Compute to run the calculation.

Energy Cost Results

After a successful energy cost calculation, the following summary table is presented:

744
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

The summary tab of the scenario node shows a tabular table with the following results:
• Energy - total energy used during EPS scenario (in all calculations turbine energy generation appears as a negative
value).
• Energy Cost - the total cost of energy during the scenario.
• Storage Cost - the net cost of energy in water entered or removed from storage.
• Daily Cost - the total energy cost divided by the duration of the scenario in days.
• Volume - the total volume of water that passes through pumps or turbines during a scenario.
• Unit Energy Use - the energy required to pump a given volume of water (also known as specific pumping energy).
• Unit Energy Cost - the cost of energy required to pump a given volume of water.
• Peak Demand Cost - the cost for power used during the peak time step during the scenario.
• Carbon Emission - the total carbon emission during the scenario.
• Run Duration - the duration of the Energy Cost Scenario.
After a successful energy cost calculation, the following results summaries appear in the tree view:
Pump/Tubine Usage
The most important results in the Pump Usage summary are Total Energy Use Cost and Average Efficiency, either
pump or wire-to-water.

745
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

There are tabs for Pumps, Variable Speed Pump Batteries, and Turbines showing summary results for each pump,
VSPB, and turbine included in the scenario energy cost calculation.
Pump Time Details
The Pump Time Details summary gives the energy usage study summed up over all the selected elements. These results
can also be copied to the clipboard or displayed in a report using the Copy and Report buttons above the table.

Some values in the table are instantaneous values at that time and others are incremental values from that time to the
next time. For example:

746
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

The value of 1309 for discharge is the instantaneous value at time 0, while the incremental volume pumped is the
volume pump from the previous time step until time equals 0. At time 3, the instantaneous value for flow is 1343 gpm
but the value for Incremental volume pumped is the volume pumped between times 2 and 3, which is
(1341*60/106)=0.08. Incremental values at time t(i) are the value between t(i-1) and t(i). Attributes such as wire power,
efficiency, and cumulative energy used are instantaneous values corresponding to t(i).
You can also view the results in graph form by clicking on the Graph tab.

You can copy the graph to the clipboard for use in other software and you can open the Graph Editor to change the
appearance of the graph. (See Tee Chart editor for more information.)
If you change the default settings for the Graph Manager, they are applied to all graphs as long as you remain in the
Energy Cost Manager. Once you close the energy cost manager, the graph manager goes back to the default settings.
Pump Results
Below Time Details icon is a Pumps folder containing an icon for each individual pump. Clicking one of these pump
icons will display results for that pump. It includes the information that is in the time details report, except it only
includes results for one pump at a time. An additional column is shown for pump speed.

747
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

You can also view the results in graph form by clicking on the Graph tab.
You can copy the graph to the clipboard for use in other software and you can open the Graph Editor to change the
appearance of the graph. (See Tee Chart editor for more information.)
If you change the default settings for the Graph manager, they are applied to all graphs as long as you remain in the
Energy Cost manager. Once you close the Energy Cost manager, the Graph manager goes back to the default settings.
If the model contains variable speed pump batteries below the Pump Time Details icon another folder VSPBs is shown
with results similar to the Pump Results.
For models with turbines below the folder Pump/Turbine Usage an additional folder Turbine Time Details with the
summary results for all turbines is shown.

Similar to the Pump Time Details these result values can be graphed, displayed in a report or copied to the clipboard.

748
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

Below this folder for every turbine the detailed energy calculation results are shown.

Storage
The values displayed in the storage table show the value of energy that is used by draining water from a tank or gained
by storing water in a tank.

These results can also be copied to the clipboard or displayed in a report using the Copy and Report buttons above the
table.
Peak Demands
The results in the Peak Demands table are used to determine the cost for capacity/demand/peaking charges that are
based on peak energy use. These costs are usually applied to the energy cost as a lump sum each billing period. The

749
WaterGEMS CONNECT Edition Help
Optimizing Pump Operations

table also divides the cost by the length of the billing period to determine the daily cost so that it can be added to the
energy costs. Peak demand charges are usually set on a peak water use day or a day with a special event, such as a fire
or large main break. Demand charges are not set on an average day.
These results can also be copied to the clipboard or displayed in a resort using the Copy and Report buttons above the
table.

Comparing Cost Results Across Scenarios

Within the Energy Cost manager, it is only possible to view graphs that apply to a single scenario at a time. In order to
view a comparison of energy results for a single pump between multiple scenarios, it is necessary to use the Graph
manager. It can be accessed when you right-click the pump and select the energy related fields and scenarios to graph
in the Graph manager.

Energy Cost Alternative

The Energy Cost Alternative Manager is where the user can select the elements to be included in the energy cost
analysis. The energy cost alternative is used when it is necessary to perform multiple energy analyses with alternative
pricing or for pumping stations in different parts of the system.
All pumps, tanks, variable speed pump batteries, and turbines are included in the analysis by default. However, you can
override this by unchecking the box labeled Include in Energy Calculation?
You can also set which energy price functions to use with each element. This function can also be done within the
Energy Cost manager.

750
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

The following buttons are available:

Selection Set: Opens a submenu containing the following options:

• Create Selection Set—Allows you to create a new selection set.
• Add to Selection Set—Adds all of the elements in the current tab of the alternative to a previously created selection
set that you specify.
• Remove from Selection Set——Removes all of the elements in the current tab of the alternative from a previously
created selection set that you specify.

Select in Drawing: Opens a submenu containing the following options:

• Select in Drawing—Selects the elements in the current tab of the alternative in the drawing pane.
• Add to Current Selection—Adds all of the elements in the current tab of the alternative to the group of elements that
are currently selected in the Drawing Pane.
• Remove from Current Selection—Removes the elements in the current tab of the alternative from the group of
elements that are currently selected in the Drawing Pane.
• Select Within Current Selection—Selects the element or elements that are both in the current tab of the alternative
and are already selected in the Drawing Pane.

Report: Generates a report containing the data within the current alternative.

Help: Opens the online help.

Optimizing Pump Schedules Using Darwin Scheduler

Darwin Scheduler is a state of the art tool for optimizing pump operation that works by using genetic algorithm
optimization to control nominated pumps during an extended period simulation (EPS). The genetic algorithm
optimization technique works by evolving near optimal solutions over generations of trial solutions. To reach an
optimal solution it is normally expected to have to evaluate tens of thousands of solutions, sometimes more. One

751
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

problem with this fact is that EPS simulations can be time consuming, especially for larger or more complicated
models, and therefore run times for Darwin Scheduler can be correspondingly long. These best practices and tips offer
suggestions and recommendations for using Darwin Scheduler in order to get the best performance and results out of
the tool.

Best Practices and Tips

Minimize the solution space

In optimization problems one is looking for an optimal or near optimal solution from a set of possible input values. For
problems with a low complexity the total number of possible permutations of valid input may be able to be completely
enumerated. Consider a steady state problem where 2 pumps can be either on or off. If we represent the on state with
the number 1 and the off state with the number 0, using the following notation (1, 1) we indicate that both pumps are
on. One trial solution in such a problem is (1, 0). Clearly there are 4 possible permutations in this problem, the other
three being (0, 1), (0, 0) and (1, 1). The set of all possible permutations of input is known as the solution space. Even if
a single permutation of input or trial solution took an hour to evaluate, the entire solution space could be enumerated in
4 hours, making it practical to do so provided that the optimal solution is not required to be known in less than that
time. The solution space for this 2 pump problem is size 2^2 or 4. The solution space for an equivalent 10 pump
problem is 2^10 or 1,024. What is not immediately obvious, however, is that the size of the solution space in
optimization problems can quickly grow to mind boggling sizes.
For example, let us consider a pump schedule optimization problem with 10 pumps and an EPS of 24 hours duration
with a hydraulic time step of 1 hour. In addition to this, let's assume the pumps are optimized as variable speed with
possible settings of 0.8, 0.85, 0.9, 0.95 and 1.0. Assuming the pumps are all optimized for the entire duration of the EPS
(time 0 to time 24 hours) then there are 10 x 24 = 240 speed decisions to be made for each trial solution, and each of
those decisions can take on one of 5 different values. Even for this modest sounding optimization problem the size of
the solution space is thus 5^240 or 5.65 x 10^167! Now let's assume that we can easily write off 99.99% of solutions as
not practical or plain non-sense, then that leaves just 5.65 x 10^163 solutions for us to investigate. If we could evaluate
one million trial solutions every second, it would still take 1.79 x 10^150 years to evaluate them all! One public
estimate of the number of atoms in the entire observable universe is 10^80, which is virtually zero when compared to
1.79 x 10^150, so quite clearly we are talking about numbers that are so large they are difficult if not impossible to
comprehend. A small increase in complexity of the problem magnifies the total number of possible solutions greatly.
Conversely a small decrease in problem complexity reduces the total number of possible solutions greatly. It is
therefore a very good idea to consider the following when setting up a pump scheduling optimization problem.
• Number of pumps being optimized; keep the number of pumps being considered to the minimum possible, to the
point of considering optimizing different pump stations independently if that is a reasonable thing to do
hydraulically in the system being optimized.
• Number of pump speed choices; keep the number of possible speed choices (including off setting) to the minimum
possible. Consider optimizing with course speed settings to find a rough solution to the optimization problem and
follow that up with an optimization that uses refined speed settings (finer, but narrower range) as a follow up
optimization to the first.
• Schedule control interval (EPS hydraulic time step); consider using a course hydraulic time step such as 2 or even 3
hours at least for initial optimization runs as this greatly reduces the size of the solution space, especially if multiple
pumps are being optimized.
• Schedule duration; consider optimizing the shortest EPS duration possible. A 24 hour duration seems to be the most
reasonable choice in terms of being able to produce a repeatable schedule, whilst keeping the solution space as
small as possible.
The following table shows the size of the solution space given different numbers of pumps being optimized (Pump
Count), numbers of speed choices per pump (Speed Choices) and EPS time step. It is very evident the effect that

752
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

increasing the number of pumps being optimized, the number of speed choices or the granularity of the EPS time step
each have an exponential effect on the size of the solution space, and thus inevitably reduce the effectiveness of the
optimization. When running an optimization it is wise to start out conservatively and only increase the optimization
complexity to refine optimization results.
Table 14-1: The effect on optimization solution space of number of pumps to optimize, number of speed choices and
EPS time step (control interval).

Pump Speed Solution Space (1 hour Solution Space (2 hour Solution Space (3 hour
Count Choices time step) time step) time step)

1 6 4.7E+18 2.2E+09 1.7E+06

1 12 7.9E+25 8.9E+12 4.3E+08

1 18 1.3E+30 1.2E+15 1.1E+10

2 6 2.2E+37 4.7E+18 2.8E+12

2 12 6.3E+51 7.9E+25 1.8E+17

2 18 1.8E+60 1.3E+30 1.2E+20

3 6 1.1E+56 1.0E+28 4.7E+18

3 12 5.0E+77 7.1E+38 7.9E+25

3 18 2.4E+90 1.5E+45 1.3E+30

4 6 5.0E+74 2.2E+37 8.0E+24

4 12 4.0E+103 6.3E+51 3.4E+34

4 18 3.2E+120 1.8E+60 1.5E+40

Minimize the trial solution time

In our discussion of minimizing the solution space we consider the time required to enumerate the top 0.001% of trial
solutions by assuming that we can evaluate one million trials per second. Clearly this figure is un-realistic even on
today's fastest computers and for the most trivial of hydraulic models, so it's clear that the time the model takes to solve
is a significant contributor to the total time required to run Darwin Scheduler. Any improvement that can be made to
the run-time of the base EPS simulation all the better for the Darwin Scheduler optimized run time. Methods to reduce
run time that should be considered include:
1. Model size: The more hydraulic elements in a model the larger the solution matrix that needs to be solved and the
longer the run-time of the solution. It is unrealistic to expect to be able to use Darwin Scheduler on a 50,000 pipe
model in a few minutes if a single EPS run for such a model takes a few minutes. Strongly consider using a version
or copy of the subject model that is customized for the purpose of pumping optimization. Such a model might be
smaller due to excluding elements or zones etc not required for the energy optimization or it may be smaller due to
skeletonization (removal) of hydraulic elements not required to be considered in the energy optimization. In fact a
skeletonized model is highly recommended for pump schedule optimization, particularly if the model is
skeletonized whilst maintaining hydraulic equivalence such as is able to be performed using Skelebrator
Skeletonizer. The benefit of the smaller model and quicker run time will greatly outweigh any potential or
perceived side effect (if any at all) of the skeltonization process.

753
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

2. Model complexity: The larger the model or more complex the model (e.g., complicated control regimes) the longer
an EPS simulation will take to run due to the need to simulate additional intermediate time steps (such as times
when control rules fire). Consider removing any redundant model complexity that may not be required for a pump
operation simulation.
3. Model balance: Even a small model may take a long time to run if it is not well balanced. Examine the number of
trials the model takes to solve at each time step and if it is found that it is consistently high (25-100+) then there
may be time to be saved by improving this situation. A high number of trials may be indicative of a number of
different symptoms such as bade control valve settings or too narrow control ranges.
Use a faster computer
These days most computers are reasonably fast, however, time is money in which case a faster computer can save both
time and money. The Darwin Scheduler optimization process is computationally expensive and as such a computer
with a faster CPU will produce faster results. Multi-core machines will also benefit from increased overall performance.
Carefully consider hydraulic constraints
If certain hydraulic constraints are required to be met it is a good idea to consider these carefully and only add the
constraints that are essential as opposed to adding blanket constraints. Adding blanket constraints, especially for large
models, is discouraged since blanket constraints are more likely to contain impossible to meet constraints (such as
pressure constraints on a junction that is suction side of a pump) and will also have a slight effect on performance
(constraints have to be evaluated for every trial solution) and increase Darwin Scheduler's output file size
unnecessarily. For this reason Darwin Scheduler is designed to require the user to add constraints manually.
Ensure runs are set up properly
Even for a small well balanced model run times for Darwin Scheduler will be proportional to the time a single EPS
takes to run, multiplied by the number of trials required to find a near optimal solution. It is therefore a good idea to
ensure that a run is progressing in an acceptable fashion in its early stages (generation 50 - 200) before leaving it to run
for the remainder of the optimization. Be sure to leverage Darwin Scheduler's resume feature that allows one to stop a
run, review the results (even export the solution) and then continue the run so long as no other runs have been started or
no other hydraulic computation has been performed.
Plan to use the tool efficiently
One good thing about computers is that they don't need to sleep like people do. When working with larger models that
may require a longer run time consider running shorter debugging optimization runs during the day, making necessary
adjustments and the like, and then running the "real" runs during a lunch break or perhaps even over-night.
Allow runs sufficient time to complete
One characteristic of genetic algorithm optimization is the need for heuristic stopping criteria. In Darwin Scheduler
several different criteria are available depending on the type of genetic algorithm selected. There is, however, no
definitive way to determine when a run should be stopped. Running just one more generation may yield a better
solution than previously found. Generally speaking, however, optimization runs should be allowed to run for at least
500 generations (preferably longer) which, depending on population size, can mean the order of 100,000+ trials. Please
be patient!
Plan to do multiple runs
The nature of genetic algorithm optimization is such that there is a random component to the algorithm. The algorithm
is driven by computationally efficient search processes; however, at the core of the algorithm random numbers are used
to drive processes such as mutation, for example. Therefore, two optimization runs that are otherwise identical except
for one minor change (e.g., larger population size or different random seed) will in all likelihood produce different
optimized solutions. This is more likely to be the case the larger the solution space of the problem. It is therefore a good
idea to run multiple optimization runs changing nothing other than one or more genetic algorithm parameters (or simply
just the random seed) to ensure that the best optimized solution is really the best that can be achieved. One beneficial

754
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

characteristic of genetic algorithm optimization is its ability to find solutions that my be very close in terms of
hydraulic performance, but may be themselves quite different. Engineers are therefore able to discriminate between
optimized solutions based on other perhaps non hydraulic criteria.
You can also leverage an existing solution (such as the representative scenario, assuming it meets constraints) to create
a Baseline Seed for scheduler to use. Export the results of a Scheduler run to a new scenario, then calculate an EPS run
for the new scenario. Use this scenario as Scheduler's representative scenario to seed a new Scheduler run.

Darwin Scheduler

Darwin Scheduler allows you to optimize pump operations. By using genetic algorithm optimization to control
nominated pumps during an extended period simulation (EPS), it avoids a manual trial and error approach to finding
the most efficient operating schedule. Solutions and costs calculated using Darwin Scheduler can be exported back to
the selected scenario.

The dialog consists of:

A toolbar.
A list pane that displays all of the Scheduler Studies Optimized Runs, and Solutions.
The toolbar consists of the following controls:
•
New: Opens a submenu containing the following commands:
• New Scheduler Study: Creates a new Scheduler Study in the list pane.
• New Optimized Run: Creates a new Optimized Run under the Scheduler Study that is currently highlighted in
the list pane.
•
Delete: Deletes the item that is currently highlighted in the list pane.
•
Rename: Allows you to rename the item that is currently highlighted in the list pane.

755
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

•
Compute: Opens a submenu containing the following commands:
• Compute: Computes the optimized run that is currently highlighted in the list pane.
• Resume: Resumes the incomplete optimized run that is currently highlighted in the list pane.
•
Export to Scenario: Opens the Export to Scenario dialog, allowing you to define the export settings.
•
Report: Opens a preformatted report containing the data for the currently highlighted solution.
•
Graph: Opens a graph containing the data for the currently highlighted solution.
•
Help: Opens the online help.

Scheduler Study
A Scheduler Study is the top-level grouping of the settings and input data related to the optimization to be performed.
This includes picking a scenario to optimize, defining pump decision, constraints and objective elements.

To start using Darwin Scheduler, you must create a Scheduler Study. All Darwin Scheduler data resides within the
Scheduler Study.
A Scheduler Study includes the following:
1. The scenario to optimize.
2. The set of pumps being scheduled.
3. Constraints that must be met by the solutions offered after a run.
4. Energy price data and tank definitions to be used during the optimization.
5. The type of objective.
6. Genetic algorithm options and parameters.
7. The results of optimized runs.

756
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

It is apparent that one or more of these items will be different between different scheduler studies, hence the ability to
create as many scheduler studies as you need.
You can create more than one scheduler study. Each design study can include one or more optimized runs.
Scenario Tab
The Scenario tab allows you to select the scenario to optimize.

Select the scenario from the menu or click the Scenarios button to open a dialog that displays the scenario
hierarchy and allows you to select the desired scenario.
Pump Stations to Optimize Tab
The pump stations to optimize tab allows you to define which pump stations will be optimized by Scheduler.

This tab consists of a table that lists the pump stations you have selected to optimize and a toolbar that consists of the
following buttons:
•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Pumps to Optimize Tab
The pumps to optimize tab allows you to define which pumps will be optimized by Scheduler.

757
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

Pumps and pump batteries are allowable selections. For pump batteries Scheduler will also optimize the number of
running lag pumps at each control time in addition to choosing the status of the main (or lead) pump.
This tab consists of a table that lists the pumps you have selected to optimize and a toolbar that consists of the
following buttons:
•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Constraints Tab
This tab allows you to specify global pressure constraints, and then to override them locally at specified nodes if
desired.

758
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

First, populate the table using the following toolbar buttons:

•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Then enter the Minimum and Maximum global constraints. To override the global constraint at a node, check the
corresponding Override Defaults? box and enter the values for the new minimum and maximum pressure in the
corresponding fields.
Velocity Tab
This tab allows you to specify a global maximum velocity constraint, and then to override it locally at specified nodes if
desired.

759
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

First, populate the table using the following toolbar buttons:

•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Then enter the Maximum global velocity constraint. To override the global constraint at a node, check the
corresponding Override Defaults? box and enter the value for the new maximum velocity in the corresponding field.
Pump Starts Tab
This tab allows you to specify the global maximum number of pump starts allowed, and then to override it locally at
specified pumps if desired.

760
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

First, populate the table using the following toolbar buttons:

•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Then enter the Maximum global pump starts constraint. The maximum pump starts constraint applies to the number of
pump starts for the duration of the optimized schedule. To override the global constraint at a pump, check the
corresponding Override Defaults? box and enter the number of maximum pump starts in the corresponding field.
Tank Tab
This tab allows you to specify the minimum final tank levels.

761
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

First, populate the table using the following toolbar buttons:

•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Then enter the minimum final level constraint. For each tank added to the list the current minimum, maximum and
initial levels are shown to assist you in entering a correct minimum final level value.
Objective Elements Tab
This tab is divided into sub-tabs that allow you to define the energy pricing for pumps and variable speed pump
batteries, as well as select the tanks that will be included.
Pumps Tab
This tab allows you to associate the energy pricing pattern with the pumps you select.

762
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

First, populate the table using the following toolbar buttons:

•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Then select an energy pricing pattern from the menu for each pump in the table. To create a new energy pricing pattern,
click the ellipsis button (...) to open the Energy Pricing manager (see Energy Pricing Manager for more information).
Variable Speed Pump Batteries Tab
This tab allows you to associate the energy pricing pattern with the variable speed pump batteries (VSPB'S) you select.

763
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

First, populate the table using the following toolbar buttons:

•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
Then select an energy pricing pattern from the menu for each VSPB in the table. To create a new energy pricing
pattern, click the ellipsis button (...) to open the Energy Pricing Manager (see Energy Pricing Manager for more
information).
Tanks Tab
This tab allows you to select the tanks that should be used during the optimization.

764
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

Populate the table using the following toolbar buttons:

•
New: Adds a row to the table.
•
Delete: Removes the currently highlighted row from the table.
•
Initialize Table from Selection Set: Opens the Initialize Table from Selection Set dialog, which allows you to
select a predefined selection set that will be used to automatically fill in the table.
•
Select from Drawing: Allows you to select one or more elements from the drawing.
For each row, select a tank from the menu or click the ellipsis button (...) to select one or more thanks from the
drawing.
Objective Type Tab
This tab allows you to select the type of objective to optimize.

The choices include:

765
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

• Minimize Energy Use: This type will try to minimize the energy used. The effect of tariffs making energy cheaper
at certain times is neglected in this type of optimization.
• Minimize Energy Cost: This type uses energy tariffs and peak demand charges to calculate the cost of energy used.
Notes Tab
This tab allows you to enter descriptive notes that will be associated with the Scheduler Study.

Optimized Run
A Scheduler Study can contain one or more Optimized Runs. The settings for an optimized Run consist of selecting the
pumps to optimize, selecting the objective elements to use, and the genetic algorithm options and parameters that will
be govern the optimization.
Pump Stations to Optimize Tab
This tab allows you to define allowable pump station settings and schedule periods.

• Include in Optimization?: WHen this box is checked, the associated pump will be included in the optimization.
• Decision Type: This field allows you to select whether the associated pump is Fixed Speed or Variable Speed.
• Speed (Minimum): The minimum speed for a variable speed pump. This field is only editable when the associated
pump i s a Variable Speed Decision Type.
• Speed (Maximum): The maximum speed for a variable speed pump. This field is only editable when the associated
pump is a Variable Speed Decision Type.
• Speed (Increment): Set the increment as the lowest value that a variable speed pump's speed can be increased or
decreased by. This field is only editable when the associated pump is a Variable Speed Decision Type.
• Allow Off Setting?: When this box is checked, 0 speed is included in the options for variable speed pumps, in
addition to the allowable choices between the minimum and maximum speed. This field is only editable when the
associated pump is a Variable Speed Decision Type.
• Time From Start: This value, in conjunction with the Duration value, allows you to limit the scheduling period in
which the associated pump may run. For instance, if the user wants to schedule one pump group only from 6am to
6pm for an EPS starting at 12am, they would enter a time from start as 6 hours, and duration as 12 hours. The
scheduler engine will ensure the pumps are not running at all other times.
• Duration: This value, in conjunction with the Time From Start value, allows you to limit the scheduling period in
which the associated pump may run. For instance, if the user wants to schedule one pump group only from 6am to

766
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

6pm for an EPS starting at 12am, they would enter a time from started as 6 hours, and duration as 12 hours. The
scheduler engine will ensure the pumps are not running at all other times.
Pumps to Optimize Tab
This tab allows you to define allowable pump settings and schedule periods.

Include in Optimization: When this box is checked, the assciated pump will be included in the optimization.
• Decision Type: This field allows you to select whether the associated pump is Fixed Speed or Variable Speed.
• Speed (Minimum): The minimum speed for a variable speed pump. This field is only editable when the associated
pump is Variable Speed Decision Type.
• Speed (Maximum): The maximum speed for a variable speed pump. This field is only editable when the associated
pump is Variable Speed Decision Type.
• Speed (Increment): Set the increment as the lowest value that a variable speed pump's speed can be increased or
decreased by. This field is only editable when the associate pump is Variable Speed Decision Type.
• Allow Off Setting?: When this box is checked, 0 speed is included in the options for variable speed pumps, in
addition to the allowable choices between the minimum and maximum speed. This field is only editable when the
associated pump is a Variable Speed Decision Type.
• Time From Start: This value, in conjunction with the Duration value, allows you to limit the scheduling period in
which the associated pump may run. For instance, if the user wants to schedule one pump group only from 6am to
6pm for an EPS starting at 12am, they would enter a time from start as 6 hours, and duration as 12 hours. The
scheduler engine will ensure the pumps are not running at all other times.
• Duration: This value, in conjunction with the Time From Start value, allows you to limit the scheduling period in
which the associated pump may run. For instance, if the user wants to schedule one pump group only from 6am to
6pm for an EPS starting at 12am, they would enter a time from start as 6 hours, and duration as 12 hours. The
scheduler engine will ensure the pumps are not sunning at all other times.
Objective Elements Tab
This tab is divided into sub-tabs that alloq you to choose which objective elements to include in the optimization.
Pumps Tab
This tab allows you to define which pumps are included in the optimization.

767
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

To include a pump, check the associated Include in Energy Calculation? box.

Variable Speed Pump Batteries Tab
This tab allows you to define which variable speed pump batteries are included in the optimization.

To include a variable speed pump battery, check the associated Include in Energy Calculation? box.
Tanks Tab
This tab allows you to define which tankjs are included in the optimization.

768
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

To include a tank, check the associated Include in Energy Calculation? box.

Options Tab
This tab allows you to define the genetic algorithm options and parameters that will be govern the optimization.

The Options tab contains an Algorithm Selection control as well as a number of subtabs. The following Algorithms are
available:
• Simple Genetic Algorithm: An implementation of what is traditionally known as a simple genetic algorithm using
well defined chromosomes and simple crossover as the primary breeding mechanism.
• Fast Messy Genetic Algorithm: An implementation of what is traditionally known as a messy genetic algorithm
with messy or partially defined chromosomes and using splice and cut as the primary breeding mechanism.
Genetic Algorithm Options Tab
This tab allows you to define the genetic algorithm options.

769
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

The following options are available:

• Random Seed: Lets you set the random number generator to a new point. Changing this value and leaving all other
parameters as-is will yield a different solution set.
• Top Solutions to Keep: Set the number of solutions that you want to keep. Rather than presenting you with only
one solution, Scheduler presents you with a customizable number of solutions, so you can review them manually.
• Click the Reset button to rest all of the options on this tab to the factory defaults.
Genetic Algorithm Parameters Tab
This tab allows you to define the genetic algorithm parameters.

770
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

The following parameters are available:

• Population Size: Sets the number of GA solutions in each generation. Increasing Population Size results in a longer
time for each generation and more solutions to be evaluated.
The allowable range for values is from 50 to 500. We recommend you use a range of 50 to 150.
• Elite Population Size: Size of an elite population of chromosomes that is maintained in parallel to the main generic
algorithm population.
• Number of Crossover Points: Defines the number of locations along each parent chromosome where the
chromosome is cut in order to be crossed over with the other parent. This field is only editable when the Algorithm
is set to Simple Genetic Algorithm.
• Probability of Crossover: The probability that a crossover operation will be performed at the point in the genetic
algorithm where crossover operations are performed (during creation of the next generation). This field is only
editable when the Algorithm is set to Simple Genetic Algorithm.
• Probability of Mutation: Sets the probability that a GA solution is randomly altered. A value closer to 100%
causes the solutions to contain more randomization than values closer to 0%.
The allowable range for values is between 0% and 100%, not inclusive. We recommend you use a value less than
10%
• Probability of Creeping Mutation: The probability that a creeping mutation will occur to a new child
chromosome. This field is only editable when the Algorithm is set to Simple Genetic Algorithm.
• Probability of Creeping Down: The probability that a gene in a child chromosome will mutate to a smaller value
(e.g., lower pump speed) versus a higher value (e.g., higher pump speed). This field is only editable when the
Algorithm is set to Simple Genetic Algorithm.

771
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

• Probability of Cut: Sets the probability that a GA solution will be split into two pieces. Setting this value closer to
100% increases the number of cuts made and reduces the average string (chromosome) length. Increasing Cut
Probability causes solutions to vary more widely from one generation to the next, whereas decreasing this results in
more marginal changes.
The allowable range for values is between 0% and 100%, not inclusive. We recommend you use a value less than
10%.
Setting the Splice probability closer to 100% increases the demand on system RAM. If you are getting out-of-
memory errors when using GA Optimization, try reducing the Splice Probability closer to 0% and try increasing the
Cut Probability away from 0%.
This field is only editable when the Algorithm is set to Fast Messy Genetic Algorithm.
• Probability of Splice: Sets the probability that two GA solutions will be joined together. A Splice Probability set
close to 100% results in long solution strings, which increases the mixing of alleles (genes) and improves the variety
of solutions.
The allowable range for values is between 0% and 100%, not inclusive. We recommend you use a range from 50%
to 90%.
This field is only editable when the Algorithm is set to Fast Messy Genetic Algorithm.
• Probability of Elite Mate: The probability that a chromosome from the elite population is selected as a parent for
the next generation at the point in the genetic algorithm where parent selection is conducted.
• Probability of Tournament Winner: The probability that during parent selection the most fit chromosome is
selected in a two chromosome tournament. This field is only editable when the Algorithm is set to Simple Genetic
Algorithm.
Click the Reset button to rest all of the parameters on this tab to the factory defaults.
Stopping Criteria Tab
This tab allows you to define the stopping criteria at which the optimization will be considered finished.

The following stopping criteria are available:

• Maximum Generations: The maximum number of generations to run the genetic algorithm optimization. This field
is only editable when the Algorithm is set to Simple Genetic Algorithm.
• Maximum Eras: The maximum number of eras to run the genetic algorithm optimization. This field is only
editable when the Algorithm is set to Fast Messy Genetic Algorithm.
• Maximum Trials: Set the maximum number of trials you want the Optimized Run to process before stopping.

772
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

• Maximum Non Improvement Generations: Set the number of maximum number of non-improvement
generations you want the GA to process without calculating an improved fitness. If the Optimized Run makes this
number of calculations without finding an improvement in fitness that is better than the defined Fitness Tolerance,
the calibration will stop. Non-Improvement Generations works in conjunction with Fitness Tolerance.
Click the Reset button to rest all of the criteria on this tab to the factory defaults.
Penalty Factors Tab
This tab allows you to define the penalty factors that help narrow down the results.

Define penalty factors to help find the solution. A high penalty factor causes the GA to focus on feasible solutions,
which do not violate boundaries of pressure, velocity, pump starts, or tank levels. A low penalty factor (50,000 or so)
permits the GA to consider solutions that are on the boundary between feasible and infeasible solutions, possibly
violating your defined boundaries by a small amount. Because the optimal solution often resides in the boundary
between feasible and infeasible solutions, a high penalty factor causes the GA to find a feasible solution quickly but is
less likely to find the optimal solution.
From a practical standpoint, you might consider starting with a high penalty factor and working towards a lower
penalty factor as you pursue an optimal solution.
By defining penalty factors for Pressure, Velocity, Pump Starts, and Tank Final Level, you can weight these various
considerations according to which is most important to you.
Click the Reset button to rest all of the factors on this tab to the factory defaults.
Notes Tab
This tab allows you to enter descriptive notes that will be associated with the Optimized Run.

Solutions
After an Optimized Run has been computed, a number of solutions will appear in the list pane.

773
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

Highlighting the top-level Solutions folder will display a Solution Summary for each of the solutions generated by
Scheduler.
When you highlight one of the Solutions, the tabbed area will display three tabs containing all of the solution data.
Pump Station Decisions Tab
This tab displays the pump station decisions summary and details.
The table on the top of the tabbed pane displays a summary of the results for each of the pump decisions. Click on a
pump in the summary table to see the details for that pump in the Pump Decision Details table at the bottom.

774
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

Pump Decisions Tab

This tab displays the pump decisions summary and details.

775
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

The table on the top of the tabbed pane displays a summary of the results for each of the pump decisions. Click on a
pump in the summary table to see the details for that pump in the Pump Decision Details table at the bottom.
Constraints Tab
This tab displays the constraints summary and details.

776
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

The Constraints tab is further divided into subtabs for each of the constraint types: Pressure, Velocity, Pump Starts, and
Tanks. For each constraint type the table lists the associated constraint values you defined, the simulated value, and the
penalty assigned for violating the constraints (if any) for each element.
For the Pressure and Venlocity tabs, click on an element in the summary table to see the details for that element in the
details table at the bottom.
Objective Elements Tab
This tab displays the energy used and cost for the objective elements.

777
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

Scheduler Results Plot

This dialog displays a graphical plot of the pump decision results.

The toolbar along the top of the dialog consists of the following buttons:
•
Copy: Copies the plot to the Windows clipboard.

778
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

•
Print Preview: Opens a print preview window, allowing you to see how the plot will look when it is printed.
•
Options: Opens the TeeChart Options dialog, allowing you to customize the plot settings.
• Help: Opens the online help.

Export to Scenario Dialog Box

Use the Export to Scenario dialog box to apply the results of your Optimized Run to your water model.

Check the Export Scenario? box to export the solution to a new scenario. You can change the default name of the new
scenario by typing a different one in the Name field.
You can also change the names of the Physical, Active Topology, and Operational Alternatives that will be created by
entering the new name in the appropriate field.

Darwin Scheduler FAQ

1. What is the recommended work flow for using Darwin Scheduler?

The following steps provide a basic guideline for the Darwin Scheduler work flow.
a. Build and create an EPS (Extended Period Simulation) model of the hydraulic network of interest.
b. Calibrate the model.
c. Start Darwin Scheduler and create a new Scheduler Study.
d. Identify the pumps or pump stations (with a preference for pump stations) that will be optimized by Scheduler.
e. Identify the hydraulic performance criteria that must be maintained (hydraulic constraints).
f. Identify the objective elements that should be included in the calculation of the objective function (energy use or
energy cost). It is possible for a pump or pump station to be included in the calculation of the objective function
but not be optimized. For example, a pump that is always on need not be optimized but the costs can be included
in the objective function.
g. Specify the objective type (either minimize energy use or minimize energy cost).
h. Create a new Optimized Run.

779
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

i. Select whether pumps will be optimized as fixed speed or variable speed, their allowable speed settings (if
variable speed), whether pumps are allowed to be turned off (if variable speed) and also whether the pumps are
optimized for the entire EPS or a portion of it. Note that if optimizing only a portion of the EPS (for any one
pump decision) Scheduler turns off pumps outside of the portion of the schedule being optimized. For example,
for a 24 hour EPS run a pump decision that is set for a time from start of 12 hours and duration of 12 hours will
be off from time 0 to time <12, and optimized for time 12 to time <24. The pump will be off at time 24 to ensure
a repeatable schedule).
j. Select which objective elements to include in the optimization objective function (by default all included in the
study are selected).
k. Choose which genetic algorithm you wish to use and adjust any required parameters (see a later FAQ for
information on these settings).
l. Run the optimized run.
m. Optionally stop the optimized run mid flight and review results and resume the run if results are favorable. To do
this, select the Stop button in the progress dialog. After reviewing the run, the run can be restarted by picking the
compute button and selecting Resume or started from the beginning by picking Compute. Closing Scheduler or
performing any other function that runs a pressure computation (such as calculating another scenario) will
terminate the paused scheduler run.
n. When the optimized run is complete, review summary results in Darwin Scheduler and choose solutions to
export. If any results look promising, choose the solutions to export, else repeat steps k through m with different
genetic algorithm parameters. Two prime examples would be population size (try larger perhaps) and random
seed (try a different seed).
o. Export the chosen solutions to a new scenario by picking the Export to Scenario button on the top of the left
pane.
p. Run the exported scenarios.
q. Run an energy costs analysis.
r. View and analyze the optimized schedule results.
s. Make any tweaks or adjustments to the optimized solution as appropriate, noting that due to the nature of the
optimization algorithm sometimes Scheduler will turn off one pump only to turn an equivalent pump on; what
the optimization is really saying in this case is that 1 pump of type x should be running.
As alluded to in step n above, it should be noted that the steps from the point of setting up the Scheduler study to
exporting solutions and reviewing results can be performed in an iterative loop with adjustments made to the
Darwin Scheduler input based on the results of the first set of optimization runs, aimed at improving or re-directing
the next set of optimized run results. This is in fact the recommended work flow for using Darwin Scheduler.
2. What is the control interval used by Darwin Scheduler for my EPS optimization?
Darwin Scheduler uses a control interval defined by the hydraulic time-step of the EPS being optimized. This is
done since to apply a change in pump setting/status a new steady state simulation is required and so it makes the
most sense to align this with the hydraulic time step. To this end, you can reduce the number of pump decisions the
optimization needs to make by increasing the hydraulic time step say from 1 hour to 2 hours or 2 hours to 3 hours.
Any intermediate time steps that need to be simulated (such as for tanks filling or controls triggering) will still be
simulated as per normal EPS protocol.

Note:
If there is no reason to have a fine control interval it is strongly recommended to use a course control interval
(for a 24 hour EPS consider starting as course as 3 hours) to keep the size of the solution space to a
minimum. By keeping the solution space small Scheduler will produce better results. Once a course solution
is yielded it is possible to run optimizations with a shorter time step, but it is recommended to do so after
having reduced the number of allowable pump speed choices to be in keeping with the previous course

780
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

solution. Using engineering judgment to keep the optimization solution space as small as possible will
improve the Darwin Scheduler experience.
To be considered along with the above recommendation, also note that using a time increment that is too
large can result in tank levels running from the current level to full or empty in a single time step. The time
step should be a fraction of the time (less than 25%) it takes to fill or drain the tank. It is not recommended to
include small tanks, like hydropneumatic tanks in the same run as large tanks because they operate at much
different time scales. See Best Practices and Tips (on page 7) for more information.

3. Can Darwin Scheduler be used to optimize very large models and very large numbers of pumps in a
single run? If so, what is the best way to use Scheduler for such problems?
We've built no hard limits into Scheduler to prevent it from being used with very large hydraulic models, with very
fine control intervals or with lots of pump decisions, however, the performance of Darwin Scheduler in terms of
both run time and also optimization results is dependent on the user applying reasonable engineering judgment to
minimize the complexity of the problem to be solved and also ensuring the model upon which the optimization is
based runs as fast as possible.
Consider an EPS mode that takes 10 seconds to solve and factor in that for a reasonable sized solution space it may
take 100,000 trial solutions to achieve a near global optimum. The computer time needed to evaluate 100,000 trial
solutions is 1,000,000 seconds or 278 hours, or 11.5 days. Most people will probably not want to run optimization
runs that last 11.5 days so there needs to be an appreciation that the time needed for the optimization is a function of
the time to solve the model. There are a number of ways that the run time for a model can be reduced, but the main
one is skeletonization, which if done correctly (such as using hydraulic equivalent skeletonization) can reduce run
time significantly whilst having little or no effect on system hydraulics nor upon the results of an energy
optimization.
The other side of the equation in terms of optimization performance is the number of trials required to reach a near
global optimum. We've used 100,000 trials above as a reasonable number of trials, but depending on the size of the
solution space (the complexity of the optimization problem) it may be more than this figure and it could also be less.
The solution space is defined as the total number of combinations of possible solutions. So for the case of pump
optimization it is the total possible combination of pump speed settings over the course of the optimization. See the
Darwin Scheduler Best Practices and Tips topic for more information about keeping the solution space to a
minimum.
4. When a Variable Speed pump is included in the pumps to optimize, Darwin Scheduler allows it to be
optimized as a fixed speed pump and vice versa for regular pumps. Why?
This is a feature of Darwin Scheduler and is to allow one to assess the difference in running pumps (any pumps) as
fixed speed versus variable speed without first having to modify the pump type in the model. If for example it is
decided that a pump that is currently fixed speed can achieve significant operational improvements by being
operated as variable speed then it may be decided to replace the existing pump with a variable speed pump.
5. What is the difference between a pump and a pump station in Darwin scheduler?
In Scheduler, a pump should be viewed in one and only one way in a given run.
a. As a single pump; each pump is treated individually and is not aware that it is part of a station and which pumps
are in the station with it.
b. As part of a station; Scheduler does not consider exactly which identical pumps are running but merely keeps
track of the number of identical pumps running.
Treating pumps as part of a station is win-win since it reduces the problem dimensionality and avoids un-necessary
pump switches that may occur when treating pumps as individual optimization decisions. This will usually result in
faster runs with better optimal solutions. However, if all the pumps in a station are different, then the results
between treating the pumps individually or as part of the station will not be any different.

781
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

6. When a Variable Speed Pump Battery is included in the pumps to optimize, Darwin Scheduler sometimes has
a number of running lag pumps result > 0 when the pump speed setting is 0.0. Why?
For Variable Speed Pump Battery elements, Scheduler optimizes the pump speed and number of running lag pumps
as independent optimization decisions. To that end if the pump speed is 0.0 the solution considers all lag pumps to
be off too, so the lead-lag relationship is maintained.
7. When should Scheduler be used to set the speed of variable speed pumps versus just setting a target head
for the variable speed pump algorithm?
If the desired target head for the variable speed pump is known it can simply be set and not optimized by Scheduler.
If there is a large number of pumps to optimize the problem size can be cut down by simply setting the target head
of some variable speed pumps and batteries and not including those as pumps to optimize. This minimizes the
solution spacer of the optimization ensuring better results for the pumps that are optimized. If, however, a
reasonable target head for the system is not known, then Scheduler can assist with determining what a reasonable
head setting might be as well as the pump speed.
However, there is no guarantee that the "optimal" speeds determined by Darwin Scheduler will be better than
simply trying to maintain a know head or flow in a standard variable speed simulation run. This is due to the fact
that Scheduler looks at discrete speeds such as 0.8, 0.85, 0.9 while the simulation run may be able to find a better
solution by running at 0.86759 which Scheduler would not be able to find. The primary advantage of using
Scheduler is that it can consider multiple constraints while a standard simulation only has a single set point.
8. When a Variable Speed Pump with Target Head or Flow is included in the pumps to optimize in Darwin
Scheduler the pump no longer maintains the target head or flow. Why?
When a pump is selected to be optimized by Darwin Scheduler full control of that pump is given to Darwin
Scheduler. The pump will ignore any VSP control properties and will not necessarily maintain target flows or heads.
This is handled by setting constraints on pressures or flows. Be careful not to set the minimum and maximum
constraint too close together, given the time step size and increment, or else it may not be possible to obtain a
feasible solution.
9. When a pump is included in the pumps to optimize in Darwin Scheduler it no longer responds to controls.
Why?
When a pump is selected to be optimized by Darwin Scheduler full control of that pump is given to Darwin
Scheduler. The pump will ignore any control actions applied to it.
10. When a pump is included in the pumps to optimize in Darwin Scheduler it no longer responds to patterns.
Why?
When a pump is selected to be optimized by Darwin Scheduler full control of that pump is given to Darwin
Scheduler. The pump will ignore any patterns applied to it.
11. When exporting an optimized schedule that includes Variable Speed Pump Batteries, Darwin Scheduler
breaks the Variable Speed Pump Battery into single pump elements. Why?
Darwin Scheduler is able to optimize the operation of Variable Speed Pump Batteries by considering them as a lead
pump with the specified number of lag pumps in parallel. In order for the solution that is exported by Darwin
Scheduler to match up with Darwin Scheduler's simulated hydraulics and energy cost/use it must export a scenario
that is functionally equivalent to the optimized schedule. Since Variable Speed Pump Battery elements are not
designed to work with pump patterns, Darwin Scheduler exports these as single pumps with a pattern applied to
replicate the optimized pump schedule. Correspondingly each lag pump will have its own pattern.
12. When exporting an optimized schedule Darwin shows a higher/lower energy use value for the solution than
does the energy costs tool. What is wrong?
In this case one or more tanks is included in the objective elements list in Darwin Scheduler and Scheduler is
accounting for the energy deficit or credit from the tank(s) filling or draining; ensure that the energy costs tool is
also accounting for the energy credit/deficit due to tanks to verify Scheduler's calculated energy costs and/or energy
usage. Filling a tank is essentially storing energy for later use while draining that tank uses stored energy.

782
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

13. Why does Darwin Scheduler require "objective elements" to be specified separately to the pumps
to optimize?
This is because Darwin Scheduler allows the optimization to consider any pumps or tanks in the assessment of the
objective value (energy use or energy cost) as opposed to just the elements included in the optimization process as
decisions or constraints. This allows selective optimization of specific pumps whilst leaving others operating
according to their control rules (or VSP settings), but factoring in the cost of all (or any number) of the pumps in the
model, regardless of whether they are being optimized or not.
14. Darwin Scheduler requires constraints to be entered manually. Why is there no global or blanket constraint
that I can apply such as minimum pressure, for example?
Using blanket constraints is the easiest way to de-rail the optimization by inadvertently including constraints that
are impossible to meet such as the suction side nodes of pumps in pressure constraints. Since constraints are entered
manually (using several convenient methods) a user is encouraged to first think about the constraints that are being
added. For more information please see the "Darwin Scheduler Best Practices and Tips" topic.
15. There is always a high violation number for my optimization run. Why can't Scheduler find a feasible
solution (a solution that meets the constraints)?
There could be several reasons for this including:
a. The Scheduler constraints include an impossible to meet constraint such as a minimum required pressure that is
on the suction side of a pump, or a required pressure near a tank with too low a level.
b. The Scheduler constraints include two or more inconsistent constraints. For example one junction may require a
pressure of < 50 psi, whilst an adjacent junction might require > 50 psi. When there is high penalty associated
with more than one constraint, check to see if the constraints are not mutually exclusive.
c. The schedule for optimization is not appropriate for the EPS being optimized. One example might be a 48 hour
EPS run that is set up to optimize pump operation for the first 24 hours only, but requiring a high final tank
level. Note that Scheduler optimized pumps are turned off outside of their optimized schedule.
d. The run has not been allowed to run sufficiently long enough for all constraints to be met by the evolved
solutions.
e. If a tank is small relative to the time it takes to fill or drain it, it may consistently overshoot the maximum level
or drop below the minimum. The time to fill or drain a tank should be much larger than the time step size.
16. When running a minimize energy use optimization why can't Scheduler find a solution that is better than the
control based pump schedule in the scenario being optimized?
Constraints have potentially been defined that are based on the control based pump schedule and are thus affording
the optimization process no flexibility in being able to change the pumping schedule. Bear in mind that an energy
use optimization is more constrained than energy cost in the sense that the optimization is not able to leverage
variations in energy tariffs to find a better solution. For example, if in the base pump schedule a single pump is
running all day to meet hydraulic criteria, surely there is little scope for saving energy costs in that context unless
there is either flexibility in hydraulic criteria or other pumps that can be utilized.
17. Darwin Scheduler is running slowly. Why?
There are a number of reasons for this, but the main reason is that in contrast to the other two Darwin tools
(Calibrator and Designer) Scheduler has a higher computational overhead by virtue of the fact it simulates a full
EPS run compared to just single steady state snapshots in Designer and Calibrator. For example a 24 hour EPS is a
kin to running 24 Design Events in Designer or 24 Field Data Sets in Calibrator. Running a full EPS is necessary to
properly evaluate a pump schedule since pump energy is used and volume changes occur over time, whereas
Designer and Calibrator are more concerned with peak conditions. Then consider that for an optimization to
complete, typically tens of thousands of trials are required. If a single EPS takes a full second to run, a Darwin
Scheduler run will require several hours to complete. This makes running Darwin Scheduler over night on large
models an attractive proposition.

783
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

For additional information on Darwin Scheduler performance and how to get the best out of Darwin Scheduler
please see Best Practices and Tips (on page 7).
18. How is fitness calculated?
Fitness is calculated as follows:
For an energy use optimization, fitness is calculated as the total energy use of the pump elements specified in the
objective elements section for the duration of the full EPS plus the energy credit or deficit from the tanks specified
in the objective elements section for the duration of the full EPS plus any penalties encountered. Tank energy credit
is based on the average energy per volume pumped for the duration of the EPS. Fitness is in the units of energy
(kWh).
For an energy cost optimization, fitness is calculated as the total energy cost of the pump elements specified in the
objective elements section for the duration of the full EPS plus the energy cost credit or deficit from the tanks
specified in the objective elements section for the duration of the full EPS, plus any penalties encountered. Tank
energy cost credit is based on the average energy cost per volume pumped for the duration of the EPS. Fitness is in
the units of cost ($).
For both optimization types note that a marginal value is added to the fitness of a solution based on the total number
of pump starts that occur. This is applied independently and in addition to any user-defined pump start constraint
and ensures that optimized solutions adopt less pump starts unless there is a significant benefit to having more pump
starts.
All energy use calculations factor in pump efficiency and pump motor efficiency.
All energy cost calculations factor in specified energy tariffs.
Darwin Scheduler doesnot factor in peak demand charge.
19. What does a violation value of greater than 0.0 mean?
This simply means that the solution (or current best solution) does not meet all of the hydraulic constraints; the
value itself is the penalty applied due to constraint violations. Leaving a run to execute for longer will most likely
reduce violation to 0.0 meaning a feasible solution has been found. The term "feasible" is used to describe a solution
that meets all the specified hydraulic constraints, however, through proper review and engineering judgment a non-
feasible solution (one with violation greater than 0.0) may also be deemed to be feasible in practical terms.
20. How is violation (penalty) calculated?
The calculation of violation varies depending on the constraint type as follows:
Pressure Constraints:

Violation =
Where Pi is the average absolute pressure violation at constraint Node i, and PFp is the pressure penalty factor.
Velocity Constraints:

Violation =
Where Vi is the average absolute velocity violation at constraint Pipe i, and PFv is the velocity penalty factor.
Pump Start Constraints:

784
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

Violation =
Where Pi is the average absolute pump start violation at constraint Pump i, and PFps is the pump start penalty
factor. Note that violation for pump starts is calculated in a cumulative sense so that the rolling number of pump
starts is used to calculate the violation at each time. This makes solutions that exceed their maximum pump starts
early in the optimized schedule less desirable compared to ones that may only fail their constraint near the end of
the schedule.
Tank Final Level Constraints:

Violation =
Where LV is the final level violation, and PFt is the tank final level penalty factor.
21. What values are acceptable to use for Genetic Algorithm Parameters, Stopping Criteria and Penalty
Factors?
Most users will not have to concern themselves with the adjustment of these parameters and reasonable defaults
have been set as defaults for normal use. Advanced users or users that are particularly interested in optimization
may wish to play with these parameters to assess their effect on the optimization process. Darwin Scheduler will not
accept values for any parameter that are considered to be detrimental to the operation of the engine as a whole,
however, such values still might not be recommended to use. To that end we provide some recommended ranges of
values for each parameter.
Genetic Algorithm Parameters
Population Size: 50-200. Sometimes as high as 1000+
Elite Population Size: 10-20
Number of Cross Over Points: 2-10 or 2-10% of the problem length
Probability of Cross Over: 90-100%
Probability of Mutation: 1-2%
Probability of Creeping Mutation: 0-1%
Probability of Creeping Down: For this problem type higher than 50%
Probability of Cut: 1-2%
Probability of Splice: 90-95%
Probability of Elite Mate: 0-1%

Probability of Tournament Winner: 95-100%

Stopping Criteria
Maximum Generations: Typically 500 - 2000
Maximum Eras: Typically 6-12
Maximum Trials: Typically 50000 - 200000 or higher (the larger the population size used, the larger this should
be)

Maximum Non Improvement Generations: 100-300

785
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

Penalty Factors
These factors are used to weight different constraint types against each other, but primarily to guide the
optimization process towards areas of the solution space that contain solutions that do not violate constraints. These
factors should rarely require manipulation.
Pressure Penalty: 0.5 - 2.0
Velocity Penalty: 0.5 - 2.0
Pump Starts Penalty: 5 - 20

Tank Final Level Penalty: 5 - 20

22. What is the difference between the Simple Genetic Algorithm and the Fast Messy Genetic Algorithm?
Third party research suggests that Fast Messy Genetic Algorithms are better at finding near optimal solutions to
complex problems than their Simple Genetic Algorithm predecessors and as such Darwin Calibrator and Darwin
Designer both employ a type of Fast Messy Genetic Algorithm. Darwin Scheduler makes use of a newly developed
Genetic Algorithm component and it was little additional work for us to expose both Genetic Algorithm types to
users instead of just the one so we did. This will enable those who are interested in optimization to experiment using
both types of algorithm.
23. When using the Fast Messy Genetic Algorithm sometimes the number of trials on the Optimization Progress
dialog pauses for an extended period of time so no trials are being evaluated. Why is this?
As part of the messy genetic algorithm process prior to the creation of a new generation of trial solutions, parents
must be selected for the new generation. Owing to the nature of the messy GA solution representation suitable
parent chromosomes must be compared against other chromosomes with a certain similarity measure. The process
by which chromosomes are found that meet the similarity measure is called genic thresholding and sometimes this
can take a little while to execute, meaning CPU time is spent for a short period on the genic thresholding process as
opposed to evaluating trial solutions. The simple genetic algorithm does not perform genic thresholding and
therefore does not have this delay. Note, however, that the run-time required for genetic algorithm processes pales
in significance compared to the time required to evaluate trial solutions, even for the Fast Messy Genetic
Algorithm.
24. Why doesn't Darwin Scheduler stop exactly when the stop button is clicked?
The reason for this is that in order for various things to work correctly (such as the resume feature) Scheduler will
complete the current generation that it is evaluating before returning control to the user. This is indicated on the
Optimization Progress dialog by the Stop button becoming disabled and the Optimization Progress dialog status
showing "Stopping...". Depending on the population size of the run and the time taken for a single trial this may
represent several minutes, so please be patient during this process.
25. Where does Darwin Scheduler store its results?
Darwin Scheduler stores its results in a proprietary binary file format with a *.dsb (Darwin Scheduler Binary)
extension. When the model is saved any Darwin Scheduler results files will be saved too.
26. Why doesn't Darwin Scheduler have more in depth results visualization features?
Darwin Scheduler's user interface provides summaries of the optimized pump schedules and of hydraulic
performance, however, the best way to view Darwin Scheduler results is to export the optimized scenario to the
model and analyze results by leveraging the full suite of results visualization tools available in the main application.
Of particular value will be the Scenario Energy Cost Manager for a detailed break down of energy use and cost.
27. Why doesn't Darwin Scheduler allow additional demands or boundary conditions to be specified like
Darwin Calibrator and Darwin Designer?
The answer to this question lies in the fact that Darwin Scheduler simulates an entire EPS run as opposed to a set of
steady state snapshots like Darwin Calibrator or Darwin Designer. In those latter two tools it is necessary for a user
to be able to specify boundary conditions (such as valve settings and tank levels) that define the hydraulic
conditions that apply to the associated hydraulic snapshot. For example, if the snapshot is for 7am, tank levels etc

786
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

will be specified for that time. This, however, is unnecessary for Darwin Scheduler since it simulates a full EPS run
and therefore is able to calculate the boundary conditions at each time in the EPS run. To that end Darwin
Scheduler's model input is completely acquired from the scenario being optimized. If it is necessary to consider
additional demands or make other modifications to the hydraulic model before running an optimization, do so using
the main application's standard scenario and alternative management tools, then select the modified scenario as the
scenario to optimize in Darwin Scheduler.
28. When exporting an optimized schedule that includes Variable Speed Pump Batteries, Darwin Scheduler
breaks the Variable Speed Pump Battery into single pump elements. Why?
1. The initial situation: a VSPB connected to two pipes.

2. The Darwin Scheduler solution to export, showing that 2 lag pumps are needed.

3. The situation right after exporting of solution is done (with labels re-arranged). In order to understand what
elements were created, some graphical cleanup is needed. Hydraulically, the network should output the same results
with (no cleanup required).

787
WaterGEMS CONNECT Edition Help
Optimizing Pump Schedules Using Darwin Scheduler

4. The situation after exporting and re-positioning the elements for a better understanding:
• The VSPB and its connecting pipes are made inactive in the new scenario created by Scheduler.
• Standard pumps are created for both the lead and each needed lag pump for the exported solution.
• Two nodes are also introduced (one upstream and one downstream of these pumps).
• Pipes connecting to the original VSPB (P-24 and P-25 in the screenshot) are duplicated and connected to those
two new nodes.
• New short & large pipes (i.e. 1 ft. long, 99 in. in diameter) are setup for every standard pump in the solution,
connecting them to the new upstream/downstream nodes.
• All of these new elements are only active in the exported scenario. They are left inactive in other active-
topology alternatives.

5. Shows the new pump-patterns created by the export for the lead and 2 lag pumps (3 new patterns in total in the
screenshot).

788
WaterGEMS CONNECT Edition Help
Presenting Your Results

Presenting Your Results

Graphs (on page 7)

Extended Node Data

Note: This dialog is available in HAMMER only.

This tab consist of the following controls:

• Working Scenario: The current active scenario.
• Plot: Create a graph of the selected result attribute.

789
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Additional Scenarios: Select one or more scenarios to compare the transient node results against the results of the
current scenario shown in the input field Working Scenario.
• Node: Displays a list of all node objects in the model with transient node results.
• Graph Type: Displays a list of the available transient node results available for the selected node type.

Annotating Your Model

You can annotate any of the element types in WaterGEMS CONNECT.
To work with annotations, open the Element Symbology manager: click View > Element Symbology (Ctrl+1).
Use the Element Symbology manager to control the way that elements and their associated labels are displayed.
Note that element types that are not used in the current model are marked with an icon.
The dialog box contains a pane that lists each element type along with the following controls:
• Symbology Definition: The menu lists all of the available element symbology definitions. Click the ellipsis (...)
button to open the Symbology Definitions Manager.
• New: Opens a submenu containing the following commands:
• New Annotation—Opens the Annotation Properties dialog box, allowing you to define annotation settings for
the highlighted element type.
• New Color Coding—Opens the Color Coding Properties dialog box, allowing you to define annotation settings
for the highlighted element type.
• Add Folder—Creates a folder under the currently highlighted element type, allowing you to manage the various
color coding and annotation settings that are associated with an element. You can turn off all of the symbology
settings contained within a folder by clearing the check box next to the folder. When a folder is deleted, all of
the symbology settings contained within it are also deleted.
• Delete: Deletes the currently highlighted Color Coding or Annotation Definition or folder.
• Rename: Renames the currently highlighted object.
• Edit: Opens a Properties dialog box that corresponds with the selected background layer.
• Refresh Element Symbology: Opens a shortcut menu containing the following options:
• Refresh Element Symbology - This can be useful if your color-coding and/or annotations are applied to a subset
of elements using a query-based selection set. For performance reasons, query-based selection sets are treated as
static selection sets by default. Use this option to refresh the query based selection set while refreshing element
symbology.
• Refresh Annotation - If you change an annotation's prefix or suffix in the Property Editor, or directly in the
database, selecting this command refreshes the annotation.
• Update Annotation Offset - If you have adjusted the Initial X or Y offsets, selecting this command resets all
annotation X or Y offsets to the currently specified "initial offset" location.
• Update Annotation Height - If you've adjusted the height multiplier, selecting this command resets all annotation
heights multipliers to the currently specified initial height multiplier.
• Shift Up: Moves the currently highlighted object up in the list pane.
• Shift Down: Moves the currently highlighted object down in the list pane.
• Drawing Style: This button is only available in the Stand-Alone version (not in MicroStation, AutoCAD, or
ArcGIS versions. Opens a menu containing the following commands:
• CAD Style-Displays currently highlighted element in CAD Style. Objects displayed in CAD style will appear
smaller when zoomed out and larger when zoomed in.

790
WaterGEMS CONNECT Edition Help
Presenting Your Results

• GIS Style-Displays currently highlighted element in GIS style. Objects displayed in GIS style will appear to
remain the same size regardless of zoom level.
• Tree: Opens a menu containing the following commands:
• Expand All-Expands each branch in the tree view pane.
• Collapse All-Collapses each branch in the tree view pane
• Help: Displays online help for the Element Symbology Manager.
The Element Symbology manager supports Copy/Paste functionality as well as Undo/Redo capability. You can copy/
paste annotations, color coding definitions, and folders by right-clicking them and selecting Copy/Paste. When a folder
is copied in this way all of the contents of that folder are also copied.

Using Folders in the Element Symbology Manager

Use folders in the Element Symbology Manager to create a collection of color coding and/or annotation that can be
turned off as one entity.
Adding Folders
Use element symbology folders to control whether related annotations and/or color coding displays. To create a folder
in the Element Symbology Manager:
1. Click View > Element Symbology.
2. In the Element Symbology Manager, right-click an element and select New > Folder.
3. Or, select the element to which you want to add the folder, click the New button, then select New Folder.
4. Name the folder.
5. You can drag and drop existing annotations and color coding into the folder you create, and you can create
annotations and color coding within the folder by right-clicking the folder and selecting New > Annotation or New
> Color Coding.
6. Use the folder to collectively turn on and off the annotations and color coding within the folder.

Note: You can refresh the display of all color-codings/annotations within a folder by right-clicking the folder and
selecting the Refresh Group command.

In the MicroStation version, the Refresh Group command will override any local modifications made to color or weight
settings applied to individual elements using MicroStation commands. These elements will revert to the WaterGEMS
symbology settings after a Refresh Group command is initiated.
Deleting Folders
Click View > Element Symbology. In the Element Symbology Manager, right-click the theme folder you want to
delete, then select Delete.
Or, select the folder you want to delete, then click the Delete button.
Renaming Folders
Click View > Element Symbology. In the Element Symbology Manager, right-click the theme folder you want to
rename, then select Rename.
Or, select the folder you want to rename, then click the Rename button.

Annotation Properties
Use the Annotation Properties dialog box to define annotation settings for each element type.

791
WaterGEMS CONNECT Edition Help
Presenting Your Results

Field Name Specify the attribute that is displayed by the annotation

definition.

Free Form This field is only available when <Free Form

Annotation> is selected in the Field Name list. Click the
ellipsis button to open the Free Form Annotation dialog
box.

Prefix Specify a prefix that is displayed before the attribute

value annotation for each element to which the definition
applies.

Suffix Specify a suffix that is displayed after the attribute value

annotation for each element to which the definition
applies.

Note: If you add an annotation that uses units, you

can type “%u” in the prefix or suffix field to display
the units in the drawing pane.

Selection Set Specify a selection set to which the annotation settings

will apply. If the annotation is to be applied to all
elements, select the <All Elements> option in this field.
<All Elements> is the default setting.

Initial Offset Checkbox When this box is checked, changes made to the X and Y
Offset will be applied to current and subsequently created
elements. When the box is unchecked, only subsequently
created elements will be affected.

Initial X Offset Displays the initial X-axis offset of the annotation in feet.
Sets the initial horizontal offset for an annotation. Set this
at the time you create the annotation. Clicking OK will
cause the new value to be used for all subsequent
elements that you place. Clicking Apply will cause the
new value to be applied to all elements.

Initial Y Offset Displays the initial Y-axis offset of the annotation in feet.
Sets the initial vertical offset for an annotation. Set this at
the time you create the annotation. Clicking OK will
cause the new value to be used for all subsequent
elements that you place. Clicking Apply will cause the
new value to be applied to all elements.

Initial Multiplier Checkbox When this box is checked, changes made to the Height
Multiplier will be applied to current and subsequently
created elements. When the box is unchecked, only
subsequently created elements will be affected.

792
WaterGEMS CONNECT Edition Help
Presenting Your Results

Initial Height Multiplier Sets the initial size of the annotation text. Set this at the
time you create the annotation. Clicking OK will cause
the new value to be used for all subsequent elements that
you place. Clicking Apply will cause the new value to be
applied to all elements.

Free Form Annotation Dialog Box

The Free Form Annotation dialog box allows you to type custom annotations for an element type.

To create an annotation, type the text as you want it to appear in the drawing. You can add element attributes to the text
string by clicking the Append button and selecting the attribute from the categorized list.

Symbology Definitions Manager

The Symbology Definitions manager lets you add, edit, and remove and manage the symbology definitions that are
associated with the hydraulic model.
The dialog box contains a list pane that displays each of the definitions currently contained within the hydraulic model,
a display pane that details the settings for the currently highlighted definition, along with a toolbar. The toolbar consists
of the following buttons:

New Creates a new symbology definition

in the list pane.

Import Allows you to import a previously

exported symbology definition.

793
WaterGEMS CONNECT Edition Help
Presenting Your Results

Export Exports the currently highlighted

symbology definition as an .sde file
that can be imported into other
hydraulic models.

Delete Removes the currently highlighted

symbology definition.

Duplicate Creates a copy of the currently

highlighted symbology definition.

Rename Lets you rename the currently

highlighted symbology definition.

Help Displays online help for the

Symbology Definitions manager.

When you create a new definition, all of the annotation and color settings will be turned off. To change the settings for
a definition, change the current symbology definition to the one you want to edit in the Element Symbology Manager
and make the desired changes there (i.e. turn on/off the desired elements, create new annotations and color coding and
turn them on or off, etc.).

Color Coding Your Model

Use color coding to help you quickly see what's going on in your WaterGEMS CONNECT model. Use color coding to
change the color and/or size of elements based on the value of data that you select, such as flow or element size.
To work with color coding, open the Element Symbology manager: click View > Element Symbology (Ctrl+1).
The dialog box consists of the following controls:
• Field Name: Select the attribute by which the color coding is applied.
• Selection Set: Apply a color coding to a previously defined selection set.
• Calculate Range: Automatically finds the minimum and maximum values for the selected attribute and enters them
in the appropriate Min. and Max fields.
• Minimum: Define the minimum value of the attribute to be color coded.
• Maximum: Define the maximum value of the attribute to be color coded.
• Steps: Specify how many rows are created in the color maps table when you click Initialize. When you click
Initialize, a number of values equal to the number of Steps are created in the color maps table. The low and high
values are set by the Min and Max values you set.
• Options: Select whether you want to use color coding, sizing, or both to code and display your elements. Map colors
to value ranges for the attribute being color coded. The following buttons are found along the top of the table.
• New: Creates a new row in the Color Maps table.
• Delete: Deletes the currently highlighted row from the Color Maps table.
• Initialize: Finds the range of values for the specified attribute, divides it into equal ranges based on the number
of Steps you have set, and assigns a color to each range.
• Ramp: Generates a gradient range between two colors that you specify. Pick the color for the first and last values
in the list, then WaterGEMS CONNECT automatically sets intermediate colors for the other values. For

794
WaterGEMS CONNECT Edition Help
Presenting Your Results

example, picking red as the first color and blue as the last color produces varying shades of purple for the other
values.
• Invert: Reverse the order of the colors/sizes used in the Color Map table.
• Above Range Color: Displays the color that is applied to elements whose value for the specified attribute fall
outside the range defined in the color maps table. This selection is available if you choose Color or Color and Size
from the Options list.
• Above Range Size: Displays the size that is applied to elements whose value for the specified attribute fall outside
the range defined in the color maps table. This selection is available if you choose Size or Color and Size from the
Options list.
To add color coding, including element sizing:
1. Click View > Element Symbology.
2. In the Element Symbology manager, right-click an element and select New > Color Coding. Or, select the element
you want to add the color coding, click the New button, and select New Color Coding.
3. The Color Coding Properties dialog box opens. Select the properties you want to color code from the Field Name
and Selection Set menus. Once you've selected the Field Name, more information opens.
4. In the Color Maps Options menu, select whether you want to apply color, size, or both to the elements you are
coding.
a. Click Calculate Range. This automatically sets the maximum and minimum values for your coding. These
values can be set manually.
b. Click Initialize. This automatically creates values and colors in the Color Map. These values can be set
manually.
5. After you finish defining your color coding, click Apply and then OK to close the Color Coding Properties dialog
box and create your color coding, or Cancel to close the dialog box without creating a color coding.
6. Click Compute to compute your network.
7. To see the network color coding and/or sizing change over time:
a. Click Analysis > Time Browser, if needed, to open the Time Browser dialog box.
b. Click Play to use the Time Browser to review your color coding over time.
To delete a color coding definition:
Click View > Element Symbology. In the Element Symbology manager, right-click the color coding you want to delete,
then select Delete.
Or, select the color coding you want to delete, then click the Delete button.
To edit a color coding definition
Click View > Element Symbology. In the Element Symbology manager, right-click the color coding you want to edit,
then select Edit.
Or, select the color coding you want to edit, then click the Edit button.
To rename a color coding definition
Click View > Element Symbology. In the Element Symbology manager, right-click the color coding you want to
rename, then select Rename.
Or, select the color coding you want to rename, then click the Rename button.
To copy a color coding definition
1. Click View > Element Symbology. In the Element Symbology manager, right-click the color coding you want to
copy, then select Copy.

795
WaterGEMS CONNECT Edition Help
Presenting Your Results

2. Right-click on the folder under which you want the defintion to be copied and select Paste.

Color Coding Legends

You can add color coding legends to the drawing view. A legend displays a list of the colors and the values associated
with them for a particular color coding definition.
To add a color coding legend
Right-click the color coding definition in the Element Symbology dialog and select the Insert Legend command.
To move a color coding legend
1. Click the legend in the drawing view to highlight it.
2. Click and hold onto the legend grip (the square in the center of the legend), then drag the legend to the new location.
To resize a color coding legend
1. Right-click the legend in the drawing view and select the Scale command.
2. Move the mouse to resize the legend and click the left mouse button to accept the new size.
To remove a color coding legend
Right-click the color coding definition in the Element Symbology dialog and select the Remove Legend command.
To refresh a color coding legend
Right-click the color coding definition in the Element Symbology dialog and select the Refresh Legend command.

Contours

Using WaterGEMS CONNECT you can visually display calculated results for many attributes using contour plots.
The Contours dialog box is where all of the contour definitions associated with a hydraulic model are stored. Choose
View > Contours to open the Contours dialog box.

796
WaterGEMS CONNECT Edition Help
Presenting Your Results

You can sort the contour manager by clicking the Label column header. The initial click will sort in ascending order. A
subsequent click will sort in descending order.
The dialog box contains a list pane that displays all of the contours currently contained within the hydraulic model,
along with a toolbar.

New Opens the Contour Definition dialog

box, allowing you to create a new
contour.

Delete Deletes the currently selected contour.

You can hold down the Ctrl key while
clicking on items in the list to select
multiple entries at once.

Rename Renames the currently selected

contour.

Edit Opens the Contour Definition dialog

box, where you can modify the
settings of the currently selected
contour.

797
WaterGEMS CONNECT Edition Help
Presenting Your Results

Export Clicking this button opens a submenu

containing the following commands:
Export to Shapefile - Exports the
contour to a shapefile, opening the
Export to File Manager to select the
shapefile. Export to DXF - Exports
the contour as a .dxf drawing. Export
to Native Format - Opens the DXF
Properties dialog box, allowing you to
add it to the Background Layers
Manager.

View Contour Browser Opens the Contour Browser dialog,

allowing you to display detailed
contour results for points in the
drawing view.

Refresh Regenerates the contour.

Shift Up Moves the currently selected contour

up in the list pane.

Shift Down Moves the currently selected contour

down in the list pane.

Help Displays online help for the Contours.

Contour Definition
The Contour Definition dialog box contains the information required to generate contours for a calculated network.

798
WaterGEMS CONNECT Edition Help
Presenting Your Results

Contour

Field Select the attribute to apply the contour.

Selection Set Apply an attribute to a previously defined selection set or

to one of the following predefined options: All Elements -
Calculates the contour based on all elements in the model,
including spot elevations. All Elements Without Spots -
Calculates the contour based on all elements in the model,
except for spot elevations.

Minimum Lowest value to be included in the contour map. It may be

desirable to use a minimum that is above the absolute
minimum value in the system to avoid creating excessive
lines near a pump or other high-differential portions of the
system.

799
WaterGEMS CONNECT Edition Help
Presenting Your Results

Maximum Highest value for which contours will be generated.

Increment Step by which the contours increase. The contours created

will be evenly divisible by the increment and are not
directly related to the minimum and maximum values. For
example, a contour set with 10 minimum, 20 maximum,
and an increment of 3 would result in the following set:
[ 12, 15, 18 ] not [ 10, 13, 16, 19 ].

Index Increment Value for which contours will be highlighted and labeled.
The index increment should be an even multiple of the
standard increment.

Smooth Contours The Contour Smoothing option displays the results of a

contour map specification as smooth, curved contours.

Line Weight The thickness of contour lines in the drawing view.

Label Height Multiplier When contours are created, there are labels (text) placed
on the end of the index contours. This text has a default
size. The Label Height Multiplier field allows you to
scale the text size for these labels up/down.

Color by Range Contours are colored based on attribute ranges. Use the
Initialize button to create five evenly spaced ranges and

associated colors. Initialize —This button,

located to the right of the Contour section, will initialize
the Minimum, Maximum, Increment, and Index
Increment values based on the actual values observed for
the elements in the selection set. Initialization can be
accomplished by clicking the Initialize button to
automatically generate values for the minimum,
maximum, increment, and index increment to create an
evenly spaced contour set. Ramp —Automatically
generate a gradient range between two colors that you
specify. Pick the color for the first and last values in the
list and the program will select colors for the other values.

Color by Index The standard contours and index contours have separately
controlled colors that you can make the contours more
apparent.

Contour Plot
The Contour Plot window displays the results of a contour map specification as accurate, straight-line contours.
View the changes in the mapped attribute over time by using the animation feature. Choose Analysis > Time Browser
and click the Play button to automatically advance through the time step increments selected in the Increment bar.

800
WaterGEMS CONNECT Edition Help
Presenting Your Results

The plot can be printed or exported as a .DXF file. Choose File > Export > DXF to export the plot.
Although the straight-line contours generated by this program are accurate, smooth contours are often more desirable
for presentation purposes. You can smooth the contours by clicking Options and selecting Smooth Contours.

Note: Contour line index labels can be manually repositioned in this view before sending the plot to the printer.
The Contour Plot Status pane displays the Z coordinate at the mouse cursor.

Contour Browser Dialog Box

The Contour Browser dialog box displays the X and Y coordinates and the calculated value for the contour attribute at
the location of the mouse cursor in the drawing view.

Enhanced Pressure Contours

Normal contouring routines only include model nodes, such as junctions, tanks and reservoirs. When spot elevations
are added to the drawing, however, you can create more detailed elevation contours and enhanced pressure contours.
These enhanced contours include not only the model nodes but also the interpolated and calculated results for the spot
elevations. Enhanced pressure contours can help the modeler to understand the behavior of the system even in areas
that have not been included directly in the model.

Using Profiles

A profile is a graph that plots a particular attribute across a distance, such as ground elevation along a section of piping.
As well as these side or sectional views of the ground elevation, profiles can be used to show other characteristics, such
as hydraulic grade, pressure, and constituent concentration.
You define profiles by selecting a series of adjacent elements. To create or use a profile, you must first open the
Profiles manager. The Profiles manager is a dockable window where you can add, delete, rename, edit, and view
profiles.
The Profiles dialog box is where you can create, view, and edit profile views of elements in the network.
The dialog box contains a list pane that displays all of the profiles currently contained within the hydraulic model,
along with a toolbar.

801
WaterGEMS CONNECT Edition Help
Presenting Your Results

Opens the Profile Setup dialog box, where you can select
New the elements to be included in the new profile from the
drawing view.

Deletes the currently selected profile. You can hold down

Delete the Ctrl key while clicking on items in the list to select
multiple entries at once.

Renames the currently selected profile.

Rename

Opens the Profile Setup dialog box, where you can

Edit modify the settings of the currently selected profile.

Opens the Profile viewer, allowing you to view the

View Profile currently selected profile.

When this toggle button is on, elements contained within

Highlight Profile the currently highlighted profile will be highlighted in the
drawing pane to increase their visibility.

Displays online help for Profiles.

Help

By default, all profiles are created as Transient Report Paths. A Transient Report Path is denoted by a small hammer
icon.

802
WaterGEMS CONNECT Edition Help
Presenting Your Results

When a transient analysis is completed in HAMMER, profile results will only be stored for those elements along a
previously defined Transient Report Path.
You can right-click a profile in the Profile Manager and uncheck the Transient Report Path toggle command in the
context menu. When unchecked, transient analysis results will not be saved for that profile. Reducing the number of
Transient Report Paths can reduce output file sizes and improve calculation times.
Transient Report Paths are not used directly in WaterGEMS/WaterCAD - in those products results from all profiles are
always available. However the Transient Report Path toggle and hammer icon are included in WaterGEMS/WaterCAD
so that hydraulic models created within any of the three programs will be compatible.

Profile Setup
Setting up a profile is a matter of selecting the adjacent elements on which the profile is based. When you click on New
in the Profiles dialog box the following dialog box opens.

The Profile Setup dialog box includes the following options:

Label Displays the list of elements that define the profile.

User Defined Station Checking this box makes the Station field editable for the
associated element, allowing you to define the station.

Station Displays the station for the associated element. This field
is non-editable unless the User Defined Station box is
checked.

803
WaterGEMS CONNECT Edition Help
Presenting Your Results

Select From Drawing Selects and clears elements for the profile.

Reverse Reverses the profile, so the first node in the list becomes
the last and the last node becomes the first.

Remove All Removes all elements from the profile.

Remove All Previous Removes all elements that appear before the selected
element in the list. If the selected element is a pipe, the
associated node is not removed.

Remove All Following Removes all elements that appear after the selected
element in the list. If the selected element is a pipe, the
associated node is not removed.

Open Profile Closes the Profile Setup dialog box and opens the Profile
Series Options dialog box.

Related Topics
• Viewing Profiles
• Animating Profiles
• Creating a New Profile
• Editing Profiles
• Profile Viewer Dialog Box (on page 805)

Profile Series Options Dialog Box

The Profile Series Options dialog box allows you to adjust the display settings for the profile view. You can define the
legend labels, the scenario (or scenarios), and the attribute (or attributes) that are displayed in the profile plot.

804
WaterGEMS CONNECT Edition Help
Presenting Your Results

The Series Label Format field allows you to define how the series will be labeled in the legend of the profile view.
Clicking the [>] button allows you to choose from predefined variables such as Field name and Element label.
The Scenarios pane lists all of the available scenarios. Check the box next to a scenario to display the data for that
scenario in the profile view. The Expand All button opens all of the folders so that all scenarios are visible; the Collapse
button closes the folders.
The Elements pane lists all of the elements that will be displayed in the profile view. The Expand All button expands
the list tree so that all elements are visible; the Collapse button collapses the tree.
The Fields pane lists all of the available input and output fields. Check the box next to a field to display the data for that
field type in the profile view. The Expand All button opens all of the folders so that all fields are visible; the Collapse
button closes the folders. The Filter by Field Type button allows you to display only Input or Output fields in the list.
Clicking the [>] button opens a submenu that contains all of the available fields grouped categorically.
Note that profiles don't show any results for the intermediate points along a pipe. To see the results of transient
calculations for these intermediate points, you will need to use the Transient Results Viewer.
The Show this dialog on profile creation check box is enabled by default; uncheck this box to skip this dialog when a
new profile is created.

Profile Viewer Dialog Box

This dialog box displays the profile view of the profile run that is plotted from the Profile Manager. It consists of the
profile display pane and the following controls:

805
WaterGEMS CONNECT Edition Help
Presenting Your Results

Zoom Window Lets you magnify or reduce the display of a section of the
graph. To zoom or magnify an area, select the Zoom
Window tool, click to the left of the area you want to
magnify, then drag the mouse to the right, across the area
you want to magnify, so that the area you want to
magnify is contained within the marquee that the Zoom
Window tool draws. After you have selected the area you
want to magnify, release the mouse button to stop
dragging. To zoom out, or reduce the magnification, drag
the mouse from right to left across the magnified image.

Zoom Extents Magnifies the profile so that the entire graph is displayed.

Chart Settings Opens the Chart Options dialog box, letting you view and
modify the display settings for the current profile plot.
For more information, see “Chart Options Dialog
Box”-179. Never delete or rename any of the series
entries on the Series Tab of the Chart Options dialog box.
These series were specifically designed to enable the
display of the Profile Plots.

Display Labels Lets you display or hide labels for the elements in your
profile plot.

Copy Copies the contents of the Profile Viewer dialog box as an

image to the Windows clipboard, from where you can
paste it into another application, such as Microsoft ®
Word ® or Adobe ® Photoshop ® .

Print Prints the current view of the profile to your default

printer. If you want to use a printer other than your
default, use Print Preview to change the printer and print
the profile.

Print Preview Opens a print preview window containing the current

view of the profile. You can use the Print Preview dialog
box to select a printer and preview the output before you
print it.

Note: Do not change the print preview to grayscale, as

doing so might hide some elements of the display.

Refresh Updates the profile view to reflect changes in input data

and results.

806
WaterGEMS CONNECT Edition Help
Presenting Your Results

Time Browsers The following Time Browsers are found to the right of the
Refresh button: Rewind (Full)—Sets the currently
displayed time step to the beginning of the simulation.
Pause —Stops the animation. Restarts it again with
another click. Play —Advances the currently displayed
time step from beginning to end. Time Display —Shows
the current time step that is displayed in the drawing pane.
Time Slider —Lets you manually move the slider
representing the currently displayed time step along the
bar, which represents the full length of time that the
scenario encompasses

Viewing and Editing Data in FlexTables

Using FlexTables you can view input data and results for all elements of a specific type in a tabular format. You can
use the standard set of FlexTables or create customized FlexTables to compare data and create reports.
You can view all elements in the hydraulic model, all elements of a specific type, or any subset of elements.
Additionally, to ease data input and present output data for specific elements, FlexTables can be:
• Filtered
• Globally edited
• Sorted.
If you need to edit a set of properties for all elements of a certain type in your network, you might consider creating a
FlexTable and making your changes there rather than editing each element one at a time in sequence.
FlexTables can also be used to create results reports that you can print, save as a file, or copy to the Windows clipboard
for copying into word processing or spreadsheet software.
To work with FlexTables, select the FlexTables manager or go to View > FlexTables <Ctrl+7> to open the FlexTables
manager if it is closed.

FlexTables Manager
The FlexTables Manager allows you to create, manage, and delete custom tabular reports.

807
WaterGEMS CONNECT Edition Help
Presenting Your Results

The dialog box contains a list pane that displays all of the custom FlexTables currently contained within the hydraulic
model, along with a toolbar.
Note that element types that are not used in the current model are marked with an icon

The toolbar contains the following buttons:

808
WaterGEMS CONNECT Edition Help
Presenting Your Results

New Opens a submenu containing the

following commands:
• FlexTable —Creates a new tabular
report and opens the FlexTable
Setup dialog box, allowing you to
define the element type that the
FlexTable displays, and the
columns that are contained in the
table.
• 2-Row FlexTable – A specialized
FlexTable that contains conduit
fields and some specialized fields
that shows data for the upstream
and downstream nodes connected
to the conduit.
• Node-Connected Pipe FlexTable –
A specialized FlexTable that
allows the user to use one of
several different node types and
include specialized fields about
connected conduits. The table
displays incoming and outgoing
connected conduits to the node.
• Folder —Creates a folder in the
list pane, allowing you to group
custom FlexTables.

Delete Deletes the currently highlighted

FlexTable.

Rename Lets you rename the currently

highlighted FlexTable.

Edit Opens the FlexTable Setup dialog

box, allowing you to make changes to
the format of the currently selected
table

Open Lets you open the currently

highlighted FlexTable.

Help Displays online help for the

FlexTable Manager.

809
WaterGEMS CONNECT Edition Help
Presenting Your Results

Working with FlexTable Folders

You can add, delete, and rename folders in the FlexTable Manager to organize your FlexTables into groups of that can
be turned off as one entity. You can also create folders within folders. When you start a new hydraulic model,
WaterGEMS displays two items in the FlexTable Manager: Tables - Hydraulic Model (for model-level FlexTables) and
Tables - Shared (for FlexTables shared by more than one WaterGEMS hydraulic model). You can add new FlexTables
and FlexTable folders to either item or to existing folders.
To add a FlexTable folder:
1. Click View > FlexTables to open the FlexTables Manager.
2. In the FlexTable Manager, select either Tables - Hydraulic Model or Tables - Shared, then click the New button.
3. Click New Folder from the shortcut menu.
4. Right-click the new folder and select Rename from the shortcut menu.
5. Type the name of the folder, then press Enter.
To delete a FlexTable folder:
1. Click View > FlexTables to open the FlexTables Manager.
2. In the FlexTables Manager, select the folder you want to delete, then click the Delete button.
To rename a FlexTable folder:
1. Click View > FlexTables to open the FlexTables Manager.
2. In the FlexTables Manager, select the folder you want to rename, then click the Rename button.
3. Type the new name of the folder, then press Enter.

FlexTable Dialog Box

FlexTables are displayed in the FlexTable dialog box. The dialog box contains a toolbar, the rows and columns of data
in the FlexTable, and a status bar.
The toolbar contains the following buttons:

Export to File Export to a Shapefile .shp, a Tab

Delimited file .txt, or a Comma
Delimited File .csv.

Note: Exporting to a Shapefile is

not available for 2-Row and Node-
Connected Pipe FlexTables.

Copy Lets you copy the contents of the

selected table cell, rows, and/or
columns for the purpose of pasting
into a different row or column or into
a text editing program such as
Notepad.

810
WaterGEMS CONNECT Edition Help
Presenting Your Results

Paste Lets you paste the contents of the

Windows clipboard into the selected
table cell, row, or column. Use this
with the Copy button.

Note: Paste is not available for 2-

Row and Node-Connected Pipe
FlexTables.

Edit Opens the FlexTable Setup dialog

box, allowing you to make changes to
the format of the currently selected
table

Zoom To Lets you zoom into and center the

drawing pane on the currently
selected element in the FlexTable.

Find Lets you find a user-defined string in

the FlexTable.

Report Lets you create and view a report of

your FlexTable for either the current
time step or all time steps.

Options Opens a submenu containing the

following commands: Create
Selection Set —Lets you create a new
static selection set (a selection set
based on selection) containing the
currently selected elements in the
FlexTable. Add to Selection Set —
Lets you add the currently selected
elements in the FlexTable to an
existing selection set. Remove from
Selection Set —Removes the
currently selected elements from an
existing selection set. Relabel —
Opens an Element Relabeling box
where you can Replace, Append, or
Renumber

811
WaterGEMS CONNECT Edition Help
Presenting Your Results

Select In Drawing Opens a submenu containing the

following commands: Select In
Drawing —Selects the currently
highlighted element(s) in the drawing
pane. Add to Selection —Adds the
currently highlighted element(s) to
the group that is currently highlighted
in the drawing pane. Remove From
Selection —Removes the currently
highlighted element(s) from the group
that is currently highlighted in the
drawing pane. Open on Selection -
Filters the table based on the
appropriate type selected in the
drawing. Open on All Rows - resets
the filter to display all elements of the
appropriate type in the table.

The status bar at the bottom of the FlexTable dialog box contains the following items:
• x of x elements displayed—Number of elements displayed in the FlexTable of the total possible number of that type
of element.
• FILTERED—If you have applied a filter to the FlexTable, this appears in the status bar. Hold the mouse cursor over
this panel to display a tool tip, which lists a summary of active filters.
• SORTED—If you have sorted the order of any items in the FlexTable, this appears in the status bar. Hold the mouse
cursor over this panel to display a tool tip, which lists a summary of active sorting.

Note: You can freeze columns such that they will remain stationary and visible even when scrolling by right-
clicking the desired column(s) and selecting the Freeze Column command. To unfreeze columns, right click and
select the Unfreeze All Columns command.
Note: You can zoom to an element in the table by right-clicking the corresponding row and selecting the Zoom To
command. You can also zoom to each element sequentially by highlighting a row and pushing the Enter key.
Note: You can perform a Global Edit on a subset of elements in a FlexTable by highlighting the desired fields by
holding the Ctrl key and clicking each of the fields to be edited, then right-clicking and selecting the Global Edit
command. Global Edit is not available for the 2-Row and Node-Connected Pipe FlexTables.
Note: You can open a table containing a subset of the elements in a FlexTable by highlighting the desired fields by
holding the Ctrl key and clicking each of the fields to be edited, then right-clicking and selecting the Open On
Selection command.
Note: You can filter the table based on the current drawing selection by using the "Open on Selection" command on
the drop-down menu of the "Select in Drawing" toolbar button. To reset the view, use the "Open on All Rows"
command on the drop-down menu of the "Select in Drawing" toolbar button.

Opening FlexTables
You open FlexTables from within the FlexTable Manager.

812
WaterGEMS CONNECT Edition Help
Presenting Your Results

To open FlexTables:
1. Click View > FlexTables or click the FlexTables button on the View toolbar to open the FlexTables Manager.
2. Perform one of the following steps:

Creating a New FlexTable

You can create model-level or shared FlexTables.
• Hydraulic model-level FlexTables are available only for the hydraulic model in which you create them.
• Shared tables are available in all WaterGEMS hydraulic models.
To create a new FlexTable:
Model-level and shared FlexTables are created the same way:
1. Click View > FlexTables or click the FlexTables button on the View toolbar to open the FlexTables Manager.
2. In the FlexTables Manager, right-click Tables - Hydraulic Model or Tables - Shared, then select New > FlexTable.
3. Or, select Tables - Hydraulic Model or Tables - Shared, click the New button, then select FlexTable.
4. The Table Setup dialog box opens.
5. Select the Table Type you want to create. This lets you filter your table by element type.
6. Select the items you want in the FlexTable by moving them to the Selected Columns pane.
7. Click OK.
8. The table displays in the FlexTables Manager; you can type to rename the table or accept the default name.

Deleting FlexTables
Click View > FlexTables to open the FlexTables manager. In the FlexTables manager, right-click the FlexTable you
want to delete, then select Delete.
Or, select the FlexTable you want to delete, then click the Delete button. You cannot delete predefined FlexTables.

Note: You cannot delete predefined FlexTables.

Naming and Renaming FlexTables

You name and rename FlexTables in the FlexTable Manager.
To rename FlexTables:
1. Click View > FlexTables or click the FlexTables button on the View toolbar to open the FlexTables Manager.
2. Perform one of the following steps:

Note: You cannot rename predefined FlexTables.

Editing FlexTables
You can edit a FlexTable to change the columns of data it contains or the values in some of those columns.
Editable columns
Columns that contain data you can edit are displayed with a white background. You can change these columns directly
in the FlexTable and your changes are applied to your model when you click OK.The content in the FlexTable columns

813
WaterGEMS CONNECT Edition Help
Presenting Your Results

can be changed in other areas of WaterGEMS , such as in a Property Editor or managers; but, it might be more efficient
to make changes to numerous elements in a FlexTable rather than the Property Editor or a manager.If you make a
change that affects a FlexTable outside the FlexTable, the FlexTable is updated automatically to reflect the
change.Non-editable columnsColumns that contain data you cannot edit are displayed with a yellow background, and
correspond to model results calculated by the program and composite values.The content in these columns can be
changed in other areas of WaterGEMS , such as in a Property Editor and by running a computation.If you make a
change that affects a FlexTable outside the FlexTable, the FlexTable is updated automatically to reflect the change.
To edit a FlexTable:
1. Click View > FlexTables to open the FlexTables Manager, then you can:
2. The Table dialog box opens. .
3. Use the Table dialog box to include and exclude columns and change the order in which the columns appear in the
table.
4. Click OK after you finish making changes, to save your changes and close the dialog box; or, click Cancel to close
the dialog box without making changes.
Editing Column-Heading Text
To change the text of a column heading:
1. Click View > FlexTables to open the FlexTables Manager.
2. In the FlexTables manager, open the FlexTable you want to edit.
3. Right-click the column heading and select Edit Column Label.
4. Type the new name for the label and click OK to save those changes and close the dialog box or Cancel to exit
without making any changes.
Changing Units, Format, and Precision in FlexTables
To change the units, format, or precision in a column of a FlexTable:
1. Click View > FlexTables to open the FlexTables Manager.
2. In the FlexTables manager, open the FlexTable you want to edit.
3. Right-click the column heading and select Units.
4. Make the changes you want and click OK to save those changes or Cancel to exit without making any changes.
Navigating in Tables
The arrow keys, Ctrl+Home, Ctrl+End, PgUp, PgDn, and Ctrl+arrow keys navigate to different cells in a table.
Globally Editing Data
Using FlexTables, you can globally edit all of the values in an entire editable column. Globally editing a FlexTable
column can be more efficient for editing properties of an element than using the Properties Editor or managers to edit
each element in your model individually.
To globally edit the values in a FlexTable column:
1. Click View > FlexTables to open the FlexTables Manager.
2. In the FlexTables manager, open the FlexTable you want to edit and find the column of data you want to change.
3. If necessary, you might need to first create a FlexTable or edit an existing one to make sure it contains the column
you want to change.
4. Right-click the column heading and select Global Edit.
5. In the Operation field, select what you want to do to data in the column: Add, Divide, Multiply, Set, or
Subtract.The Operation field is only available for numeric data.

814
WaterGEMS CONNECT Edition Help
Presenting Your Results

6. In the Global Edit field, type or select the value you want—for numeric data, you typically type a new value, for
other data you might select from a drop-down list or select a check box.

Sorting and Filtering FlexTable Data

You can sort and filter your FlexTables to focus on specific data or present your data in one of the following ways:
There are several options for sorting and filtering your FlexTables to focus on specific data or present your data.
Column Order
You can sort the order of columns in a FlexTable in the following ways:
• Edit the FlexTable (see Editing FlexTables (on page 813)), to open the Table dialog box and change the order of the
selected tables using the up and down arrow buttons.
• The top-most item in the Selected Columns pane appears furthest to the left in the resulting FlexTable.
• Open the FlexTable, click the heading of the column you want to move, then click again and drag the column to the
new position. You can only move one column at a time.
Row Order
To sort the records or rows of a FlexTable:
1. Right-click a column heading that will be used rank the rows of the FlexTable.
2. Select Sort, then one of sorting options such as Ascending, Descending, Custom.
See Sorting FlexTable Rows (on page 816) and Sorting FlexTable by Network Order (on page 817).
Filtering
You filter a FlexTable by creating a query. See Filtering FlexTable Data (on page 815).

Filtering FlexTable Data

You filter a FlexTable by creating a query. You can filter a Flextable with selection an existing query, or by
constructing a new query with the Query Builder dialog.
Open the FlexTable you want to filter. Right-click the column heading you want to filter, and select between two
Filtering options, Filter By Query and Custom Filter.
Filter By Query
Select from a list of defined project queries. When a query is selected the subset of rows satisfying the condition will
remain visible in the Flextable.
Custom Filter
1. The Query Builder dialog box opens.
2. All input and results fields for the selected element type appear in the Fields list pane, available SQL operators and
keywords are represented by buttons, and available values for the selected field are listed in the Unique Values list
pane. Perform the following steps to construct your query:
3. Double-click the field you wish to include in your query. The database column name of the selected field appears in
the preview pane.
4. Click the desired operator or keyword button. The SQL operator or keyword is added to the SQL expression in the
preview pane.
5. Click the Refresh button above the Unique Values list pane to see a list of unique values available for the selected
field. The Refresh button is becomes disabled after you use it for a particular field.

815
WaterGEMS CONNECT Edition Help
Presenting Your Results

6. Double-click the unique value you want to add to the query. The value is added to the SQL expression in the
preview pane.
7. Click the Validate button above the preview pane to validate your SQL expression. If the expression is valid, the
word “VALIDATED” is displayed in the lower right corner of the dialog box.
8. Click the Apply button above the preview pane to execute the query. If you didn’t validate the expression, the
Apply button validates it before executing it.
9. Click OK.

The FlexTable displays columns of data for all elements returned by the query and the word "FILTERED" is displayed
in the FlexTable status bar.
To reset a filter:
1. Right-click the column heading you want to filter.
2. Select Filter.
3. Click Reset.
The status pane at the bottom of the Table window always shows the number of rows displayed and the total number of
rows available (e.g., 10 of 20 elements displayed). When a filter is active, this message is highlighted.

Sorting FlexTable Rows

816
WaterGEMS CONNECT Edition Help
Presenting Your Results

You sort the rows a FlexTable by first selecting the column that you want to be the sort order of the records (rows).
After sorting rows, the word "SORTED" is displayed in the FlexTable status bar. To sort rows, right-click a column
heading, and select one of the following options:
• Sort > Sort Ascending
Will arrange the rows in the Flextable in ascending or increasing order, based on the selected column.
• Sort > Sort Descending
Will arrange the rows in the Flextable in descending or descreaing order. The outcome will essentially the opposite
ordering of Sort Ascending.
• Sort > Custom
See Custom Sort Dialog Box (on page 817)
To Reset a Sort:
1. Right-click the column heading you want to sort.
2. Select Sort.
3. Click Reset.

Custom Sort Dialog Box

This dialog box allows you to choose an attribute to sort by, and whether to sort in asending or descending order. You
can choose multiple attributes to sort by. When multiple sort attributes are specified, the first attribute specified will
take precedence, then the second, and so on.

Sorting FlexTables by Network Order

817
WaterGEMS CONNECT Edition Help
Presenting Your Results

To sort rows by their relative distance downstream, right-click a column heading, and select one of the following
options:
• Sort Upstream > Downstream
Will arrange the rows in the Flextable based on how far they are from the downstream most drainage point in their
network. The upstream-most elements will appear in rows before those elements which are connected downstream.
• Sort Downstream > Upstream
Will arrange the rows in the Flextable based on how far they are from the downstream most drainage point in their
network. The downstream-most network elements will appear before those that are connected downstream. The
outcome will essentially the opposite of an Upstream->Downstream ordering.
• Sort Dendritic (Upstream > Downstream)
Will arrange the rows in the Flextable not only by their upstream to downstream connectivity but also grouped by
branch. Links of a dendritic stormwater network can be well-labeled with the Branch Labeling tool, resulting in a
clear designation of links organized into tributary branches. After this sort, the first rows appearing will the
elements within the upstream most branch. And appearing in upstream to downstream order within that branch.

Customizing Your FlexTable

There are several ways to customize tables to meet a variety of output requirements:
• Changing the Report Title—When you print a table, the table name is used as the title for the printed report. You
can change the title that appears on your printed report by renaming the table.
• Adding/Removing Columns—You can add, remove, and change the order of columns from the Table Setup dialog
box.
• Drag/Drop Column Placement—With the Table window open, select the column heading of the column that you
would like to move and drag the column to its new location.
• Resizing Columns—With the Table open, click the vertical separator line between column headings. Notice that the
cursor changes shape to indicate that you can resize the column. Drag the column separator to the left or right to
stretch the column to its new size.
• Changing Column Headings—With the Table window open, right-click the column heading that you wish to change
and select Edit Column Label.

Element Relabeling Dialog

This dialog is where you perform global element relabeling operations for the Label column of the FlexTable.

818
WaterGEMS CONNECT Edition Help
Presenting Your Results

The element relabeling tool allows you to perform three types of operations on a set of element labels: Replace,
Renumber, and Append. The active relabel operation is chosen from the list box in the Relabel Operations section of
the Relabel Elements dialog box. The entry fields for entering the information appropriate for the active relabel
operation appear below the Relabel Operations section. The following list presents a description of the available
element relabel operations.
• Replace—This operation allows you to replace all instances of a character or series of characters in the selected
element labels with another piece of text. For instance, if you selected elements with labels P-1, P-2, P-12, and J-5,
you could replace all the Ps with the word Pipe by entering P in the Find field, Pipe in the Replace With field, and
clicking the Apply button. The resulting labels are Pipe-1, Pipe-2, Pipe-12, and J-5. You can also use this operation
to delete portions of a label. Suppose you now want to go back to the original labels. You can enter Pipe in the Find
field and leave the Replace With field blank to reproduce the labels P-1, P-2, P-12, and J-5. There is also the option
to match the case of the characters when searching for the characters to replace. This option can be activated by
checking the box next to the Match Case field.
• Renumber—This operation allows you to generate a new label, including suffix, prefix, and ID number for each
selected element. For example, if you had the labels P-1, P-4, P-10, and Pipe-12, you could use this feature to
renumber the elements in increments of five, starting at five, with a minimum number of two digits for the ID
number field. You could specify a prefix P- and a suffix -Z1 in the Prefix and Suffix fields, respectively. The prefix
and suffix are appended to the front and back of the automatically generated ID number. The value of the new ID
for the first element to be relabeled, 5, is entered in the Next field. The value by which the numeric base of each
consecutive element is in increments, 5, is entered in the Increment field. The minimum number of digits in the ID
number, 2, is entered in the Digits field. If the number of digits in the ID number is less then this value, zeros are
placed in front of it. Click the Apply button to produce the following labels: P-05-Z1, P-10-Z1, P-15-Z1, and P-20-
Z1.

819
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Append—This operation allows you to append a prefix, suffix, or both to the selected element labels. Suppose that
you have selected the labels 5, 10, 15, and 20, and you wish to signify that these elements are actually pipes in Zone
1 of your system. You can use the append operation to add an appropriate prefix and suffix, such as P- and -Z1, by
specifying these values in the Prefix and Suffix fields and clicking the Apply button. Performing this operation
yields the labels P-5-Z1, P-10-Z1, P-15-Z1 and P-20-Z1. You can append only a prefix or suffix by leaving the
other entry field empty. However, for the operation to be valid, one of the entry fields must be filled in.
The Preview field displays an example of the new label using the currently defined settings.

FlexTable Setup Dialog Box

The Table Setup dialog box is where you can customize tables through the following options:

Table Type Specifies the type of elements that appear in the table. It
also provides a filter for the attributes that appear in the
Available Columns list. When you choose a table type,
the available list only contains attributes that can be used
for that table type.

820
WaterGEMS CONNECT Edition Help
Presenting Your Results

Available Columns Contains all the attributes that are available for your table
design. The Available Columns list is located on the left
side of the Table Setup dialog box. This list contains all
of the attributes that are available for the type of table you
are creating. The attributes displayed in yellow represent
non-editable attributes, while those displayed in white
represent editable attributes. Click the Arrow button [>] to
open a submenu that contains all of the available fields
grouped categorically.

Selected Columns Contains attributes that appear in your custom designed

FlexTable. When you open the table, the selected
attributes appear as columns in the table in the same order
that they appear in the list. You can drag and drop or use
the up and down buttons to change the order of the
attributes in the table. The Selected Columns list is
located on the right-hand side of the Table Setup dialog
box. To add columns to the Selected Columns list, select
one or more attributes in the Available Columns list, then
click the Add button [>].

Select or clear columns to be used in the table and arrange

the order the columns appear. The Add and Remove
buttons are located in the center of the Table Setup dialog
box. [ > ] Adds the selected items from the Available
Columns list to the Selected Columns list. [ >> ] Adds all
of the items in the Available Columns list to the Selected
Columns list. [ < ] Removes the selected items from the
Selected Columns list. [ << ] Removes all items from the
Add and Remove Buttons Selected Columns list. To rearrange the order of the
attributes in the Selected Columns list, select the item to

be moved, then click the up or down button .

Copying, Exporting, and Printing FlexTable Data

You can output your FlexTable several ways:
• Copy FlexTable data via the clipboard
• Export FlexTable data as a text file
• Create a FlexTable report
To copy FlexTable data via the clipboard:
You can copy your FlexTable data via the clipboard and paste it into another Windows application, such as a word-
processing application as tab-delimited text.
1. Click View > FlexTables to open the FlexTables manager.
2. In the FlexTables manager, open the FlexTable you want to use.
3. Click Copy. The contents of the FlexTable are copied to the Windows clipboard.

821
WaterGEMS CONNECT Edition Help
Presenting Your Results

4. Make sure you paste the data you copied before you copy anything else to the Windows clipboard. If you copy
something else to the clipboard before you paste your FlexTable data, your FlexTable data will be lost from the
clipboard.
5. Paste (Ctrl+v) the data into other Windows software, such as your word-processing application.

Note: You can copy the data from a single column by right-clicking a column and choosing the Select Column
command. When a column is selected you can then copy and/or paste the data from/to that column by right-
clicking and choosing one of the commands from the context menu.

To export FlexTable data as a text file:

You can export the data in a FlexTable as tab- or comma-delimited ASCII text, for use in other applications, such as
Notepad, spreadsheet, or word processing software.
1. Click View > FlexTables to open the FlexTables manager.
2. In the FlexTables manager, open the FlexTable you want to use.
3. Click File > Export data.
4. Select either Tab Delimited or Comma Delimited.
5. When prompted, set the path and name of the .txt file you want to create.
To create a FlexTable report:
Create a FlexTable Report if you want to print a copy of your FlexTable and its values.
1. Click View > FlexTables to open the FlexTables manager.
2. In the FlexTables manager, open the FlexTable you want to use. Instead of Print Preview, you can click Print
to print the report without previewing it.
3. Click Report. A print preview of the report displays to show what your report will look like if printed using your
default printer. You cannot edit the format of the report.
4. Click Print to open the Print dialog box and print the report to a printer that you select.

Statistics Dialog Box

The Statistics dialog box displays statistics for the elements in a FlexTable. You can right-click any unitized input or
output column and choose the Statistics command to view the count, maximum value, mean value, minimum value,
standard deviation, and sum for that column.

822
WaterGEMS CONNECT Edition Help
Presenting Your Results

Using Sparklines
In FlexTable reports, the result columns only show the result value at the current time step. To visualize how the results
vary over time, the graphing feature can be used to draw the results; while this method works for individual elements,
there is no easy way to see the results over time for all elements at the same time. To address this, the Sparkline feature
has been added. When Sparklines are turned on, a results column is added to the FlexTable that displays a miniature
graph of the result values over time.
To turn on Sparklines for a result attribute, create your FlexTable as usual, then right click the column heading for the
desired result attribute and select Show Sparklines from the context menu.
When there is a currently active Sparklines column, you can right click the column heading and select Sparkline
Settings to change the display settings for the graphs. See Sparkline Settings (on page 823).
To turn Sparklines off, right click the attribute heading and select Hide Sparklines.

Sparkline Settings
This dialog allows you to specify the settings used for the Sparklines feature.
The dialog consist of the following controls:
• Calculate Range: This button allows you to automatically determine the minimum and maximum values. Clicking
this button opens a submenu with the following options:
• Full Range: When this option is selected, a precise values are used to calculate the range.
• Quick Range: When this option is selected, a rough estimate of the range of values is used.
• Specify Minimum Sparkline Value: When this box is checked, you may specify the minimum value for the range in
the Minimum field.
• Specify Maximum Sparkline Value: When this box is checked, you may specify the maximum value for the range
in the Maximum field.
• Show Out of Range Sparklines: When this box is checked, sparklines that fall outside the specified range will still
be displayed; values that fall below the specified range will be displayed in the selected Below Range Color and
values that fall above the specified range will be displayed in the selected Above Range Color.

Export to Excel
To export to Excel, select File > Export > Export to Excel 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 spreadsheet.

823
WaterGEMS CONNECT Edition Help
Presenting Your Results

The top left pane is a summary of this element types are to be included in the spreadsheet. 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 spreadsheet. 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 spreadsheet.
If the "Exclude topologically inactive elements" box is checked, only active elements (Is active? = True) are included in
the spreadsheet.
The user will usually not need to include all element properties in the spreadsheet. The right side of the dialog is to
identify which properties of the elements are going to be included in the spreadsheet. 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 Hydraulic Model table), the user can explicitly state the table path (e.g.
Tables - Predefined or Tables - Hydraulic 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.

824
WaterGEMS CONNECT Edition Help
Presenting Your Results

The Properties box on the right side of the dialog shows the properties that are imported for that element type.
When all settings are established for all element types, the user picks OK.
After clicking OK, a dialog opens allowing you to choose whether to export the flextables directly to Excel (.xlsx) or
to .csv. If you choose direct Excel export, click the '...' button to choose the path to export the .xlsx file to. If you choose
to export to .csv, click the '...' button to choose the folder where the multiple .csv files will be placed (one per element
type).

Note: Excel 2007 or later is required for direct .xlsx export.

Reporting

Use reporting to create printable content based on some aspect of your model, such as element properties or results.
You need to compute your model before you can create reports about results, such as the movement of water in your
network. You can also create reports about input data without computing your model. (To compute your model, after
you set up your elements and their properties, click Compute.)
You can access reports by:
• Clicking the Report menu.
• Right-clicking any element, then selecting Report.

Using Standard Reports

There are several standard reports available. To access the standard reports, click the Report menu, then select the
report.

Reports for Individual Elements

You can create reports for specific elements in your network by computing the network, right-clicking the element,
then selecting Report. You cannot format the report, but you can print it by clicking the Print icon.

Creating a Scenario Summary Report

To create a report that summarizes your scenario, click Report > Scenario Summary. The report dialog box opens and
displays your report. You cannot format the report, but you can print it by clicking the Print button.

Creating a Hydraulic Model Inventory Report

To create a report that provides an overview of your network, click Report > Hydraulic Model Inventory. The report
dialog box opens and displays your report. You cannot format the report, but you can print it by clicking the Print
button.

Creating a Pressure Pipe Inventory Report

825
WaterGEMS CONNECT Edition Help
Presenting Your Results

To create a report that lists the total lengths of pipe by diameter, material type, and volume, click Report > Pressure
Pipe Inventory. The report dialog opens and displays the Pressure Pipe Inventory report. You can copy rows, columns,
or the entire table to the clipboard by highlighting the desired rows and/or columns and clicking Ctrl+C.
In addition to pipes, any laterals in the model are now reported. The pipes will be on the pipes tab and the laterals will
be on the laterals tab. The laterals tab shows a table showing the total number of active laterals and the total length. If
there are no active laterals in the model the laterals tab is hidden from view.

Report Options
The Report Options dialog box offers control over how a report is displayed.

826
WaterGEMS CONNECT Edition Help
Presenting Your Results

Load factory default settings to current view

Click to restore the default settings to the current view.

Load global default settings to current view

Click to view the stored global settings as local settings.

Save current view settings to global settings

Click to set the current report options as the global default.

827
WaterGEMS CONNECT Edition Help
Presenting Your Results

The header and footer can be fully customized and you can edit text to be displayed in the cells or select a pre-defined
dynamic variable from the cell’s menu.
• %(Company) - The name specified in the hydraulic model properties.
• % (DateTime) - The current system date and time.
• % (BentleyInfo) - The standard Bentley company information.
• % (BentleyName) - The standard Bentley company name information.
• % (Pagination) - The report page out of the maximum pages.
• % (ProductInfo) - The current product and its build number.
• % (ProjDirectory) - The directory path where the hydraulic model file is stored.
• % (ProjEngineer) - The engineer specified in the hydraulic model properties.
• % (ProjFileName) - The full file path of the current hydraulic model.
• % (ProjStoreFileName) - The full file path of the hydraulic model.
• % (ProjTitle) - The name of the hydraulic model specified in the hydraulic model properties.
• % (ReportTitle) - The name of the report.
• %(Image) - Allows you to browse to and attach an image to the report header.
• % (AcademicLicense) - Adds text string: Licensed for Academic Use Only.
• % (HomeUseLicense) - Adds text string: Licensed for Home Use Only.
• % (ActiveScenarioLabel) - The label of the currently active scenario.
You can also select fonts, text sizes, and customize spacing, as well as change the default margins in the Default
Margins tab.

Results Table Dialog Box

The Results Table displays calculated results for each time step at the currently selected element.

828
WaterGEMS CONNECT Edition Help
Presenting Your Results

Custom Reports
Users are able to assemble a wide variety of model input, results, graphs, etc. in a customized report. This report can be
transmitted to recipients in a number of formats. The report generator woks best if any scenarios, selection sets, graphs,
etc. have already been created before entering the Custom Report manager.
To start a custom report, the user selects Reports > Custom Report or in the Reports tab in the Reports group of the
ribbon. The following dialog opens.

829
WaterGEMS CONNECT Edition Help
Presenting Your Results

Top Row Buttons – The top row of buttons in the Custom Report manager enables the user to manage the overall
report. If the user had previously exported a custom report, the report format can be retrieved by selecting the Import
button. The behavior of the buttons is as follows:
• Import – opens a dialog where the user can import a previously defined report.
• Export – opens a dialog where the user can save the current report as a .rptx file. The default location is C:\Users\
[username]\Documents\Bentley\WaterGEMS
• Generate Report – produces a Preview of the report for which the user can perform any number of steps including
viewing, printing, saving as described in help topic Print Preview Window. The report can be exported into a variety
of formats including pdf, html, mht, rtf, csv, excel, text and image. In the preview window, the user can also change
paper size, orientation and margins.
Second Row Buttons – enable the user to set up the individual Report Sections in the report. Initially, all that is shown
is the Report element type and the only entry the user can specify is the Title of the report in the right pane.
• New –enables the user to select the next report section that can be added to the report. This can also be done by
right clicking Report and selecting Add.
• Delete – enables the user to delete the highlighted Report Section.
• Duplicate – enables the user to copy a Report Section. This can be a quick way to include a Flex Table at one time
step when it has already been set up for another time step.

830
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Shift-up and Shift down – enables the user to move a Report Section forward and backward in the report. This can
be especially helpful if a user wants to insert a page break to help improve the report. Adding a page break adds the
break to the end of the report and shirt-up can be used to move it to a preferred location.
• Expand and Collapse – enable the user to expand or collapse the tree view in the left pane.
• OK button closes the Custom Report manager and saves the report.
• Cancel button closes report manager but does not save the changes made since the report was last opened.
There are several types of sections that can be inserted into the report. The control that a user has over the sections
depends on whether the sections follow a “Scenario” divider. If a report section is listed before the first scenario, that
section can only display previously saved graphs and data tables. If they are listed after a scenario, the user has a great
deal of additional control over the report section and any sections will refer to that scenario.
Scenario – is the usually the first type of report section that a user specifies. The user selects the scenario in the right
pane after picking Scenario under New in the left pane. The user selects the scenario from a drop down list populated
by the existing scenarios. If the user only wants to report on a selection set of model elements, these can be selected
from a drop down list labelled Default Selection Sets which contains predefined selection sets. After the scenario is
selected, all entries after that will refer to the selected scenario until a new scenario is selected. If the user does not
select a scenario and tries to generate a report, then an error message is produced. Selection sets are optional and the
default value is <None> which means that all elements are available, except for Flex Tables (see below).
Graph – When the user selects graph, it is possible to either display a pre-existing graph or create a new graph. If the
graph is not associated with a scenario, the manager can only select existing graphs as shown below.
If the graph is associated with a scenario, the user can create a graph at this time, by selecting the Graph Type. If the
user picks "Graph" then a pre-existing graph must be selected. If the user picks, Element Graph, the user can select an
Element and prepare a new graph after selecting the element from the Drawing.
To select a pre-existing graph, click the drop-down for Name and click "<Select Graph…>". You will be prompted
with the following dialog:

When a graph is selected, the Select button is automatically enabled. You can either select the node and click Select or
you can double-click the graph which will select the graph automatically and close the dialog. Using the ESC key will
cancel the selection and close the dialog.
And then select the Field(s) (Property) to graph.

831
WaterGEMS CONNECT Edition Help
Presenting Your Results

Once the graph itself has been selected, the user has additional control over how it will appear in the report. (Printing is
assumed to be Portrait style unless the entire report is set to landscape.) The following properties can be set:
• Width of Page Factor - determines how much of the space between the margins (in percent) is to be used for the
graph or table. The default value is 100% and values must be less than or equal to 100%.
• Aspect Ratio - defines the width:height ratio of the graph.
• Alignment - determines the location of the graph within the margin for graphs less than 100% width. The acceptable
values are Left, Center and Right justified.
• A graph with 50% width, 1:1 aspect ratio and center alignment, looks like this:

Data Tables – are very similar to graphs in that they are simply the tabular view of the data displayed in a graph. The
commands for graphing also apply for data tables. Data Tables are always left justified and the aspect ratio is
determined by the size of the table.
Selecting a saved graph works the same way as the graph section.
FlexTables – provide the user with a way to include FlexTable results in a report. When the user creates a FlexTable, it
is necessary to specify which of the existing FlexTables is selected and what Selection Set of elements is to be
displayed. The default value of <none> is not acceptable. If the user wants to show all of the elements of a given type, it
is necessary to create a Selection Set will all elements of that type. There must be at least one element in a Selection
Set. When the Override Selection Set property is set to False, the Selection Set specified in the Scenario Report Section
is used. When it is set to True, the user must specify the Selection Set to be used. Finally, the time step to be used to
populate the flex table must be selected.
The user is required to name specific selection sets and time steps because FlexTables can easily contain thousands of
rows and if multiple time steps are chosen, the report can be exceedingly large. Requiring the user to consider exactly
what values are important, makes that portion of the Report more focused.

832
WaterGEMS CONNECT Edition Help
Presenting Your Results

FlexTables can contain a large number of columns which may unnecessarily take up space in the Report. Users may
want to create custom flex tables for the report showing only the columns that are of interest. They can do this by
creating Custom or Shared Flex Tables (see FlexTable help).
Map View – enables the user to insert a map of the piping network in the report. Before creating a Report Section for a
map view, the user must have already created a Named View (see Named Views). If the user has specified a named
Symbology Definition, the user can specify it. The default value is the <default> element symbology. If the user wants
a map to have a background, it must be displayed when the report is generated.
The user has additional control over the appearance of the map by setting:
• Width of Page Factor - determines how much of the space between the margins (in percent) is to be used for the
graph or table. The default value is 100% and values must be less than or equal to 100%.
• Alignment - determines the location of the graph within the margin for graphs less than 100% width. The acceptable
values are Left, Center and Right justified.
• Border - determines whether a border is placed around the map.
• Time from start - indicates the time for which symbology values are calculated.
Section Titles – enable the user to insert section titles into a report. Whatever is entered on the right pane will appear
below the report title on subsequent pages until the next section title is encountered. To stop showing section titles,
enter a new section title that is blank.
Page Break – enables the user to insert a page break so that the next Report Section begins on a new page. The Shift-
up and Shift down arrows can be used to move page breaks.

Blank Line – enables the user to insert a blank line between report sections. This can be used to improve the
appearance of the report so that graphs and tables don’t appear to run into one another. The user can specify the number
of blank lines in the right pane. The default number is one.
Summary Section – provides the user with access to a number of predefined summary reports. The format of these
reports is already set. These include:
• Scenario Summary provides a list of alternatives and calculation options associated with the scenario.

833
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Hydraulic summary provides a list of hydraulic options used such as friction method, duration and time step size.
• Water quality summary provides a list of water quality inputs. If the scenario is not a water quality scenario, then
this section is not included and a warning is written to the log file.
• Network inventory provides a list of each element type and the number of active elements of that type.
• Pressure Pipe inventory provides a list of the length of each size pipe sorted by material type.
• Lateral inventory provides a summary inventory showing the number of active laterals and the total length.
• Transient network inventory provides a list of the number of active transient specific elements by element type.
Report Options - The user can also control headers, footers, fonts, and margins in a separate dialog which can be
reached using Report > Report options or the Reports section of the ribbon. See the help for these setting.

Custom Reports - HAMMER Transient Results

In HAMMER you can add transient result sections to your custom reports. To access these sections you can use the
New button in the toolbar.
Go to Transient Results that appears on the menu. This will only appear if you currently have a scenario section
selected in the tree. You can also access these sections in the context menu of the scenario section.
Under transient results you have six available sections specific to transient results:
Profile and Data Table
This section provides a way to include a transient results profile or profile data table in your report. There are four
properties for the profile section and three properties for the profile data table section:
• Profile - Specify the profile to use in your report. This list is retrieved from the transient results output file. The
scenario (specified on the scenario node) must have results for this list to be populated. You must have at least one
profile in the profile manager marked as a Transient Report Path.
• Graph Type - You can specify several different graph types for the profile:
• Hydraulic Grade and Air/Vapor Volume
• Pressure and Ait/Vapor Volume
• Hydraulic Grade
• Pressure
• Velocity
• Air/Vapor Volume
• Width of Page Factor - determines how much of the space between the margins (in percent) is to be used for the
profile. The default value is 100% and values must be less than or equal to 100%. Applies only to the profile
section.
• Aspect Ratio - defines the width:height ratio of the graph. Applies only to the profile section.
• Alignment - determines the location of the graph within the margin for graphs less than 100% width. The acceptable
values are Left, Center and Right justified. Applies only to the profile section.
• Time from Start - This property specifies the time to use to generate the profile data table. If there is no animation
data available in the results then no times will be available to select and the default of 0.0 will be used. You can turn
on the option to generate animation data in the calculation options for the transient solver.
Time History Graph and Data Table
This section provides a way to include the graph or data table for the time history from the transient results. There are
five properties for this time history graph section two properties for the time history data table section:

834
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Additional Scenarios - this property allows you to select additional scenarios beyond the scenario section
selected scenario. You can select any scenario, with or without results, except for the one that is selected for the
scenario section. Applies to both time history graph and time history data table sections.
• Time History - select the report point to use to generate the graph. This list is retrieved from the transient results
output file. The scenario (specified on the scenario node) must have results for this to be populated. In addition, you
must have the transient solver calculation options configured to include report points.
• Graph Type - There are several different graph types available for time history graphs:
• Hydraulic Grade, Flow and Air/Vapor Volume
• Pressure, Flow and Air/Vapor Volume
• Force X, Y, Z and Magnitude (must configure the transient solver calculation options to compute transient force)
• Hydraulic Grade
• Pressure
• Flow
• Air/Vapor Volume
• Velocity
• Force X
• Force Y
• Force Z
• Force Magnitude
• Force X, Y, and Z
• Hydraulic Grade and Flow
• Hydraulic Grade and Air/Vapor Volume
• Pressure and Flow
• Pressure and Air/Vapor Volume
• Flow and Air/Vapor Volume
• Width of Page Factor - determines how much of the space between the margins (in percent) is to be used for the
graph. The default value is 100% and values must be less than or equal to 100%. Applies only to the time history
graph section.
• Aspect Ratio - defines the width:height ratio of the graph. Applies only to the time history graph section.
• Alignment - determines the location of the graph within the margin for graphs less than 100% width. The acceptable
values are Left, Center and Right justified. Applies only to the time history graph section.
Also note that any graph settings applied in the transient results viewer will be applied when generating the report. The
settings are saved on a graph type basis.
Extended Node Data Graph and Data Table
This section provides a way to include the graph or data table for extended node results. These results apply only to
certain elements and they must be included in the scenario calculation for these results to be available. These results are
only available for certain pumps, turbines and hydropneumatic tanks. There are five properties for the extended node
graph section and two properties for the extended node data table section.
• Additional Scenarios - this property allows you to select additional scenarios beyond the scenario section
selected scenario. You can select any scenario, with or without results, except for the one that is selected for the
scenario section. Applies to both extended node graph and extended node data table sections.
• Node - this is the list of nodes that have extended node results available and were included in the transient analysis.
Element types include pumps, turbines and hydropneumatic tanks.
• Graph Type - The available graph types depends on the selected node:
• Pumps

835
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Speed
• Turbines
• Speed
• Wicket Gate Position
• Hydropneumatic Tanks
• Gas Volume
• Gas Pressure
• Water Inflow
• Width of Page Factor - determines how much of the space between the margins (in percent) is to be used for the
graph. The default value is 100% and values must be less than or equal to 100%. Applies only to the extended node
data graph section.
• Aspect Ratio - defines the width:height ratio of the graph. Applies only to the time extended node data graph
section.
• Alignment - determines the location of the graph within the margin for graphs less than 100% width. The acceptable
values are Left, Center and Right justified. Applies only to the extended node data graph section.

Graphing
Use graphing to visualize some aspect of your model, such as element properties or results. You need to compute your
model before you can create graphs. To compute your model, after you set up your elements and their properties, click
the Compute button.
Click one of the following links to learn more about using graphs in WaterGEMS CONNECT:

Graph Manager
The Graph Manager lets you recall a graph you have created and saved in the current session or in a previous session of
WaterGEMS . Graphs listed in the Graph Manager retain any customizations you have applied.
To use the Graph Manager:
1. Compute your model and resolve any errors. (Press F9 or click Analysis > Compute.)
2. Open the Graph Manager, click View > Graphs.
3. Create your graph.
4. After you create a graph, it is available in the Graph Manager. You can select it by double-clicking it.
Graphs are not saved in Graph Manager after you close WaterGEMS .
The Graph Manager contains a toolbar with the following buttons:

New Inserts a new graph of the currently

selected elements in your model. If no
elements are selected, you are
prompted to select one or more
elements to graph.

Delete Deletes the currently highlighted

graph.

836
WaterGEMS CONNECT Edition Help
Presenting Your Results

Rename Lets you rename the currently

highlighted graph.

View Opens the Graph dialog box, allowing

you to view the currently highlighted
graph.

Add to Graph Opens a select from drawing toolbar

that allows you to select additional
elements from the drawing pane to
add to the graph.

Select In Drawing Selects the element(s) that are

included in the currently highlighted
graph in the drawing pane.

Expand All Expand all nodes in the tree.

Collapse All Collapse all nodes in the tree.

Sort When clicked, the graphs and folders

current in view are sorted in
alphabetical order. To sort graphs
within a folder, the folder must be in
expanded. The sort order is not saved.

Help Displays online help for the Graph

Manager.

Note: If the current scenario is steady-state (or the base condition for fire flow), the default graph is a bar chart
for the selected elements where the graph displays pressure if the type has a single pressure (junction, hydrant),
HGL for tanks and reservoirs), and flow for those elements which change pressure (e.g. pipes, control valves).

Graphs can now be organized in a hierarchical fashion by adding folders. You can drag-n-drop folders into other
folders or move graphs from one folder to another. When opening a previous model, all graphs will appear under
"Graphs".
When you right-click Graphs, or another folder, you can create a new folder or add a new graph. The default graph type
is a line-series when adding a new graph from the right-click context menu.

Add to Graph Dialog Box

This dialog appears after you initiate an Add to Graph command and allows you to choose a previously defined graph
to add the element to.
Select the desired graph from the Add to: menu, then click OK. To cancel the command, click the Cancel button.

837
WaterGEMS CONNECT Edition Help
Presenting Your Results

Printing a Graph
To print a graph click

or click Print Preview

to view your graph then click print.

Working with Graph Data: Viewing and Copying

WaterGEMS lets you view the data that your graphs are based on. To view your data, create a graph, then, after the
Graph dialog box opens, click the Data tab.
You can copy this data to the Windows clipboard for use in other applications, such as word-processing software. To
copy this data:
1. Click in the top-most cell of the left-most column to select the entire table, click a column heading to select an
entire column, or click a row heading to select an entire row.
2. Press Ctrl+C to copy the selected data to the clipboard.
3. As needed, press Ctrl+V to paste the data as tab-delimited text into other software.
4. To print out the data for a graph, copy and paste it into another application, such as word-processing software or
Notepad, and print the pasted content.

Graph Dialog Box

The Graph dialog box allows you to view graphs and modify graph settings as desired. After you create a graph, you
view it in the Graph dialog box.
The following controls are available:

838
WaterGEMS CONNECT Edition Help
Presenting Your Results

Graph Tab

Add to Graph Manager Lets you save the Graph to the graph
manager. When you click this button,
the graph options (i.e., attributes to
graph for a specific scenario) and the
graph settings (i.e., line color, font
size) are saved with the graph. If you
want to view a different set of data
(for example, a different scenario),
you must change the scenario in the
Graph Series Options dialog box.
Simply switching the active scenario
will not change the graph. Graphs that
you add to the Graph manager are
saved when you save your model, so
that you can use the graph after you
close and reopen WaterGEMS .

Add to Graph Opens a Select toolbar to allow you to

select one or more elements from the
drawing to add to the current graph.

Select In Drawing Selects the currently graphed element

in the drawing view.

839
WaterGEMS CONNECT Edition Help
Presenting Your Results

Graph Tab

Series Options Opens a submenu containing the

following options:
• Series Options: Lets you control
what your graph displays. For
more information, see Graph
Series Options Dialog Box .
• Chart Options: Opens the Chart
Options dialog box, allowing you
to change graph display settings.
• Observed Data: Opens the
Observed Data dialog box,
allowing you to display user-
supplied time variant data values
alongside calculated results in the
graph display dialog.
• Show Title: Toggles the display of
the graph title On/Off.
• Show Legend: Toggles the display
of the graph legend On/Off.
• Save Chart Options as Default:
Saves the current chart option
settings as the default that can be
used for new graphs.
• Apply Default Chart Options:
Uses the chart options that were
saved previously using the Save
Chart Options as Default
command for the current graph.
• Restore Factory Default Chart
Options: Restores the original
factory default chart option
settings.

Print /Print Preview Opens a submenu offering the Print

and Print Preview commands. Print
prints the current view in the graph
display pane; Print Preview opens the
Print Preview Window , displaying
the graph exactly as it will be printed.

Copy Copies the current view in the graph

display pane to the Windows
Clipboard.

Zoom Extents Zooms out so that the entire graph is

displayed

840
WaterGEMS CONNECT Edition Help
Presenting Your Results

Graph Tab

Zoom Window Zooms in on a section of the graph.

When the tool is toggled on, you can
zoom in on any area of the graph by
clicking on the chart to the left of the
area to be zoomed, holding the mouse
button, then dragging the mouse to
the right (or, the opposite extent of
the area to be magnified) and
releasing the mouse button when the
area to be zoomed has been defined.
To zoom back out, click and hold the
mouse button, drag the mouse in the
opposite direction (right to left), and
release the mouse button.

Time (VCR) Controls Lets you evaluate plots over time. If

you click Restart, the Time resets to
zero and the vertical line that marks
time resets to the left edge of the
Graph display. If you click Pause, the
vertical line that moves across the
graph to mark time pauses, as does
the Time field. If you click Play, a
vertical line moves across the graph
and the Time field increments. The
following controls are also available:
Time —Displays the time location of
the vertical black bar in the graph
display. This is a read-only field, to
set a specific time, use the slider
button. Slider —Lets you set a
specific time for the graph. A vertical
line moves in the graph display and
intersects your plots to show the value
of the plot at a specific time. Use the
slider to set a specific time value.

Graph Display Pane Displays the graph.

Data Tab

841
WaterGEMS CONNECT Edition Help
Presenting Your Results

Graph Tab

Data Table 850_GraphDialog_002.bmp

The Data tab displays the data that
comprise your graphs. If there is more
than one item plotted, the data for
each plot is provided. You can copy
and paste the data from this tab to the
clipboard for use in other
applications, such as Microsoft Excel.
To select an entire column or row,
click the column or row heading. To
select the entire contents of the Data
tab, click the heading cell in the top-
left corner of the tab. Use Ctrl+C and
Ctrl+V to paste your data. The
column and row headings are not
copied.

The Data tab is shown below.

842
WaterGEMS CONNECT Edition Help
Presenting Your Results

Note: The chart tab of the graph will show all the detail possible, for all time step detail available, on each plotted
result line. For the data tab of graph the number of rows will correspond to the 'Increment' declared in the 'Time
Browser' toolbar window. If you set the 'Increment' choice to '<All>' the Data tab will show all possible reporting
points (all rows).

Graph Series Options Dialog Box

The Graph Series Options dialog box allows you to adjust the display settings for the graph. You can define the legend
labels, the scenario (or scenarios), and the attribute (or attributes) that are displayed in the graph.

843
WaterGEMS CONNECT Edition Help
Presenting Your Results

The Series Label Format field allows you to define how the series will be labeled in the legend of the graph. Clicking
the [>] button allows you to choose from predefined variables such as Field name and Element label.
The Scenarios pane lists all of the available scenarios. Check the box next to a scenario to display the data for that
scenario in the graph. The Expand All button opens all of the folders so that all scenarios are visible; the Collapse
button closes the folders.
The Elements pane lists all of the elements that will be displayed in the graph. The Expand All button expands the list
tree so that all elements are visible; the Collapse button collapses the tree.
The Fields pane lists all of the available input and output fields. Check the box next to a field to display the data for that
field type in the graph. The Expand All button opens all of the folders so that all fields are visible; the Collapse button
closes the folders. The Filter by Field Type button allows you to display only Input or Output fields in the list. Clicking
the [>] button opens a submenu that contains all of the available fields grouped categorically.
Normal graphs don't show any time varying results from transient simulation - all you can see are the extreme results
like Pressure (Maximum, Transient). To see these time-varying results you will need to use the Transient Results
Viewer.
The Show this dialog on profile creation check box is enabled by default; uncheck this box to skip this dialog when a
new profile is created.
For any given element, the most commonly used fields are displayed underneath a Common folder, colored blue (see
screenshot above). To graph all of these attributes you can simply check the Common box.

Observed Data Dialog Box

Use this feature to display user-supplied time variant data values alongside calculated results in the graph display
dialog. Model competency can sometimes be determined by a quick side by side visual comparison of calculated results
with those observed and collection in the field.

844
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Get familiar with your data - If you obtained your observed data from an outside source, you should take the time to
get acquainted with it. Be sure to identify units of time and measurement for the data. Be sure to identify what the
data points represent in the model; this helps in naming your line or bar series as it will appear in the graph.
• Preparing your data - Typically, observed data can be organized as a collection of points in a table. In this case, the
time series data can simply be copied to the clipboard directly from the source and pasted right into the observed
data input table. Ensure that your collection of data points is complete. That is, every value must have an associated
time value. Oftentimes data points are stored in tab or comma delimited text files; these two import options are
available as well. See the Sample Observed Data Source (on page 845) topic for an example of the observed data
source file format.
• Specifying the characteristics of your data - The following charecteristics must be defined:
• Observed data can only be saved if the graph is saved.

Note: Go to Tools > Tools > More... >Options > Units for a complete list of formats.

To create Observed Data

1. Click New

.
2. Set hours, dimension, and formatter.
3. Add hours and Y information (or import a .txt or .csv file

).
4. Click Graph

to view the Observed data.

5. Click Close.

Sample OBSERVED Data Source

Below is an example of an Observed Data source for import and graph comparison. The following table contains a flow
meter data collection retreived in the field for a given pipe. We will bring this observed data into the model for a quick
visual inspection against our model's calculated pipe flows.

Time (hrs) Flow (gpm)

0.00 125

0.60 120

845
WaterGEMS CONNECT Edition Help
Presenting Your Results

Time (hrs) Flow (gpm)

3.00 110

9.00 130

13.75 100

18.20 125

21.85 110

With data tabulated as in the table above, we could simply copy and paste these rows directly into the table in the
Observed Data dialog. However if we had too many points to manage, natively exporting our data to a comma
delimited text file may be a better import option. Text file import is also a better option when our time values are not
formatted in units of time such as hours, as in the table below.

Time (24-hr clock) Flow (gpm)

00:00 125

00.36 120

03:00 110

09:00 130

13:45 100

18:12 125

21:51 110

Below is a sample of what a comma-delimited (*.csv) file would look like:

0:00,125
0:36,120
3:00,110
9:00,130
13:45,100
18:12,125
21:51,110

Note: Database formats (such as MS Access) are preferable to simple spreadsheet data sources. The sample
described above is intended only to illustrate the importance of using expected data formats.

To import the comma delimited data points:

1. Click the Import toolbar button from the Observed Data dialog.

846
WaterGEMS CONNECT Edition Help
Presenting Your Results

2. Pick the source .csv file.

3. Choose the Time Format that applies, in this case, HH:mm:ss, and click OK.

Chart Options Dialog Box

Use the Chart Options dialog box to format a graph.

Note: Changes you make to graph settings are not retained for use with other graphs.

To open Chart Options dialog box:

1. Open your hydraulic model and click Compute.
2. Select one or more elements, right-click, then select Graph.
3. Click the Chart Settings button.

Click one of the following links to learn more about Chart Options dialog box:

Chart Options Dialog Box - Chart Tab

The Chart tab lets you define overall chart display parameters. This tab is subdivided into second-level sub-tabs.

Panel Tab

Use the Panel tab to set how your graph appears in the Graph dialog box. The Panel tab includes the following sub-tabs:
Borders Tab
Use the Borders tab to set up a border around your graph. The Borders tab contains the following controls:

Border Lets you set the border of the graph. The Border Editor
opens, see Border Editor Dialog Box (on page 866).

Bevel Outer Lets you set a raised or lowered bevel effect, or no bevel
effect, for the outside of the chart border.

Color Lets you set the color for the bevel effect that you use;
inner and outer bevels can use different color values.

Bevel Inner Lets you set a raised or lowered bevel effect, or no bevel
effect, for the inside of the chart border.

Size Lets you set a thickness for the bevel effect that you use;
inner and outer bevels use the same size value.

Background Tab
Use the Background tab to set a color or image background for your graph. The Background tab contains the following
controls:

847
WaterGEMS CONNECT Edition Help
Presenting Your Results

Color Lets you set a color for the background of your graph.
The Color Editor opens, see Color Editor Dialog Box (on
page 867).

Pattern Lets you set a pattern for the background of your graph.
The Hatch Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Transparent Makes the background of the graph transparent.

Background Image Lets you set an existing image as the background of the
graph. Click Browse , then select the image
(including .bmp, .tif, .jpg, .png,. and .gif). After you have
set a background image, you can remove the image from
the graph by clicking Clear . You can control the Style of
the background image: Stretch —Resizes the background
image to fill the entire background of the graph. Tile —
Repeats the background image as many times as needed
to fill the entire background of the graph. Center —Puts
the background image in the horizontal and vertical center
of the graph. Normal —Puts the background image in the
top-left corner of the graph.

Gradient Tab
Use the Gradient tab to create a gradient color background for your graph. The Gradient tab contains the following
subtabs and controls:

Format Tab

Visible Determines whether a gradient displays or not. Select this

check box to display a gradient you have set up, clear this
check box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes the

gradient to display from top to bottom, Horizontal
displays a gradient from right to left, and Backward/
Forward diagonal display gradients from the left and right
bottom corners to the opposite corner.

Angle Lets you customize the direction of the gradient beyond

the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient. Opens
the Color Editor dialog box.

848
WaterGEMS CONNECT Edition Help
Presenting Your Results

Middle Lets you select a middle color for your gradient. The
Color Editor opens. Select the No Middle Color check
box if you want a two-color gradient. Opens the Color
Editor dialog box.

End Lets you select the final color for your gradient. Opens
the Color Editor dialog box.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear this
check box to change the brightness of the background on-
screen. This does not affect printed output.

Transparency Lets you set transparency for your gradient, where 100 is
completely transparent and 0 is completely opaque.

Options Tab

Sigma Lets you set the location on the chart background of the
gradient’s end color.

Sigma Focus Lets you use the options controls. Select this check box to
use the controls in the Options tab.

Sigma Scale Lets you control how much of the gradient’s end color is
used by the gradient background.

Shadow Tab
Use the Shadow tab to create a shadow for your graph. The Shadow tab contains the following controls:

Visible Lets you display a shadow for your graph. Select this
check box to display the shadow, clear this check box to
turn off the shadow effect.

Size Set the size of the shadow by increasing or decreasing the

numbers for Horizontal and/or Vertical Size.

Color Lets you set a color for the shadow of your graph. You
might set this to gray but can set it to any other color.

Pattern Lets you set a pattern for the shadow of your graph. The
Hatch Brush Editor opens, see Hatch Brush Editor Dialog
Box.

Transparency Lets you set transparency for your shadow, where 100 is
completely transparent and 0 is completely opaque.

General Tab

849
WaterGEMS CONNECT Edition Help
Presenting Your Results

Use the General tab to preview a graph before you print it and set up scrolling and zooming for a graph. It includes the
following controls:

Print Preview Lets you see the current view of the document as it will
be printed and lets you define the print settings, such as
selecting a printer to use. Opens the Print Preview dialog
box.

Margins Lets you specify margins for your graph. There are four
boxes, each corresponding with the top, bottom, left, and
right margins, into which you enter a value that you want
to use for a margin.

Units Lets you set pixels or percentage as the units for your
margins. Percentage is a percentage of the original graph
size.

Cursor Lets you specify what your cursor looks like. Select a
cursor type from the drop-down list, then click Close to
close the TeeChart editor, and the new cursor style
displays when the cursor is over the graph.

Zoom Tab
Use the Zoom tab to set up zooming on, magnifying, and reducing the display of a graph. The Zoom tab contains the
following controls:

Allow Lets you magnify the graph by clicking and dragging with
the mouse.

Animated Lets you set a stepped series of zooms.

Steps Lets you set the number of steps used for successive
zooms if you selected the Animated check box.

Pen Lets you set the thickness of the border for the zoom
window that surrounds the magnified area when you click
and drag. The Border Editor opens, see Border Editor
Dialog Box (on page 866).

Pattern The Hatch Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Minimum pixels Lets you set the number of pixels that you have to click
and drag before the zoom feature is activated.

Direction Lets you zoom in the vertical or horizontal planes only, as

well as both planes.

Mouse Button Lets you set the mouse button that you use to click and
drag when activating the zoom feature.

850
WaterGEMS CONNECT Edition Help
Presenting Your Results

Scroll Tab
Use the Scroll tab to set up scrolling and panning across a graph. The Scroll tab contains the following controls:

Allow Scroll Lets you scroll and pan over the graph. Select this check
box to turn on scrolling, clear the check box to turn it off.

Mouse Button Lets you set the mouse button that you click to use the
scroll feature.

Paging Tab

Use the Paging tab to display your graph over several pages. The Paging tab contains the following controls:

Points per Page Lets you scale the graph to fit on one or many pages. Set
the number of points you want to display on a single page
of the graph, up to a maximum of 100.

Scale Last Page Scales the end of the graph to fit the last page.

Current Page Legend Shows only the current page items when the chart is
divided into multiple pages.

Show Page Number Lets you display the current page number on the graph.

Arrows Lets you navigate through a multi-page graph. Click the

single arrows to navigate one page at a time. Click the
double arrows to navigate directly to the last or first pages
of the graph.

Legend Tab

Use the Legend tab to display and format a legend for your graph. The Legend tab includes the following controls:
Style Tab
Use the Style tab to set up and display a legend for your graph. The Style tab contains the following controls:

Visible Lets you show or hide the legend for your graph.

Inverted Lets you draw legend items in the reverse direction.

Legend strings are displayed starting at top for Left and
Right Alignment and starting at left for Top and Bottom
Legend orientations.

Check boxes Activates/deactivates check boxes associated with each

series in the Legend. When these boxes are unchecked in
the legend, the associated series are invisible.

Font Series Color Sets text in the legend to the same color as the graph
element to which it applies.

851
WaterGEMS CONNECT Edition Help
Presenting Your Results

Legend Style Lets you select what appears in the legend.

Text Style Lets you select how the text in the legend is aligned and
what data it contains.

Vert. Spacing Controls the space between rows in the legend.

Dividing Lines Lets you use and define lines that separate columns in the
legend. The Border Editor opens, see Border Editor
Dialog Box (on page 866).

Position Tab
Use the Position tab to control the placement of the legend. The Position tab contains the following controls:

Position Lets you place the legend on the left, top, right, or bottom
of the chart.

Resize Chart Lets you resize your graph to accommodate the legend. If
you do not select this check box, the graph and legend
might overlap.

Margin Lets you set the amount of space between the graph and
the legend.

Position Offset % Determines the vertical size of the Legend. Lower values
place the Legend higher up in the display

Custom Lets you use the Left and Top settings to control the
placement of the legend. xxxx seems broken

Left/Top Lets you enter a value for custom placement of the

legend.xxxx seems broken

Symbols Tab
Use the Symbols tab to add to the legend symbols that represent the series in the graph. The Symbols tab contains the
following controls:

Visible Lets you display the series symbol next to the text in the
legend.

Width Lets you resize the symbol that displays in the legend.
You must clear Squared to use this control.

Width Units Lets you set the units that are used to size the width of the
symbol.

Default border Lets you use the default TeeChart format for the symbol.
If you clear this check box, you can set a custom border
using the Border button.

852
WaterGEMS CONNECT Edition Help
Presenting Your Results

Border Lets you set a custom border for the symbols. You must
clear Default Border to use this option. The Border Editor
opens, see Border Editor Dialog Box (on page 866).

Position Lets you put the symbol to the left or right of its text.

Continuous Lets you attach or detach legend symbols. If you select

this check box, the color rectangles of the different items
are attached to each other with no vertical spacing. If you
clear this check box, the legend symbols are drawn as
separate rectangles.

Squared Lets you override the width of the symbol, so you can
make the symbol square shaped.

Format Tab
Use the Format tab to set and format the box that contains the legend. The Format tab contains the following controls:

Color Lets you set a color for the fill of the legend’s box. The
Color Editor opens, see Color Editor Dialog Box (on page
867).

Frame Lets you define the outline of the legend’s box. The
Border Editor opens, see Border Editor Dialog Box (on
page 866).

Pattern Lets you set a pattern for the fill of the legend’s box. The
Hatch Brush Editor opens, see Hatch Brush Editor Dialog
Box.

Round Frame Lets you round the corners of the legend’s box. Select this
check box to round the corners of the shape.

Transparent Lets you set the fill of the legend’s box as transparent. If
the shape is completely transparent, you cannot see it, so
clear this check box if you cannot see a shape that you
expect to see.

Transparency Lets you set transparency for the legend’s box, where 100
is completely transparent and 0 is completely opaque.

Text Tab
Use the Text tab to format the text used in the legend. The Text tab contains the following controls:

Font Lets you set the font properties for the text. This opens
the Windows Font dialog box.

853
WaterGEMS CONNECT Edition Help
Presenting Your Results

Color Lets you select the color for the text. Double-click the
colored square between Font and Fill to open the Color
Editor dialog box (see Color Editor Dialog Box (on page
867)).

Fill Lets you set a pattern for the text. The Hatch Brush Editor
opens, see Hatch Brush Editor Dialog Box.

Shadow Lets you set a shadow for the text. Visible —Lets you
display a shadow for the text. Select this check box to
display the axis label shadow. Size —Lets you set the
location of the shadow. Use larger numbers to offset the
shadow by a large amount. Color —Lets you set a color
for the shadow. You might set this to gray but can set it to
any other color. The Color Editor opens. Pattern —Lets
you set a pattern for the shadow. The Hatch Brush Editor
opens. Transparency —Lets you set transparency for your
shadow, where 100 is completely transparent and 0 is
completely opaque.

Gradient Tab
Use the Gradient tab to create a gradient color background for your legend. The Gradient tab contains the following
controls:

Format Tab

Visible Sets whether a gradient displays or not. Select this check

box to display a gradient you have set up, clear this check
box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes the

gradient to display from top to bottom, Horizontal
displays a gradient from right to left, and Backward/
Forward diagonal display gradients from the left and right
bottom corners to the opposite corner.

Angle Lets you customize the direction of the gradient beyond

the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient. The
Color Editor opens. Select the No Middle Color check
box if you want a two-color gradient.

End Lets you select the final color for your gradient.

854
WaterGEMS CONNECT Edition Help
Presenting Your Results

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear this
check box to change the brightness of the background on-
screen. This does not affect printed output.

Transparency Lets you set transparency for your gradient, where 100 is
completely transparent and 0 is completely opaque.

Options Tab

Sigma Lets you use the options controls. Select this check box to
use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background of the
gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end color is
used by the gradient background.

Shadow Tab
Use the Shadow tab to create a shadow for the legend. The Shadow tab contains the following controls:

Visible Lets you display a shadow. Select this check box to

display the shadow, clear this check box to turn off the
shadow effect.

Size Set the size of the shadow by increasing or decreasing the

numbers for Horizontal and/or Vertical Size.

Color Lets you set a color for the shadow. You might set this to
gray but can set it to any other color. The Color Editor
opens, see Color Editor Dialog Box (on page 867).

Pattern Lets you set a pattern for the shadow. The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box.

Transparency Lets you set transparency for your shadow, where 100 is
completely transparent and 0 is completely opaque.

Bevels Tab
Use the Bevels tab to create a rounded effects for the legend. The Bevels tab contains the following controls:

Bevel Outer Lets you set a raised or lowered bevel effect, or no bevel
effect, for the background for the selected title.

Color Lets you set the color for the bevel effect that you use;
inner and outer bevels can use different color values.

855
WaterGEMS CONNECT Edition Help
Presenting Your Results

Bevel Inner Lets you set a raised or lowered bevel effect, or no bevel
effect, for the inside of the background for the selected
title.

Size Lets you set a thickness for the bevel effect that you use;
inner and outer bevels use the same size value.

3D Tab

Use the 3D tab to add a three-dimensional effect to your graph. The 3D tab contains the following controls:

3 Dimensions Lets you display the chart in three dimensions. Select this
check box to turn on three-dimensional display.

3D % Lets you increase or decrease the three-dimensional

effect. Set a larger percentage for more three-dimensional
effect, or a smaller percentage for less effect.

Orthogonal Lets you fix the graph in the two-dimensional work plane
or, if you clear this check box, lets you use the Rotation
and Elevation controls to rotate the graph freely.

Zoom Text Lets you magnify and reduce the size of the text in a
graph when using the zoom tool. clear this check box if
you want text, such as labels, to remain the same size
when you use the zoom tool.

Quality Lets you select how the graph displays as you manipulate
and zoom on it.

Clip Points Trims the view of a series to the walls of your graph’s
boundaries, to enhance the three-dimensional effect. Turn
this on to trim the graph. You only see this effect when
the graph is in certain rotated positions.

Zoom Lets you magnify and reduce the display of the graph in
the Graph dialog box.

Rotation Lets you rotate the graph. You must clear Orthogonal to
use this control.

Elevation Lets you rotate the graph. You must clear Orthogonal to
use this control.

Horiz. Offset Lets you adjust the left-right position of the graph.

Vert. Offset Lets you adjust the up-down position of the graph.

Perspective Lets you rotate the graph. You must clear Orthogonal to
use this control.

856
WaterGEMS CONNECT Edition Help
Presenting Your Results

Chart Options Dialog Box - Series Tab

Use the Series tab to set up how the series in your graph display. Select the series you want to edit from the drop-down
list at the top of the Series tab.
The Series tab is organized into second-level sub-tabs:

Format Tab

Use the Format tab to set up how the selected series appears. The Format tab contains the following controls:

Border Lets you format the graph of the selected series. The
Border Editor opens, see Border Editor Dialog Box (on
page 866).

Color Lets you set a color for the graph of the selected series.
The Color Editor opens, see Color Editor Dialog Box (on
page 867).

Pattern Lets you set a pattern for the graph of the selected series.
This might only be visible on a three-dimensional graph
(see 3D Tab (on page 856)). The Hatch Brush Editor
opens, see Hatch Brush Editor Dialog Box.

Dark 3D Lets you automatically darken the depth dimension for

visual effect.

Color Each Assigns a different color to each series indicator.

Clickable This is unused by WaterGEMS CONNECT.

Color Each line Lets you enable or disable the coloring of connecting
lines in a series. This is unused by WaterGEMS
CONNECT.

Height 3D Lets you set a thickness for the three-dimensional effect

in three-dimensional graphs.

Stack Lets you control how multiple series display in the Graph
dialog box. None —Draws the series one behind the
other. Overlap —Arranges multiple series with the same
origin using the same space on the graph such that they
might overlap several times. Stack —Lets you arrange
multiple series so that they are additive. Stack 100% —
Lets you review the area under the graph curves.

Transparency Lets you set transparency for your series, where 100 is
completely transparent and 0 is completely opaque.

Stairs Lets you display a step effect between points on your

graph.

857
WaterGEMS CONNECT Edition Help
Presenting Your Results

Inverted Inverts the direction of the stairs effect

Outline Displays an outline around the selected series. The Border

Editor opens.

Point Tab

Use the Point tab to set up how the points that make up the selected series appear. The Point tab contains the following
controls:

Visible Lets you display the points used to create your graph.

3D Lets you display the points in three dimensions.

Dark 3D Lets you automatically darken the depth dimension for

visual effect.

Inflate Margins Adjusts the margins of the points to display points that are
close to the edge of the graph. If you clear this option,
points near the edge of the graph might only partly
display.

Pattern Lets you set a pattern for the points in your series. The
Hatch Brush Editor opens, see Hatch Brush Editor Dialog
Box. You must clear Default to use this option.

Default Lets you select the default format for the points in your
series. This overrides any pattern selection.

Color Each Assigns a different color to each series indicator.

Style Lets you select the shape used to represent the points in
the selected series.

Width/Height Lets you set a size for the points in the selected series.

Border Lets you set the outline of the shapes that represent the
points in the selected series. The Border Editor opens, see
Border Editor Dialog Box (on page 866).

Transparency Lets you set transparency for the points in the selected
series, where 100 is completely transparent and 0 is
completely opaque.

General Tab

Use the General tab to modify basic formatting and relationships with axes for series in a graph. The General tab
contains the following controls:

858
WaterGEMS CONNECT Edition Help
Presenting Your Results

Show in Legend Lets you show the series title in the legend. To use this
feature, the legend style has to be Series or LastValues.

Cursor Lets you specify what your cursor looks like. Select a
cursor type from the drop-down list, then click Close to
close the TeeChart editor, and the new cursor style
displays when the cursor is over the graph.

Depth Lets you set the depth of the three-dimensional effect (see
3D Tab (on page 856)).

Auto Lets you automatically size the three-dimensional effect.

clear and then select this check box to reset the depth of
the three-dimensional effect.

Values Controls the format of the values displayed when marks

are on and they contain actual numeric values

Percents Controls the format of the values displayed when marks

are on and they contain actual numeric values.

Horizontal Axis Lets you define which axis belongs to a given series,
since you can have multiple axes in a chart.

Vertical Axis Lets you define which axis belongs to a given series,
since you can have multiple axes in a chart.

Date Time This is unused by WaterGEMS CONNECT.

Sort Sorts the points in the series using the labels list.

Data Source Tab

Use this tab to connect a TeeChart series to another chart, table, query, dataset, or Delphi database dataset.
This lets you set the number of random points to generate and overrides the points passed by WaterGEMS CONNECT
to the chart control. The Data Source feature can be useful in letting you set its sources as functions and do calculations
between the series created by WaterGEMS CONNECT.
• Random—xxxx not sure
• Number of sample values—xxxx not sure
• Default—xxxx not sure
• Apply—xxxx not sure

Marks Tab

Use the Marks tab to display labels for points in the selected series. Series-point labels are called marks. The Marks tab
contains the following tabs and controls:
Style Tab
Use the Style tab to set how the marks display. The Style tab contains the following controls:

859
WaterGEMS CONNECT Edition Help
Presenting Your Results

Visible Lets you display marks.

Clipped Lets you display marks outside the graph border. clear
this check box to let marks display outside the graph
border, or select it to clip the marks to the graph border.

Multi-line Lets you display marks on more than one line. Select this
check box to enable multi-line marks.

All Series Visible Lets you display marks for all series.

Style Lets you set the content of the marks.

Draw every Sets the interval of the marks that are displayed. Selecting
2 would display every second mark, and 3 would display
every third, etc.

Angle Lets you rotate the marks for the selected series.

Arrow Tab
Use the Arrow tab to display a leader line on the series graph to indicate where the mark applies. The Arrow tab
contains the following controls:

Border Lets you set up the leader line. The Border Editor opens,
see Border Editor Dialog Box (on page 866).

Pointer Lets you set up the arrow head (if any) used by the leader
line. The Pointer dialog box opens, see Pointer Dialog
Box (on page 870).

Arrow head Lets you select the kind of arrow head you want to add to
the leader line.

Size Lets you set the size of the arrow head.

Length Lets you set the size of the leader line and arrow head, or
just the leader line if there is no arrow head.

Distance Lets you set the distance between the leader line and the
graph of the selected series.

Format Tab
Use the Format tab to set and format the boxes that contains the marks. The Format tab contains the following controls:

Color Lets you set a color for the fill of the boxes. The Color
Editor opens, see Color Editor Dialog Box (on page
867).

860
WaterGEMS CONNECT Edition Help
Presenting Your Results

Frame Lets you define the outline of the boxes. The Border
Editor opens, see Border Editor Dialog Box (on page
866).

Pattern Lets you set a pattern for the fill of the boxes. The Hatch
Brush Editor opens, see Hatch Brush Editor Dialog Box.

Round Frame Lets you round the corners of the boxes. Select this check
box to round the corners of the shape.

Transparent Lets you set the fill of the boxes as transparent. If the
shape is completely transparent, you cannot see it, so
clear this check box if you cannot see a shape that you
expect to see.

Transparency Lets you set transparency for the boxes, where 100 is
completely transparent and 0 is completely opaque.

Text Tab
Use the Text tab to format the text used in the marks. The Text tab contains the following controls:

Font Lets you set the font properties for the text. This opens
the Windows Font dialog box.

Color Lets you select the color for the text. Double-click the
colored square between Font and Fill to open the Color
Editor dialog box (see Color Editor Dialog Box (on page
867)).

Fill Lets you set a pattern for the text. The Hatch Brush Editor
opens, see Hatch Brush Editor Dialog Box.

Shadow Lets you set a shadow for the text. Visible —Lets you
display a shadow for the text. Select this check box to
display the axis label shadow. Size —Lets you set the
location of the shadow. Use larger numbers to offset the
shadow by a large amount. Color —Lets you set a color
for the shadow. You might set this to gray but can set it to
any other color. The Color Editor opens. Pattern —Lets
you set a pattern for the shadow. The Hatch Brush Editor
opens. Transparency —Lets you set transparency for your
shadow, where 100 is completely transparent and 0 is
completely opaque.

Gradient Tab
Use the Gradient tab to create a gradient color background for your marks. The Gradient tab contains the following
subtabs and controls:

Format Tab

861
WaterGEMS CONNECT Edition Help
Presenting Your Results

Visible Sets whether a gradient displays or not. Select this check

box to display a gradient you have set up, clear this check
box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes the

gradient to display from top to bottom, Horizontal
displays a gradient from right to left, and Backward/
Forward diagonal display gradients from the left and right
bottom corners to the opposite corner.

Angle Lets you customize the direction of the gradient beyond

the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient. The
Color Editor opens. Select the No Middle Color check
box if you want a two-color gradient.

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear this
check box to change the brightness of the background on-
screen. This does not affect printed output.

Transparency Lets you set transparency for your gradient, where 100 is
completely transparent and 0 is completely opaque.

Options Tab

Sigma Lets you use the options controls. Select this check box to
use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background of the
gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end color is
used by the gradient background.

Shadow Tab
Use the Shadow tab to create a shadow for the marks. The Shadow tab contains the following controls:

Visible Lets you display a shadow. Select this check box to

display the shadow, clear this check box to turn off the
shadow effect.

Size Set the size of the shadow by increasing or decreasing the

numbers for Horizontal and/or Vertical Size.

862
WaterGEMS CONNECT Edition Help
Presenting Your Results

Color Lets you set a color for the shadow. You might set this to
gray but can set it to any other color. The Color Editor
opens, see Color Editor Dialog Box (on page 867).

Pattern Lets you set a pattern for the shadow. The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box.

Transparency Lets you set transparency for your shadow, where 100 is
completely transparent and 0 is completely opaque.

Bevels Tab
Use the Bevels tab to create a rounded effects for your marks. The Bevels tab contains the following controls:

Bevel Outer Lets you set a raised or lowered bevel effect, or no bevel
effect, for the background for the selected title.

Color Lets you set the color for the bevel effect that you use;
inner and outer bevels can use different color values.

Bevel Inner Lets you set a raised or lowered bevel effect, or no bevel
effect, for the inside of the background for the selected
title.

Size Lets you set a thickness for the bevel effect that you use;
inner and outer bevels use the same size value.

Chart Options Dialog Box - Tools Tab

Use the Tools tab to add special figures in order to highlight particular facts on a given chart. For more information, see
Chart Tools Gallery Dialog Box-1370 (on page 871). The Tools tab contains the following controls:

Add Lets you add a tool from the Chart Tools Gallery. To be
usable in the current graph, a tool needs to be added and
set to Active.

Delete Deletes the selected tool from the list of those available in
the current graph.

Active Activates a selected tool for the current graph. To be

usable in the current graph, a tool needs to be added and
set to Active.

Up/Down arrow These are unused by WaterGEMS CONNECT.

Note: Each tool has its own parameters, see Chart Tools Gallery Dialog Box (on page 871).

Chart Options Dialog Box - Export Tab

863
WaterGEMS CONNECT Edition Help
Presenting Your Results

Use the Export tab to save your graph for use in another application. The Export tab contains the following controls:

Copy Lets you copy the contents of the graph to the Windows
clipboard, so you can paste it into another application.
You must consider the type of data you have copied when
choosing where to paste it. For example, if you copy a
picture, you cannot paste it into a text editor, you must
paste it into a photo editor or a word processor that
accepts pictures. Similarly, if you copy data, you cannot
paste it into an image editor, you must paste it into a text
editor or word processor.

Save Lets you create a new file from the contents of the graph.

Picture Tab
Use the Picture tab to save your graph as a raster image or to copy the graph as an image to the clipboard. The Picture
tab contains the following controls and subtabs:

Format Lets you select the format of the picture you want to save.
GIF, PNG, and JPEG are supported by the Worldwide
Web, a metafile is a more easily scalable format. A
Bitmap is a Microsoft BMP file that is widely supported
on Windows operating systems, whereas TIFF pictures
are supported on a variety of Microsoft and non-
Microsoft operating systems.

Options Tab

Colors Lets you use the default colors used by your graph or to
convert the picture to use grayscale. This feature is used
when you save the picture as a file, not by the copy
option.

Size Tab

Width/Height Lets you change the width and height of the picture.
These values are measured in pixels and are used by both
the Save and Copy options

Keep aspect ratio Lets you keep the relationship between the height and
width of the picture the same when you change the image
size. If you clear this check box, you can distort the
picture by setting height or width sizes that are not
proportional to the original graph.

Note: Changing the size of a graph using these controls might cause some loss of quality in the image. Instead, try
saving the graph as a metafile and resizing the metafile after you paste or insert it into its destination.

Native Tab
The Native tab contains the following controls:

864
WaterGEMS CONNECT Edition Help
Presenting Your Results

Include Series Data This is unused by WaterGEMS CONNECT.

File Size Displays the size of an ASCII file containing the data
from the current graph.

Data Tab
The Data tab contains the following controls:

Series Lets you select the series from which you copy data.

Format Lets you select a file type to which you can save the data.
This is not used by the Copy function.

Include Select the data you want to copy.

Text separator Lets you specify how you want rows of data separated.
This is supported by the Save function and only by the
Copy function if you first saved using the text separator
you have selected, before you copy.

Chart Options Dialog Box - Print Tab

Use the Print tab to preview and print your graph. The Print tab contains the following controls and subtabs:

Printer Lets you select the printer you want to use.

Setup Lets you configure the printer you want to use. For
example, if the selected printer supports printing on both
sides of a page, you might want to turn on this feature.

Print Prints the displayed graph to the selected printer.

Page Tab

Orientation Lets you set up the horizontal and vertical axes of the
graph. Many graphs print better in Landscape orientation
because of their width:height ratio.

Zoom Lets you magnify the graph as displayed in the print

preview window. Use the scrollbars to inspect the graph if
it doesn’t fit within the preview window after you zoom.
Changing the zoom does not affect the size of the printed
output.

Margins Lets you set up top, bottom, left, and right margins that
are used when you print.

Margin Units Lets you set the units used by the Margins controls:
percent or hundredths of an inch.

865
WaterGEMS CONNECT Edition Help
Presenting Your Results

Format Tab

Print Background When checked, prints the background of the graph.

Quality You do not need to change this setting. The box is cleared
by default.

Proportional Lets you change the graph from proportional to non-

proportional. When you change this setting, the preview
pane is automatically updated to reflect the change. This
box is checked by default.

Grayscale Prints the graph in grayscale, converting colors into

shades of gray.

Detail Resolution Lets you adjust the detail resolution of the printout. Move
the slider to adjust the resolution.

Preview Pane Displays a small preview of the graph printout.

Border Editor Dialog Box

The Border Editor dialog box lets you define border properties for your graph. The Border Editor dialog box contains
the following controls:

Visible Displays or hides the border. Select this check box to

display the border.

Color Lets you select a color for the border. The Color Editor
dialog box opens, see Color Editor Dialog Box (on page
867).

Ending Lets you set the ending style of the border.

Dash Lets you select the dash style, if you have a selection
other than Solid set for the border style.

Width Lets you set the width of the border.

Style Lets you set the style for the border. Solid is an
uninterrupted line.

Transparency Lets you set transparency for your border, where 100 is
completely transparent and 0 is completely opaque.

Gradient Editor Dialog Box

Use the Gradient Editor dialog box to set a blend of two or three colors as the fill. Click OK to apply the selection. The
Gradient Editor contains the following controls and tabs:

866
WaterGEMS CONNECT Edition Help
Presenting Your Results

Format Tab

Visible Sets whether a gradient displays or not. Select this check

box to display a gradient you have set up, clear this check
box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes the

gradient to display from top to bottom, Horizontal
displays a gradient from right to left, and Backward/
Forward diagonal display gradients from the left and right
bottom corners to the opposite corner.

Angle Lets you customize the direction of the gradient beyond

the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient. The
Color Editor opens. Select the No Middle Color check
box if you want a two-color gradient.

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear this
check box to change the brightness of the background on-
screen. This does not affect printed output.

Transparency Lets you set transparency for your gradient, where 100 is
completely transparent and 0 is completely opaque.

Options Tab

Sigma Lets you use the options controls. Select this check box to
use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background of the
gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end color is
used by the gradient background.

To access the Gradient Editor dialog box, click Chart Settings in the Graph dialog box, then click the Tools tab. Select
the Axis tab and Color Band tool, then click the Gradient button.

Color Editor Dialog Box

Use the Color Editor dialog box to select a color. Click the basic color you want to use then click OK to apply the
selection. The Color Editor dialog box contains the following controls:

867
WaterGEMS CONNECT Edition Help
Presenting Your Results

Transparency Lets you set transparency for your color, where 100 is
completely transparent and 0 is completely opaque.

Custom Lets you define a custom color to use. The Color dialog
box opens, see Color Dialog Box (on page 868).

OK/Cancel Click OK to use the selection. Click Cancel to close the

dialog box without making a selection.

To access the Color Editor dialog box, click a Color button in the Chart Options dialog box.

Color Dialog Box

Use the Color dialog box to select a basic color or to define a custom color. After you select the color you want to use,
click OK to apply the selection.

Basic colors Lets you click a color to select it.

Custom colors Displays colors you have created and selected for use.

Color matrix Lets you use the mouse to select a color from a range of
colors displayed.

Color|Solid Displays the currently defined custom color.

Hue/Sat/Lum Lets you define a color by entering values for hue,

saturation, and luminosity.

Red/Green/Blue Lets you define a color by entering values of red, green,

and blue colors.

Add to Custom Colors Adds the current custom color to the Custom colors area.

To access the Color dialog box, click the Custom button in the Color Editor dialog box.

Hatch Brush Editor Dialog Box - Solid Tab

Use the Solid tab to set a solid color as the fill. The Solid tab contains the following controls:

Transparency Lets you set transparency for your color, where 100 is
completely transparent and 0 is completely opaque.

Custom Lets you define a custom color to use. The Color dialog
box opens, see Color Dialog Box (on page 868).

OK/Cancel Click OK to use the selection. Click Cancel to close the

dialog box without making a selection.

Hatch Brush Editor Dialog Box - Hatch Tab

868
WaterGEMS CONNECT Edition Help
Presenting Your Results

Use the Hatch tab to set a pattern as the fill. Click OK to apply the selection. The Hatch tab contains the following
controls:

Hatch Style Select the pattern you want to use. These display using
the currently selected background and foreground colors.

Background/Foreground Select the color you want to use for the background and
foreground of the pattern. This opens the Color Editor,
see Color Editor Dialog Box (on page 867).

% Lets you set transparency for your color, where 100 is

completely transparent and 0 is completely opaque.

Hatch Brush Editor Dialog Box - Gradient Tab

Use the Gradient tab to set a blend of two or three colors as the fill. Click OK to apply the selection. The Gradient tab
contains the following controls:

Format Tab

Visible Sets whether a gradient displays or not. Select this check

box to display a gradient you have set up, clear this check
box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes the

gradient to display from top to bottom, Horizontal
displays a gradient from right to left, and Backward/
Forward diagonal display gradients from the left and right
bottom corners to the opposite corner.

Angle Lets you customize the direction of the gradient beyond

the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient. The
Color Editor opens. Select the No Middle Color check
box if you want a two-color gradient.

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear this
check box to change the brightness of the background on-
screen. This does not affect printed output.

Transparency Lets you set transparency for your gradient, where 100 is
completely transparent and 0 is completely opaque.

869
WaterGEMS CONNECT Edition Help
Presenting Your Results

Options Tab

Sigma Lets you use the options controls. Select this check box to
use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background of the
gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end color is
used by the gradient background.

Hatch Brush Editor Dialog Box - Image Tab

Use the Image tab to select an existing graphic file or picture to use as the fill. Click OK to apply the selection. The
Image tab contains the following controls:

Browse Lets you navigate to then select the graphic file you want
to use. When selected, the graphic displays in the tab.

Style Lets you define how the graphic is used in the fill. Stretch
—Resizes the image to fill the usable space. Tile —
Repeats the image to fill the usable space. Center —Puts
the image in the horizontal and vertical center. Normal —
Puts the image in the top-left corner

Pointer Dialog Box

Use the Pointer dialog box to set up a pointers for use with leader lines. The Pointer dialog box contains the following
controls:

Visible Sets whether a pointer displays or not.

3D Lets you display the pointer in three dimensions.

Dark 3D Lets you automatically darken the depth dimension for

visual effect.

Inflate Margins Adjusts the margins of the pointers to display pointers

that are close to the edge of the graph. If you clear this
option, pointers near the edge of the graph might only
partly display.

Pattern Lets you set a pattern for the pointers. The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box. You
must clear Default to use this option.

Default Lets you select the default format for the pointers. This
overrides any pattern selection.

870
WaterGEMS CONNECT Edition Help
Presenting Your Results

Color Each Assigns a different color to each pointer.

Style Lets you select the shape used to represent the pointers.

Width/Height Lets you set a size for the pointers.

Border Lets you set the outline of the shapes that represent the
pointers. The Border Editor opens, see Border Editor
Dialog Box (on page 866).

Transparency Lets you set transparency for the pointers, where 100 is
completely transparent and 0 is completely opaque.

To access the Pointer dialog box, click Chart Settings in the Graph dialog box, then click Series > Marks > Arrow.

Change Series Title Dialog Box

Use the Change Series Title dialog box to change the title of a selected series. Type the new series title, then click OK
to apply the new name or Cancel to close the dialog box without making a change.
To access the Change Series title dialog box, click Chart Settings in the Graph dialog box, then click the Series tab,
then the Title button.

Chart Tools Gallery Dialog Box

Use the Chart Tools Gallery dialog box to add tools to your graph. For more information, see Chart Options Dialog Box
- Tools Tab (on page 863).
Click one of the following links to learn more about the Chart Tools Gallery dialog box:

Chart Tools Gallery Dialog Box - Series Tab

Use the Series tab to add tools related to the series in your chart. The Series tab contains the following tools:
Cursor
Displays a draggable cursor line on top of the series. After you have added the Cursor tool to your graph, you can
modify the following settings:

Series Lets you select the series to which you want to apply the
tool.

Style Lets you select a horizontal line, vertical line, or both as

the format of the tool.

Snap Causes the cursor tool to adhere to the selected series.

Follow Mouse Causes the cursor tool to follow your movements of the
mouse.

871
WaterGEMS CONNECT Edition Help
Presenting Your Results

Pen Lets you define the cursor tool. The Border Editor opens,
see Border Editor Dialog Box (on page 866).

Drag Marks
Lets you drag series marks. To use this tool, you must display the marks for a selected series, see Marks Tab (on page
859). After you have added the Drag Marks tool to your graph, you can modify the following settings:

Series Lets you select the series to which you want to apply the
tool.

Reset Positions Moves any marks you have dragged back to their original
position.

Drag Point
Lets you drag a series point. After you have added the Drag Point tool to your graph, you can modify the following
settings:

Series Lets you select the series to which you want to apply the
tool.

Style Lets you constrain the movement of the series point to

one axis or both (no constraint).

Mouse Button Lets you select the mouse button you click to drag.

Cursor Lets you select the appearance of the cursor when using
the tool.

Draw Line
Lets you draw a line on the graph by dragging. After you have added the Draw Line tool to your graph, you can modify
the following settings:

Series Lets you select the series to which you want to apply the
tool.

Pen Lets you define the line. The Border Editor opens, see
Border Editor Dialog Box (on page 866).

Button Lets you select the mouse button you click to drag.

Enable Draw Enables the Draw Line tool. Select this check box to let
you draw lines, clear it to prevent you from drawing lines.

Enable Select Lets you select and move lines that you have drawn.
Select this check box, then click and drag the line you
want to move. clear this check box if you want to prevent
lines from being moved.

Remove All Removes all lines you have drawn.

872
WaterGEMS CONNECT Edition Help
Presenting Your Results

Gantt Drag
Lets you move and resize Gantt bars by dragging. This is unused by WaterGEMS CONNECT.
Image
Displays a picture using the selected series axes as boundaries. After you have added the Image tool to your graph, you
can modify the following settings:

Series Lets you select the series to which you want to apply the
tool.

Browse Lets you navigate to and select the image you want to use.
Browse is unavailable when there is a selected image. To
select a new image, first clear the existing one.

Clear Lets you remove a selected image. Clear is unavailable

when there is no selected image.

Mode Lets you set up the image you select. Normal —Puts the
background image in the top-left corner of the graph.
Stretch —Resizes the background image to fill the entire
background of the graph. The image you select conforms
to the series to which you apply it. Center —Puts the
background image in the horizontal and vertical center of
the graph. Tile —Repeats the background image as many
times as needed to fill the entire background of the graph.

Mark Tips
Displays data in tooltips when you move the cursor over the graph. After you have added the Mark Tips tool to your
graph, you can modify the following settings:

Series Lets you select the series to which you want to apply the
tool

Style Lets you select what data the tooltips display.

Action Sets when the tooltips display. Select Click if you want
the tooltips to display when you click, or select Move if
you want the tooltips to display when you move the
mouse.

Delay Lets you delay how quickly the tooltip displays.

Nearest Point
Lets you define and display an indicator when you are near a point in the selected series. After you have added the
Nearest Point tool to your graph, you can modify the following settings:

Series Lets you select the series to which you want to apply the
tool.

873
WaterGEMS CONNECT Edition Help
Presenting Your Results

Fill Lets you set the fill for the nearest-point indicator. The
Hatch Brush Editor opens, see Hatch Brush Editor Dialog
Box.

Border Lets you set the outline of the nearest-point indicator. The
Border Editor opens, see Border Editor Dialog Box (on
page 866).

Draw Line Creates a line from the tip of the cursor to the series point.

Style Sets the shape for the indicator

Size Sizes the indicator.

Pie Slices
Outlines or expands slices of pie charts when you move the cursor or click them. This is unused by WaterGEMS
CONNECT.
Series Animation
Animates series points. After you have added the Series Animation tool to your graph, you can modify the following
settings:

Series Lets you select the series to which you want to apply the
tool.

Steps Lets you select the steps used in the animation. Set this
control towards 100 for smoother animation and away
from 100 for quicker, but less smooth animation.

Start at min. value Lets you start the animation at the series’ minimum value.
clear this check box to set your own start value.

Start value Sets the value at which the animation starts. To use this
control, you must clear Start at min. value .

Execute! Starts the animation.

Chart Tools Gallery Dialog Box - Axis Tab

Use the Axis tab to add tools related to the axes in your chart. The Axis tab contains the following tools:
Axis Arrows
Lets you add arrows to the axes. The arrows permit you to scroll along the axes. After you have added the Axis Arrows
tool to your graph, you can modify the following settings:

Axis Select the axis to which you want to add arrows.

Border Lets you set the outline of the arrows. The Border Editor
opens, see Border Editor Dialog Box (on page 866).

874
WaterGEMS CONNECT Edition Help
Presenting Your Results

Fill Lets you set the fill for the arrows. The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box.

Length Lets you set the length of the arrows.

Inverted Scroll Lets you change the direction in which the arrows let you
scroll.

Scroll Changes the magnitude of the scroll. Set a smaller

percentage to reduce the amount of scroll caused by one
click of an axis arrow, or set a larger percentage to
increase the amount of scroll caused by a click.

Position Lets you set an axis arrow at the start, end, or both
positions of the axis.

Color Band
Lets you apply a color band to your graph for a range of values you select from an axis. After you have added the Color
Band tool to your graph, you can modify the following settings:

Axis Select the axis that you want to use to define the range for
the color band.

Border Lets you set the outline of the color band. The Border
Editor opens, see Border Editor Dialog Box (on page
866).

Pattern Lets you set the fill of the color band. The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box.

Gradient Lets you set a gradient for the color band. A gradient
overrides any solid color fill you might have set. The
Gradient Editor opens, see Gradient Editor Dialog Box
(on page 866).

Color Lets you set a solid color for the color band. The Color
Editor opens, see Color Editor Dialog Box (on page 867).

Start Value Sets where the color band begins. Specify a value on the
selected axis.

End Value Sets where the color band ends. Specify a vale on the
selected axis.

Transparency Lets you set transparency for your color, where 100 is
completely transparent and 0 is completely opaque.

Draw Behind Lets you position the color band behind the graphs. If you
clear this check box, the color band appears in front of
your graphs and hides them, unless you have transparency
set.

875
WaterGEMS CONNECT Edition Help
Presenting Your Results

Color Line
Lets you apply a color line, or plane in three dimensions, at a point you set at a value on an axis. After you have added
the Color Line tool to your graph, you can modify the following settings:

Axis Select the axis that you want to use to define the location
for the line.

Border Lets you set the outline of the color line. The Border
Editor opens, see Border Editor Dialog Box (on page
866).

Value Sets where the color line is. Specify a value on the
selected axis.

Allow Drag Lets you drag the line or lock the line in place. Select this
check box if you want to permit dragging. clear this check
box if you want the line to be fixed in one location.

Drag Repaint Lets you smooth the appearance of the line as you drag it.

No Limit Drag Lets you drag the line beyond the axes of the graph, or
constrain the line to boundaries defined by those axes.
Select this check box to permit unconstrained dragging.

Draw Behind Lets you position the color line behind the graphs. If you
clear this check box, the color band appears in front of
your graphs. This is more noticeable in 3D graphs.

Draw 3D Lets you display the line as a 2D image in a 3D chart. If

you have a 3D chart (see 3D Tab (on page 856)), clear
this check box to display the line as a line rather than a
plane.

Chart Tools Gallery Dialog Box - Other Tab

Use the Other tab to add tools to your chart, including annotations. The Other tab contains the following tools:
3D Grid Transpose
Swaps the X and Z coordinates to rotate the series through 90 degrees. This is unused by WaterGEMS CONNECT.
Annotation
Lets you add text to the chart. After you have added the Annotation tool to your graph, you can modify the following
settings:

Options Tab

Text Lets you enter the text you want for your annotation.

Text alignment Sets the alignment of the text inside the annotation box.

876
WaterGEMS CONNECT Edition Help
Presenting Your Results

Cursor Lets you set the style of the cursor when you move it over
the annotation.

Position Tab

Auto Lets you select a standard annotation position.

Custom Lets you select a custom position for the annotation.

Select this check box to override the Auto setting and
enable the Left and Top controls.

Left/Top Lets you set a position from the Left and Top edges of the
graph tab for the annotation.

Callout Tab

Border Lets you set up the leader line. The Border Editor opens,
see Border Editor Dialog Box (on page 866).

Pointer Lets you set up the arrow head (if any) used by the leader
line. The Pointer dialog box opens, see Pointer Dialog
Box (on page 870).

Position Sets the position of the callout.

Distance Lets you set the distance between the leader line and the
graph of the selected series.

Arrow head Lets you select the kind of arrow head you want to add to
the leader line.

Size Lets you set the size of the arrow head.

Format Tab

Color Lets you set a color for the fill of the boxes. The Color
Editor opens, see Color Editor Dialog Box (on page 867).

Frame Lets you define the outline of the boxes. The Border
Editor opens.

Pattern Lets you set a pattern for the fill of the boxes. The Hatch
Brush Editor opens, see Hatch Brush Editor Dialog Box.

Round Frame Lets you round the corners of the boxes. Select this check
box to round the corners of the shape.

Transparent Lets you set the fill of the boxes as transparent. If the
shape is completely transparent, you cannot see it, so
clear this check box if you cannot see a shape that you
expect to see

877
WaterGEMS CONNECT Edition Help
Presenting Your Results

Transparency Lets you set transparency for the boxes, where 100 is
completely transparent and 0 is completely opaque.

Text Tab

Font Lets you set the font properties for text. This opens the
Windows Font dialog box.

Color Lets you select the color for the text font. Double-click
the colored square between Font and Fill to open the
Color Editor dialog box.

Fill Lets you set a pattern for the text font. The Hatch Brush
Editor opens.

Shadow Lets you set a shadow for the text. Visible —Lets you
display a shadow for the text. Select this check box to
display the shadow. Size —Lets you set the location of
the shadow. Use larger numbers to offset the shadow by a
large amount. Color —Lets you set a color for the
shadow. You might set this to gray but can set it to any
other color. The Color Editor opens. Pattern —Lets you
set a pattern for the shadow. The Hatch Brush Editor
opens. Transparency —Lets you set transparency for your
shadow, where 100 is completely transparent and 0 is
completely opaque.

Gradient Tab

Format Format —Lets you set up the gradient’s properties.

Visible —Sets whether a gradient displays or not. Select
this check box to display a gradient you have set up, clear
this check box to hide the gradient. Direction —Sets the
direction of the gradient. Vertical causes the gradient to
display from top to bottom, Horizontal displays a gradient
from right to left, and Backward/Forward diagonal
display gradients from the left and right bottom corners to
the opposite corner. Angle —Lets you customize the
direction of the gradient beyond the Direction selections.

878
WaterGEMS CONNECT Edition Help
Presenting Your Results

Colors Lets you set the colors used for your gradients. The Start,
Middle, and End selections open the Color Editor, see
Color Editor Dialog Box (on page 867). Start —Lets you
set the starting color for your gradient. Middle —Lets you
select a middle color for your gradient. The Color Editor
opens. Select the No Middle Color check box if you want
a two-color gradient. End —Lets you select the final color
for your gradient. Gamma Correction —Lets you control
the brightness with which the background displays to
your screen; select or clear this check box to change the
brightness of the background on-screen. This does not
affect printed output. Transparency —Lets you set
transparency for your gradient, where 100 is completely
transparent and 0 is completely opaque.

Options Lets you control the affect of the start and end colors on
the gradient, the middle color is not used. Sigma —Lets
you use the options controls. Select this check box to use
the controls in the Options tab. Sigma Focus —Lets you
set the location on the chart background of the gradient’s
end color. Sigma Scale —Lets you control how much of
the gradient’s end color is used by the gradient
background.

Shadow Tab

Visible Lets you display a shadow. Select this check box to

display the shadow, clear this check box to turn off the
shadow effect.

Size Set the size of the shadow by increasing or decreasing the

numbers for Horizontal and/or Vertical Size.

Color Lets you set a color for the shadow. You might set this to
gray but can set it to any other color. The Color Editor
opens.

Pattern Lets you set a pattern for the shadow. The Hatch Brush
Editor opens.

Transparency Lets you set transparency for your shadow, where 100 is
completely transparent and 0 is completely opaque.

Bevels Tab

Bevel Outer Lets you set a raised or lowered bevel effect, or no bevel
effect, for the outside of the legend.

Color Lets you set the color for the bevel effect that you use;
inner and outer bevels can use different color values.

879
WaterGEMS CONNECT Edition Help
Presenting Your Results

Bevel Inner Lets you set a raised or lowered bevel effect, or no bevel
effect, for the inside of the legend.

Size Lets you set a thickness for the bevel effect that you use;
inner and outer bevels use the same size value.

Page Number
Lets you add a page number annotation.
Rotate
Lets you rotate the chart by dragging. After you have added the Rotate tool to your graph, you can modify the
following settings:

Inverted Reverses the direction of the rotation with respect to the

direction you move the mouse.

Style Lets you rotate horizontally, vertically, or both. Rotation

is horizontal rotation about a vertical axis, whereas
elevation is vertical rotation about a horizontal axis.

Outline Lets you set the outline. The Border Editor opens, see
Border Editor Dialog Box (on page 866).

TeeChart Gallery Dialog Box

Use the TeeChart Gallery dialog box to change the appearance of a series.

880
WaterGEMS CONNECT Edition Help
Presenting Your Results

Series

The available series chart designs include:

• Standard
• Stats
• Financial
• Extended
• 3D
• Other
• View 3D—Lets you view the chart design in two or three dimensions. Select this check box to view the charts in
3D, clear it to view them in 2D.
• Smooth—Smooths the display of the charts. Select this check box to smooth the display, clear it to turn off
smoothing.

Functions

The available function chart designs include:

• Standard
• Financial
• Stats

881
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Extended
• View 3D—Lets you view the chart design in two or three dimensions. Select this check box to view the charts in
3D, clear it to view them in 2D.
• Smooth—Smooths the display of the charts. Select this check box to smooth the display, clear it to turn off
smoothing.

Customizing a Graph

882
WaterGEMS CONNECT Edition Help
Presenting Your Results

883
WaterGEMS CONNECT Edition Help
Presenting Your Results

884
WaterGEMS CONNECT Edition Help
Presenting Your Results

885
WaterGEMS CONNECT Edition Help
Presenting Your Results

886
WaterGEMS CONNECT Edition Help
Presenting Your Results

Quick Graph
The quick graph feature allows you to quickly view a graph of a single element in the drawing. The available fields
correspond to the common fields available for the selected element's type.

The quick graph is a docking window that can be docked to any of the sides or with another floating or docked window.
You can select the attribute to graph by choosing it from the drop-down list of common attributes or click the arrow
button next to it to see a complete categorized list of available attributes for the selected element.
The quick graph can also show the contents of a saved graph. To display a saved graph, open the Graphs Manager
(View > Graphs). Select any graph in the list. The graph is displayed in the quick graph window.
The dialog also includes the following buttons:

Open Graph Opens the full graph for the currently in the Quick Graph display.

Show X Axis This toggle allows you to turn on/off the X-Axis labels. This is
useful if you are using a time format that takes a lot of vertical
space.

Specify Y-Axis Limits Opens the Y-Axis Limits dialog, allowing you to specify a
custom minimum and maximum value for the Y-Axis.

887
WaterGEMS CONNECT Edition Help
Presenting Your Results

Help Opens the help.

Y-Axis Limits
The Y-Axis Limits dialog lets you specify a custom minimum and maximum value for the Y-Axis for Quick Graphs.

To change the minimum and/or maximum values, check the Specify Y-Axis Limits box and enter the values in the
Minimum and Maximum fields.
You can use the Calculate Range button to determine the best minimum and maximum values to use across all elements
of the selected type. Clicking the Calculate Range button opens a menu containing two options; the first is a Full Range
which will determine the actual minimum and maximum value for the selected field. Quick Range uses a quicker and
more approximate approach to determine the minimum and maximum values.

Time Series Field Data

The Time Series Field Data dialog allows you to enter your observed field data and compare it to the calculated results
from the model in graph format. This is especially useful in comparing time series data for model calibration.
Use this feature to display user-supplied time variant data values alongside calculated results in the graph display
dialog. Model competency can sometimes be determined by a quick side by side visual comparison of calculated results
with those observed in the field.
• Get familiar with your data - If you obtained your observed data from an outside source, you should take the time to
get acquainted with it. Be sure to identify units of time and measurement for the data. Be sure to identify what the
data points represent in the model; this helps in naming your line or bar series as it will appear in the graph. Each
property should be in a separate column in your data source file.
• Preparing your data - Typically, observed data can be organized as a collection of points in a table. In this case, the
time series data can simply be copied to the clipboard directly from the source and pasted right into the observed
data input table. Ensure that your collection of data points is complete. That is, every value must have an associated
time value. Oftentimes data points are stored in tab or comma delimited text files; these two import options are
available as well.
• Starting time series data entry - To create a time series data set, click the Component menu and select Time Series
Field Data. Pick the element type (e.g. Pipe, Junction) and select the New button on the top row of the dialog. (You
may also right click on the Element Type Name and click the Add button) You will then see the Select Associated

888
WaterGEMS CONNECT Edition Help
Presenting Your Results

Modeling Attribute dialog where you select the property (attribute) to be imported. Choose the attribute and click
OK. You may import any number of data sets for any Property and Element. The data set will have the default name
of Property-N (e.g. Flow - 1). To change the name, click the Rename button (third button along the top of the table).
• Specifying the characteristics of your data - The following charecteristics must be defined:
You can perform a quick graphical check on the data import by clicking the Graph button at the top of the data table.
If the number of observations is large, it is best to use the Copy/Paste commands. Copy the data from the original
source to the clipboard, then go to the top of the Time from Start or Property (e.g. Flow) column and hit CTRL-V to
paste the values into the appropriate column.
Click the Close button when done.
The data is saved with the model file. If you modify the source data file, the changes will not appear until time series
data is imported again.
To add the time series field data to a graph, first create the graph of the property from an EPS model run (e.g. right
click on element and pick Graph). In the Graph options dialog, select Time Series Field Data and then the name of the
time series (in the Field pane (right pane). The field data will appear in the graph as points (by default) while the model
results will appear as a continuous line. This can be changed using the Chart Settings button at the top of the graph
(third from left).

Select Associated Modeling Attribute Dialog Box

This dialog appears when you create a new field data set in the Time Series Field Data dialog. Choose the attribute
represented in the time series data source. The available attributes will vary depending on the element type chosen.

Calculation Summary

The calculation summary gathers useful information related to the state of the calculation (e.g. success/failure), status
messages for elements (e.g. pump on/off, tank full/empty), and the system flow results (e.g. flow demanded, flow
stored).

889
WaterGEMS CONNECT Edition Help
Presenting Your Results

The following controls are available in the Calculation Summary dialog box:
• Copy - Copies the calculation summary to the Windows clipboard.
• Report - Opens the Calculation Summary report.
• Graph - Opens the Calculation Summary Graph.
• Help - Opens the online help for this dialog.
• Show this dialog after Compute - When this box is checked, the Calculation Summary will open automatically
after every Compute operation, unchecking it will suppress this behavior.
The tabs below the time step table contain the following information:
• Information Tab: This tab displays any element messages for the currently selected time step.
• Status Messages Tab: This tab displays any status messages for the currently selected time step.
• Trials Tab: This tab displays the relative flow change for each of the trials for the currently selected time step.
• Run Statistics Tab: This tab displays calculation statistics such as the time the calculation was completed, how
long the calculation took to load and run, and the number of time steps, links, and nodes that were calculated.

Note: The stats displayed under this tab pertain only to Steady State and EPS runs. For fire flow and flushing
analysis the run times reported do not include the times for all the nodes to run, just the base Steady State run.

890
WaterGEMS CONNECT Edition Help
Presenting Your Results

To Obtain a Calculation Summary

1. Click Compute and the Calculation Summary Box will open.
or
2. From the Analysis Menu click Calculation Detailed Summary.

Calculation Summary Graph Series Options Dialog Box

The Calculation Summary Graph Series Options dialog box allows you to adjust the display settings for the calculation
summary graph. You can define the scenario (or scenarios), and the attribute (or attributes) that are displayed in the
graph.
The Scenarios pane lists all of the available scenarios. Check the box next to a scenario to display the data for that
scenario in the graph. The Expand All button opens all of the folders so that all scenarios are visible; the Collapse
button closes the folders.
The Fields pane lists all of the available output fields. Check the box next to a field to display the data for that field type
in the graph. The Expand All button opens all of the folders so that all fields are visible; the Collapse button closes the
folders.

Transients Results Viewer Dialog

Note: This dialog is available in HAMMER only.

The Transient Results Viewer dialog allows you to view profile and time-series graph results from transient
simulations. The Plots and Animations displayed by the Transient Results Viewer differ from the main Graphing (View
> Graphs) and Profiling (View > Profiles) features as follows:
• Normal graphs and profiles don't show any time varying results from transient simulation - all you can see are the
extreme results like Pressure (Maximum, Transient).
• Profiles don't show any results for the intermediate points along a pipe.
To open the Transient Results Viewer click the Analysis menu and select Transient Results Viewer, or click the

Transient Results Viewer toolbar button .

The dialog consists of the following three tabs:

Profiles Tab
This tab allows you to view profile results from transient simulations.

891
WaterGEMS CONNECT Edition Help
Presenting Your Results

It consists of the following controls:

• Profile: Select the Profile path you want to plot or animate. Only Profile paths marked as Transient Report Paths
will be available from this menu. For details on setting up Profiles and Transient Report Paths, refer to the Using
Profiles (on page 801) section.
• Graph Type: Select the attribute(s) that will be displayed on the plot/animation.
• Profile Button: Opens the Transient Profile Viewer Dialog Box (on page 894).
Additionally, this tab reports the following Profile Point Statistics:
• Count: This field displays the number of points along the profile path.
• Length: This field displays the length of the profile path.
• From Point: This field displays the start point of the profile path.
• To Point: This field displays the end point of the profile path.

Transient Profile Viewer Dialog Box

Note: This dialog is available in HAMMER only.

This dialog displays the transient profile using the settings on the Transient Results Viewer Profiles Tab (on page 891).

892
WaterGEMS CONNECT Edition Help
Presenting Your Results

You can also animate the profile using the time controls along the top of the dialog (if you have set the Generate
Animation Data? Calculation Option to True; see Calculation Options for more information).
The dialog consists of the following controls:
• Profile Options: Clicking this button opens the Transient Profile Viewer Options Dialog Box (on page
894), allowing you to specify the transient profile options. Clicking on the arrow on the right side of the button
opens a submenu containing the following commands:
• Save As Default Profile Settings: Choose this command to set the current profile options as your new defaults.
• Apply Default Settings: Choose this command to apply your previously saved default settings to the current
profile.
• Restore Factory Defaults: Choose this command to reset the default profile settings back to the factory
defaults.
•
Print Preview: Opens a print preview window containing the current view of the profile. You can use the
Print Preview dialog box to select a printer and preview the output before you print it. Clicking on the arrow on the
right side of the button opens a submenu containing the following commands:
• Fit to Page: Resizes the profile view so that it fits on a single page.
• Scaled: Displays the profile at the scale defined in the Transient Profile Viewer Options Dialog Box (on page
894).
• Export to DXF: Opens an Export to DXF dialog, allowing you to export the current profile as a .dxf file.
•
Zoom Extents: Zooms out so that the entire profile is displayed.
•
Zoom Window: Zooms in on a section of the profile. When the tool is toggled on, you can zoom in on any
area of the profile by clicking on the chart to the left of the area to be zoomed, holding the mouse button, then
dragging the mouse to the right (or the opposite extent of the area to be magnified) and releasing the mouse button
when the area to be zoomed has been defined.

893
WaterGEMS CONNECT Edition Help
Presenting Your Results

To zoom back out, click and hold the mouse button, drag the mouse in the opposite direction (right to left), and
release the mouse button.
•
Zoom In: Increases the magnification of the area that is clicked when this tool is active.
•
Zoom Out: Decreases the magnification of the profile view.
•
Go To Start: Sets the currently displayed time step to the beginning of the simulation.
•
Pause/Stop: Stops the animation at the current time step.
•
Play: Animates the profile view.
• Time Display: Shows the current time step that is displayed in the profile.
• Time Slider: Manually moves the slider representing the currently displayed time step along the bar, which
represents the full length of time that the transient run encompasses.
Click the Data tab to see the profile data in tabular format.

Transient Profile Viewer Options Dialog Box

This dialog allows you to define the profile display options.

The dialog is divided into the following tabs:

• General Tab: This tab consists of the following controls:
• Animation Frequency: Enter the number of frames per second at which the profile should be animated.
• Line Width Multiplier: Increases the width of the lines in the profile.
• Show Annotations: When this box is checked, annotations will be displayed on the profile.
• Show Title: When this box is checked, the title will be displayed on the profile.
• Title: Enter the title you want to be displayed in the profile.
• Scale Tab: This tab consists of the following controls:
• Horizontal Print Scale 1 in =: Enter the horizontal scale that is applied during scaled print operations. This
field is only editable when the Use Automatic Scaling box is unchecked.

894
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Vertical Print Scale 1 in =: Enter the vertical scale that is applied during scaled print operations. This field is
only editable when the Use Automatic Scaling box is unchecked.
• Use Automatic Scaling: Uncheck this box to enable the print scale fields. When the box is checked, the scale is
automatically assigned.
• Color Tab: This tab contains a table that is comprised of rows for each attribute layer. For each layer, click the Is
Visible checkbox to display that attribute. You can also select a color for each layer in the Color column.
• Text Tab: This tab contains a table that is comprised of rows for each text layer. For each layer you can select a
font, font size, and font color.

Time Histories Tab

Note: This dialog is available in HAMMER only.

This tab allows you to plot a graph of the transient results at report points.

The tab consists of the following controls:

• Working Scenario: Displays the scenario for which transient results are currently displayed.
• Additional Scenarios: Displays scenarios in addition to the working scenario for which results are displayed. Click
the ellipsis button to add additional scenarios.
• Plot: Click this button to open the Transient Results Graph Viewer Dialog Box (on page 896).
• Time History: Select the Report Point.
• Graph Type: Select the attribute(s) that will be displayed on the plot.
Additionally, this tab reports the following Time History Point Statistics:
• End Point: This field displays the report point of the Time History.
• Count: This field displays the number of time steps in the transient simulation.

Extended Node Data

895
WaterGEMS CONNECT Edition Help
Presenting Your Results

Note: This dialog is available in HAMMER only.

This tab consist of the following controls:

• Working Scenario: The current active scenario.
• Plot: Create a graph of the selected result attribute.
• Additional Scenarios: Select one or more scenarios to compare the transient node results against the results of the
current scenario shown in the input field Working Scenario.
• Node: Displays a list of all node objects in the model with transient node results.
• Graph Type: Displays a list of the available transient node results available for the selected node type.

Transient Results Graph Viewer Dialog Box

Note: This dialog is available in HAMMER only.

You can also animate the profile using the time controls along the top of the dialog (if you have set the Generate
Animation Data? Calculation Option to True; see Calculation Options for more information).
The dialog consists of the following controls:
• Chart Settings: Clicking this button opens the Chart Options Dialog Box, allowing you to specify the graph
display options. Clicking on the arrow on the right side of the button opens a submenu containing the following
commands:
• Title: Toggles on/off the graph title.
• Legend: Toggles on/off the graph legend.
• Save As Default Profile Settings: Choose this command to set the current graph options as your new defaults.
• Restore Factory Defaults: Choose this command to reset the default graph settings back to the factory defaults.
• Print: Prints the current graph.
•
Print Preview: Opens a print preview window containing the current view of the profile. You can use
the Print Preview dialog box to select a printer and preview the output before you print it.
•
Copy: Copies the graph to the Windows clipboard.
•
Zoom Extents: Zooms out so that the entire profile is displayed.
•
Zoom: Zooms in on a section of the profile. When the tool is toggled on, you can zoom in on any area of the
profile by clicking on the chart to the left of the area to be zoomed, holding the mouse button, then dragging the
mouse to the right (or the opposite extent of the area to be magnified) and releasing the mouse button when the area
to be zoomed has been defined.
To zoom back out, click and hold the mouse button, drag the mouse in the opposite direction (right to left), and
release the mouse button.
•
Go to Start: Sets the currently displayed time step to the beginning of the simulation.
•
Pause/Stop: Stops the animation at the current time step.
•
Play: Animates the profile view.
• Time Display: Shows the current time step that is displayed in the profile.

896
WaterGEMS CONNECT Edition Help
Presenting Your Results

• Time Slider: Manually moves the slider representing the currently displayed time step along the bar, which
represents the full length of time that the transient run encompasses.
Click the Data tab to see the profile data in tabular format.

Results Table Dialog Box

The Results Table displays calculated results for each time step at the currently selected element.

Print Preview Window

The Print Preview window can be used to print documents, such as reports and graphs. You can see the current view of
the document as it will be printed and define the print settings.
The following controls are available in the Print Preview window:

Opens a Find dialog, allowing you to search for specified

Search
terms in the document.

Open Opens a previously saved Preview Document File (.prnx).

Save Saves the current prview as a Preview Document File

897
WaterGEMS CONNECT Edition Help
Presenting Your Results

Print Opens a Print dialog, allowing you to choose the printer,

pages to be printed, and number of copies.

Prints the document using the default printer.

Quick Print

Page Setup Opens the Page Seuip dialog, allowing you to specify the
page setup settings, including page size, orientation, and
margins.

Opens a submenu that allows you to set the document

Scale
scale.

Clicking this button toggles the Hand tool, which allows

Hand Tool you to move the page around.

Clicking this button toggles the Magnifier tool, which

Magnifier
allows you to zoom the document view.

Zoom Out Zooms the page out.

Zoom Displays the current zoom; also allows you choose the
current zoom level.

Zooms the page in.

Zoom In

First Page Sets the view to the first page of the document.

Previous Page Sets the view to the previous page of the document.

Next Page Sets the view to the next page of the document.

Last Page Sets the view to the last page of the document.

Opens a submenu that allows you to define the number of

Multiple Pages
pages that are viewed at once.

Opens a submenu that allows you to choose the

Color
background color of the document.

Opens the Watermark dialog, allowing you to define the

Watermark
watermark settings.

Opens the Export dialog, which allows you to define the

Export Document export settings and export the document as one of the
following document types: PDF (.pdf) HTML (.html)
MHT (.mht) RTF (.rtf) Excel (.xls) CSV (.csv) Text (.txt)
Image (.bmp, .gif, .jpg, .png, .tiff, .emf, .wmf)

898
WaterGEMS CONNECT Edition Help
Presenting Your Results

Opens the Export dialog, which allows you to define the

Send via Email
export settings and export the document as one of the
following document types: PDF (.pdf) HTML (.html)
MHT (.mht) RTF (.rtf) Excel (.xls) CSV (.csv) Text (.txt)
Image (.bmp, .gif, .jpg, .png, .tiff, .emf, .wmf) After the
file is exported it is attached to an email, which you can
then send using the specified email address and other
settings.

Exit Closes the Print Preview dialog.

Print Preparation

Detailed help for the Print Preparation feature can be found in the PrintPreparation.chm found in the Bentley/
WaterGEMS CONNECT folder.
Also note the following considerations
• For Admins: To set up a template, create the Legend rectangle by placing a Viewport Area and choosing the
Legend mode.
• For Users: When creating a print model, it's important to note that you must perform an Insert Legend from
Element Symbology command before the legend will show up in the print model. All the legends that you have
inserted will show up in the viewport area that was set up in the template.

Transient Thematic Viewer

The Transient Thematic Viewer allows you to apply colored highlighting to the pipes and nodes in the model according
to their calculated values for a specified attribute.

899
WaterGEMS CONNECT Edition Help
Presenting Your Results

Field Name Select the attribute to apply the thematic coloration.

Selection Set Apply an attribute to a previously defined selection set or to All Elements, which
calculates the thematic coloration based on all elements in the model.

Calculate Range Clicking this button will populate the Minimum and Maximum fields with the minimum
and maximum values for the attribute selected in the Field Name box.

Minimum Lowest value to be included in thematic coloration.

Maximum Highest value for which thematic coloration will be generated.

Steps Number of even increments that the specifies value range will be divided by.

Use Gradient When this box is checked, variations between two colors will be displayed as a gradient
rather than a discrete separation.

900
WaterGEMS CONNECT Edition Help
Presenting Your Results

Color Maps Thematic coloration is based on attribute ranges. Use the Initialize button to create five
evenly spaced ranges and associated colors. Click the New button to add a new row to the
table. Click the Delete button to remove the currently selected row from the table.
• Initialize—This button, located to the right of the Contour section, will initialize the
Minimum, Maximum, Increment, and Index Increment values based on the actual
values observed for the elements in the selection set.

Note: Initialization can be accomplished by clicking the Initialize button to

automatically generate values for the minimum, maximum, increment, and index
increment to create an evenly spaced thematic set.
• Ramp—Automatically generate a gradient range between two colors that you specify.
Pick the color for the first and last values in the list and the program will select colors
for the other values.
• Invert—Reverses the order of the colors according to range.
• Above Range Color—The color that will be applied to elements whose value falls
above the specified maximum value.

Transient Time Step Options Dialog Box

This dialog shows the time step suggested by HAMMER and the adjustments to lengths or wavespeeds it requires. You
can also choose to define a custom time step.
The dialog consists of the following controls:
• Time Step: The calculated time step.
• Max Adjustment: The maximum adjustment to wave speed or length for the time step.
• Mean Adjustment: The meanadjustment to wave speed or length for the time step.
• RMS Adjustment: The RMS (root-mean-square) adjustment to wave speed or length for the time step.
• Use Custom Time Step?: When this box is checked, the custom Time Step field becomes available for you to edit.
Enter the desired time step here.
• Adjust: Select one or the other as indicated by your modeling objectives. Length is the default method. Wave speed
may result in faster but accurate simulations of mass oscillation (slow transients).
• Adjustment Type: Select Absolute (e.g. length or wave speed) or relative (e.g. percentage) reporting method.
HAMMER will use this setting to display the adjustments that correspond to the selected time step.
• Max Adjustment: Enter the maximum adjustment to wave speed or length.

Note: If you receive the following warning: "The wavespeed or length approximation deviates excessively from
the entered values. Lengthen short pipes and/or subdivide longer pipes.", you can lengthen the short pipes/
subdivide longer pipes or you can modify the Max Adjustment value in the Transient Time Step Options dialog.

Transient Calculation Summary

901
WaterGEMS CONNECT Edition Help
Importing and Exporting Data

The Transient Calculation Summary opens automatically after you perform a transient calculation. It provides a
summary of the calculations performed on the model. You can also access this report by clicking Analysis > Transient
Calculation Summary.

Show this dialog after Compute - When this box is checked, the Calculation Summary will open automatically after
every Compute operation, unchecking it will suppress this behavior.

Note: In HAMMER, this option applies to both the Transient Calculation Summary and the Calculation Summary.
If you uncheck the option for Transient Calculation Summary, it will also be unchecked for Calculation Summary.

Click the tabs in the summary dialog box to see the various types of results:
• Summary Tab
• Initial Conditions Tab
• Extreme Pressure and Heads Tab

Importing and Exporting Data

902
WaterGEMS CONNECT Edition Help
Importing and Exporting Data

Moving Data and Images Between Model(s) and other Files

WaterGEMS CONNECT offers numerous ways of moving data and images between models and to/from models and
external files. Selecting the best approach can make the process easy. An overview of the different approaches and their
suitability for various tasks is presented below. Each of these items is covered in greater detail elsewhere in the
documentation.
1. Copy/paste: This is the easiest way to move tabular data to and from models. Simply highlight the data to be copied
(or an entire table). Select Copy or CTRL-C. Move to where the data are to be placed. Select Paste or CTRL-V.
2. ModelBuilder (see Using ModelBuilder To Transfer Existing Data): This is best for moving data from GIS/CAD/
database/spreadsheet sources to and from the model. Importing to the model is called "Synching in" (Build Model)
and exporting from the model is called "Synching out". To move data between models, first copy out to an
intermediate file (e.g. shape file for element data, spreadsheet for component data). Two overall types of data can be
moved to and from the model.
a. Element data consists of the actual pipes, nodes, etc that make up the model. ModelBuilder preserves the correct
x-y coordinates and properties of the elements. This is useful for GIS/CAD data.
b. • Component data and collections (e.g. pump definitions, patterns, unit demands) do not have spatial
coordinates. These are written to a spreadsheet/database file and then imported into another model.
3. Import/Export Submodels (see Importing and Exporting Submodel Files (on page 7)): This is used to create new
models from subsets of another model, or to merge one model into another, or to create a new model from multiple
existing models.
4. Libraries (see Engineering Libraries): These files can also be used to store component data (e.g. pump definitions,
patterns) for use by other models. These are usually stored as XML files. For components that have libraries, it is
usually easier to move data with the libraries instead of with ModelBuilder.
5. LoadBuilder (see Using LoadBuilder to Assign Loading Data): LoadBuilder is used to convert spatial demand/load
data from a variety of source files into nodal load/demand values.
6. TRex (see Applying Elevation Data with TRex): Terrain extraction is used to convert a variety of digital elevation
data into nodal elevation data.
7. Flex Table to Shapefile (see Viewing and Editing Data in FlexTables): From within a flex table, it is possible
to create a shapefile for that type of element.
8. Time series field data: This is used to import field observations of element properties into the model for
comparison with model results, especially in graphs. Copy/paste can be used as part of creation of time series field
data.
9. Import/Export EPANET (see Importing and Exporting EPANET Files (on page 7)):This is used to move model
data to or from EPANET. Because EPANET does not support as many features and properties as Bentley models,
some data are lost.
10. Import model data base: This is used to create a new model from a WaterGEMS, WaterCAD, or Hammer
*.wtg.sqlite file. It differs from submodel import in that is creates a new hydraulic model instead of appending the
model to an existing model.
11. DXF export (see Exporting a DXF File (on page 7)): This creates a dxf file of the model which can be opened in
CAD software like MicroStation.)
12. Hyperlinks (see Hyperlinks): These are used to attach external files (e.g. doc, jpg) to model elements.
13. Background layers (see Using Background Layers): These are used in the stand alone version to display a variety
of raster and vector images behind the model. In other platforms, the display of background layers is controlled by
the platform specific native software functions.
14. Copy images to clipboard: To move an image from the model to the clipboard for use in other applications (e.g.
Word. PowerPoint), click on the dialog/image to get focus, select Alt-PrtSreen. Then paste from clipboard.

903
WaterGEMS CONNECT Edition Help
Importing and Exporting Data

15. Exporting Graphs and Profiles (see Graphs and Using Profiles): Graphs and profiles created with the model can
be exported to a variety of formats including BMP, JPG, PNG, and GIF from the Chart Options dialog.
16. Shared tables (see Viewing and Editing Data in FlexTables): Shared tables are used to store the format of flex
tables so that they can be used by other models. These are stored in C:\Users\<User Directory>\AppData\Local
\Bentley\<Product Name>\10. Highlight the flex table, right click, and select Duplicate > As shared flex table.

Importing a WaterGEMS Database

You can import a WaterGEMS database file, which will create a new model using the data in the database.
To import a WaterGEMS Database
1. Click the File menu, select Import, then choose WaterGEMS Database from the submenu.
2. Browse to and highlight the wtg.sqilte file to import.
3. Click Open.

Importing and Exporting EPANET Files

You can input and export EPANET input files.

To import an EPANET file
1. Click the File menu, select Import, then choose EPANET from the submenu.
2. Browse to and highlight the .inp input file to import.
3. Click Open.
To export an EPANET file
1. Click the File menu, select Export, then choose EPANET from the submenu.
2. Type a name for the input file.
3. Click Save.

Importing and Exporting Submodel Files

Using the Submodel Import feature, you can import another model, or any portion thereof, into your hydraulic model.
Input data stored in the Alternatives as well as any supporting data (i.e. Patterns, Pump Definitions, Constituents, etc)
will also be imported. It is important to notice that existing elements in the model you want to import the submodel into
(i.e. the target model) will be matched with incoming elements by using their label. Incoming input data will override
existing data in the target model for any element matched by its label. That also applies to scenarios, alternatives,
calculation options and supporting data. Furthermore, any element in the incoming submodel that could not be matched
with any existing element by their label, will be created in the target model.
For example, the submodel you want to import contains input data that you would like to transfer in two Physical
Alternatives named "Smaller Pipes" and "Larger Pipes". The target model contains only one Physical Alternative
named "Larger Pipes". In that case, the input data in the alternative labeled "Larger Pipes" in the submodel will replace
the alternative with the same name in the target model. Moreover, the alternative labeled "Smaller Pipes" as well as its
input data will be added to the target model without replacing any existing data on it because there is no existing
alternative with the same label. Notice that imported elements will be assigned default values in those existing
alternatives in the target model that could not be matched.

904
WaterGEMS CONNECT Edition Help
Importing and Exporting Data

Notice that regular models can be imported as a submodel of a larger model as their file format and extension are the
same.
For more information about input data transfer, see Exporting a Submodel.

Note: The label-matching strategy used during submodel import will be applied to any set of alternatives,
including Active Topology alternatives. Therefore, if no Active Topology alternative is stored in the submodel
matches the existing ones in the target model, the imported elements will preserve their active topology values
in the alternatives created from the submodel, but they will be left as "inactive" in those previously existing
alternatives in the target model. That is because the default value for the "Is Active" attribute in active topology
alternatives other than the one is current is "False".

To import a submodel
1. Click the File menu and select Import...Submodel.
2. In the Select Submodel File to Import dialog box, select the submodel file to be imported. Click the Open button.

Exporting a Submodel
You can export any portion of a model as a submodel for import into other hydraulic models. Input data is also stored
in the file that is created in the process of Exporting a Submodel. This input data will be imported following a label-
matching strategy for any element, alternative, scenario, calculation option or supporting data in the submodel.
To export a submodel:
1. In the drawing view, highlight the elements to be exported as a submodel. To highlight multiple elements, hold
down the Shift key while clicking elements.
2. Click the File menu and select Export...Submodel.
3. In the Select Submodel File to Export dialog box, specify the directory to which the file should be saved, enter
a name for the submodel and click the Save button.

Exporting a DXF File

A hydraulic model can be saved in .dxf format for use by AutoCAD and other CAD-based applications. When you use
the Export command, you first specify the drive, directory, and file name of the .DXF file to be saved; then the Export
to DXF Layer Settings window opens, allowing you specify the names of the .dxf layers on a per-element type basis.
The Export to DXF Layer Settings dialog is divided into tabs for Link Layers, Node Layers, and Polygon Layers.

905
WaterGEMS CONNECT Edition Help
Importing and Exporting Data

Each tab contains a table that allows you to specify a prefix and suffix for the associated dxf layer. The Preview field
displays how the label will appear.
The Link Layers tab has additional controls: Entering a value in the Pipe Size Significant Digits field allows you to
organize the pipe layer into multiple layers taking the pipe sizes into account using the Layer by Pipe Size checkbox.

File Upgrade Wizard

The File Upgrade Wizard allows you to allows you to upgrade older WaterGEMS CONNECT database files to the
most current format.

906
WaterGEMS CONNECT Edition Help
Importing and Exporting Data

If you have v3 installed, installing v8 will add a new command to your v3 File>Export menu. Open the model to be
upgraded in v3 and perform the File>Export> WaterGEMS CONNECT Presentation Settings command to obtain a
presentation settings file that can be used when upgrading the model file.

Export to Shapefile

It is possible to export model elements and data to create a shapefile. Unlike the other export features in WaterGEMS
CONNECT, the export to shapefile operation occurs in a FlexTable as opposed to the File > Export menu. Shapefiles
must be created one element type at a time. That means there will be a separate shapefile to junctions, pipes, tanks, etc.
To create a shapefile, open the FlexTable for the type of element. Use selection sets or filtering to reduce the size of the
FlexTable to what is desired in the shapefile. Use the table edit feature to eliminate any columns that are not desired.
When FlexTable is in correct form, pick the first button at the top left of the table which is the Export button. A Specify
File Name to Export dialog ill open, allowing you to specify the file name and path for the shapefile. When the user
names the file and clicks Save, the dialog below appears.

907
WaterGEMS CONNECT Edition Help
Technical Reference

It is important to insure that any shapefile field names are less than or equal to 10 characters. The default name for
shapefile field is the name of the column in the FlexTable. (If the user changes the name to something different from
the FlexTable column name, the editor remembers it when other shapefiles are created from this table.) Once the names
are acceptable, hit OK to create the shapefile. A shapefile consisting of .dbf, .shx and .shp files are created.

Technical Reference
Variable Speed Pump Theory (on page 7)

Pressure Network Hydraulics

In practice, pipe networks consist not only of pipes but of miscellaneous fittings, services, storage tanks and reservoirs,
meters, regulating valves, pumps, and electronic and mechanical controls.

Network Hydraulics Theory

For modeling purposes, these system elements are organized into the following categories:
• Pipes—Transport water from one location (or node) to another.
• Junctions/Nodes—Specific points, or nodes, in the system at which an event of interest is occurring. This includes
points where pipes intersect, where there are major demands on the system such as a large industry, a cluster of
houses, or a fire hydrant, or critical points in the system where pressures are important for analysis purposes.
• Reservoirs and Tanks—Boundary nodes with a known hydraulic grade that define the initial hydraulic grades for
any computational cycle. They form the baseline hydraulic constraints used to determine the condition of all other
nodes during system operation. Boundary nodes are elements such as tanks, reservoirs, and pressure sources.
• Pumps—Represented as nodes. Their purpose is to provide energy to the system and raise the water pressure.
• Valves—Mechanical devices used to stop or control the flow through a pipe, or to control the pressure in the pipe
upstream or downstream of the valve. They result in a loss of energy in the system.

908
WaterGEMS CONNECT Edition Help
Technical Reference

An event or condition at one point in the system can affect all other parts of the system. While this complicates the
approach that the engineer must take to find a solution, there are some governing principles that drive the behavior of
the network, including the Conservation of Mass and Energy Principle, and the Energy Principle.
The two modes of analysis are Steady-State Network Hydraulics and Extended Period Simulation. This program solves
for the distributions of flows and hydraulic grades using the Gradient Algorithm.

The Energy Principle

The first law of thermodynamics states that for any given system, the change in energy is equal to the difference
between the heat transferred to the system and the work done by the system on its surroundings during a given time
interval.
The energy referred to in this principle represents the total energy of the system minus the sum of the potential, kinetic,
and internal (molecular) forms of energy, such as electrical and chemical energy. The internal energy changes are
commonly disregarded in water distribution analysis because of their relatively small magnitude.
In hydraulic applications, energy is often represented as energy per unit weight, resulting in units of length. Using these
length equivalents gives engineers a better feel for the resulting behavior of the system. When using these length
equivalents, the state of the system is expressed in terms of head. The energy at any point within a hydraulic system is
often represented in three parts:

Pressure Head: p/ γ

Elevation Head: z

Velocity Head: V 2 /2g

p = Pressure (N/m 2 , lb./ft. 2 )

γ = Specific weight (N/m 3 ,

lb./ft. 3 )

z = Elevation (m, ft.)

V = Velocity (m/s, ft./sec.)

g = Gravitational acceleration
constant (m/s 2 , ft./sec. 2 )

These quantities can be used to express the headloss or head gain between two locations using the energy equation.

The Energy Equation

In addition to pressure head, elevation head, and velocity head, there may also be head added to the system, by a pump
for instance, and head removed from the system due to friction. These changes in head are referred to as head gains and
headlosses, respectively. Balancing the energy across two points in the system, you then obtain the energy equation:

909
WaterGEMS CONNECT Edition Help
Technical Reference

Where:
p = Pressure (N/m2, lb./ft.2)

= Specific weight (N/m3, lb./ft.3)

z = Elevation at the centroid (m, ft.)
V = Velocity (m/s, ft./sec.)
g = Gravitational acceleration constant (m/s2, ft./sec.2)
hp = Head gain from a pump (m, ft.)
hL = Combined headloss (m, ft.)
The components of the energy equation can be combined to express two useful quantities, which are the hydraulic
grade and the energy grade.

Hydraulic and Energy Grades

Hydraulic Grade
The hydraulic grade is the sum of the pressure head (p/γ) and elevation head (z). The hydraulic head represents the
height to which a water column would rise in a piezometer. The plot of the hydraulic grade in a profile is often referred
to as the hydraulic grade line, or HGL.
Energy Grade
The energy grade is the sum of the hydraulic grade and the velocity head (V2/2g). This is the height to which a column
of water would rise in a pitot tube. The plot of the energy grade in a profile is often referred to as the energy grade line,
or EGL. At a lake or reservoir, where the velocity is essentially zero, the EGL is equal to the HGL, as can be seen in the
following diagram.

910
WaterGEMS CONNECT Edition Help
Technical Reference

Conservation of Mass and Energy

Conservation of Mass
At any node in a system containing incompressible fluid, the total volumetric (or mass flows in) must equal the flows
out, less the change in storage. Separating these into flows from connecting pipes, demands, and storage, you obtain:

Where: Q IN = Total flow into the node (m 3 /s, cfs)

Q OUT = Total demand at the node (m 3 /s, cfs)

DV S = Change in storage volume (m 3 , ft. 3 )

Dt = Change in time (s)

Conservation of Energy
The conservation of energy principle states that the headlosses through the system must balance at each point. For
pressure networks, this means that the total headloss between any two nodes in the system must be the same regardless
of what path is taken between the two points. The headloss must be sign consistent with the assumed flow direction
(i.e., gain head when proceeding opposite the flow direction and lose head when proceeding in the flow direction).

Conservation of Energy
The same basic principle can be applied to any path between two points. As shown in the figure above, te combined
headloss around a loop must equal zero in order to achieve the same hydraulic grade as at the beginning.

The Gradient Algorithm

The gradient algorithm for the solution of pipe networks is formulated upon the full set of system equations that model
both heads and flows. Since both continuity and energy are balanced and solved with each iteration, the method is
theoretically guaranteed to deliver the same level of accuracy observed and expected in other well-known algorithms
such as the Simultaneous Path Adjustment Method (Fowler) and the Linear Theory Method (Wood).
In addition, there are a number of other advantages that this method has over other algorithms for the solution of pipe
network systems:

911
WaterGEMS CONNECT Edition Help
Technical Reference

• The method can directly solve both looped and partly branched networks. This gives it a computational advantage
over some loop-based algorithms, such as Simultaneous Path, which require the reformulation of the network into
equivalent looped networks or pseudo-loops.
• Using the method avoids the post-computation step of loop and path definition, which adds significantly to the
overhead of system computation.
• The method is numerically stable when the system becomes disconnected by check valves, pressure regulating
valves, or modeler’s error. The loop and path methods fail in these situations.
• The structure of the generated system of equations allows the use of extremely fast and reliable sparse matrix
solvers.
The derivation of the Gradient Algorithm starts with two matrices and ends as a working system of equations.

Derivation of the Gradient Algorithm

Given a network defined by N unknown head nodes, P links of unknown flow, and B boundary or fixed head nodes, the
network topology can be expressed in two incidence matrices:

A 12 = A 21 T (P x N) Unknown head nodes incidence matrix

and

A 10 = A (P x B) Fixed head nodes incidence matrix

T
01

The following convention is used to assign matrix values:

A 12 (i,j) = 1, 0, (PxN) Unknown head nodes incidence matrix

or -1

Assigned nodal demands are given by:

q T = [q 1 , q 2,... , (1 x N) Nodal demand vector

qN]

Assigned boundary nodal heads are given by:

H f T = [H f1 , H (1 x B) Fixed nodal head vector

f2 ,..., H fB ]

The headloss or gain transform is expressed in the matrix:

F T (Q) = [f 1 , f (1 x P) Non-linear laws expressing headlosses in links

2 ..., f p ]

These matrix elements that define known or iterative network state can be used to compute the final steady-state
network represented by the matrix quantities for unknown flow and unknown nodal head.

912
WaterGEMS CONNECT Edition Help
Technical Reference

Unknown link flow quantities are defined by:

Q T = [Q 1 ,Q (1 x P) Unknown link flow rate vector

2 ..., Q p ]

Unknown nodal heads are defined by:

H T = [H 1 , H (1 x N) Unknown nodal head vector

2 ..., H N ]

These topology and quantity matrices can be formulated into the generalized matrix expression using the laws of
energy and mass conservation:

A second diagonal matrix that implements the vectorized head change coefficients is introduced. It is generalized for
Hazen-Williams friction losses in this case:

This yields the full expression of the network response in matrix form:

To solve the system of non-linear equations, the Newton-Raphson iterative scheme can be obtained by differentiating
both side of the equation with respect to Q and H and get:

with

The final recursive form of the Newton-Raphson algorithm can now be derived after matrix inversion and various
algebraic manipulations and substitutions (not presented here). The working system of equations for each solution
iteration, k, is given by:

913
WaterGEMS CONNECT Edition Help
Technical Reference

The solution for each unknown nodal head for each time iteration is computationally intensive This high-speed solution
utilizes a highly optimized sparse matrix solver that is specifically tailored to the structure of this matrix system of
equations.
Sources:
Todini, E. and S. Pilati, "A gradient Algorithm for the Analysis of Pipe Networks," Computer Applications in Water
Supply, Vol. 1-Systems Analysis and Simulation, ed. By Bryan Callback and Chin-Hour Or, Research Studies Press
LTD, Watchword, Hertfordshire, England.

The Linear System Equation Solver

The Conjugate Gradient method is one method that, in theory, converges to an exact solution in a limited number of
steps. The Gradient working equation can be expressed for the pressure network system of equations as:

where:

The structure of the system matrix A at the point of solution is:

and it can be seen that the nature of the topological matrix components yield a total working matrix A that is:
• Symmetric
• Positive definite
• Stieltjes type.
Because of the symmetry, the number of non-zero elements to be retained in the matrix equals the number of nodes
plus the number of links. This results in a low density, highly sparse matrix form. It follows that an iterative solution
scheme would be preferred over direct matrix inversion in order to avoid matrix fill-in, which serves to increase the
computational effort.
Because the system is symmetric and positive definite, a Cholesky factorization can be performed to give:

where L is lower triangular with positive diagonal elements. Making the Cholesky factorization allows the system to be
solved in two steps:

914
WaterGEMS CONNECT Edition Help
Technical Reference

The use of this approach over more general sparse matrix solvers that implement traditional Gaussian elimination
methods without consideration to matrix symmetry is preferred since performance gains are considerable. The
algorithm utilized in this software solves the system of equations using a variant of Cholesky’s method which has been
optimized to reduce fill-in of the factorization matrix, thus minimizing storage and reducing overall computational
effort.

Pump Theory
Pumps are an integral part of many pressure systems. Pumps add energy, or head gains, to the flow to counteract
headlosses and hydraulic grade differences within the system.
A pump is defined by its characteristic curve, which relates the pump head, or the head added to the system, to the flow
rate. This curve is indicative of the ability of the pump to add head at different flow rates. To model behavior of the
pump system, additional information is needed to ascertain the actual point at which the pump will be operating.
The system operating point is based on the point at which the pump curve crosses the system curve representing the
static lift and headlosses due to friction and minor losses. When these curves are superimposed, the operating point can
easily be found. This is shown in the figure below.

System Operating Point

As water surface elevations and demands throughout the system change, the static head (Hs) and headlosses (HL) vary.
This changes the location of the system curve, while the pump charactheristic curve remains constant. These shifts in
the system curve result in a shifting operating point over time.
Variable Speed Pumps

915
WaterGEMS CONNECT Edition Help
Technical Reference

A pump's characteristic curve is fixed for a given motor speed and impeller diameter, but can be determined for any
speed and any diameter by applying the affinity laws. For variable speed pumps, these affinity laws are presented as:

and

Where: Q = Pump flow rate (m3/s, cfs)

h = Pump head (m, ft.)

n = Pump speed (rpm)

Effect of Relative Speed on Pump Curve

Constant Horsepower Pumps
During preliminary studies, the exact characteristics of the constant horsepower pump may not be known. In these
cases, the assumption is often made that the pump is adding energy to the water at a constant rate. Based on power-
head-flow rate relationships for the pumps, the operating point of the pump can then be determined. Although this
assumption is useful for some applications, a constant horsepower pump should only be used for preliminary studies.

Note: It is not necessary to place a check valve on the pipe immediately downstream of a pump because pumps
have built in check valves that prevent reverse flow.

This software currently models six different types of pumps:

Note: Whenever possible, avoid using constant power or design point pumps. They are often enticing because
they require less work on behalf of the engineer, but they are much less accurate than a pump curve based on
several representative points.

• Constant Power-These pumps may be useful for preliminary designs and estimating pump size, but should not be
used for any analysis for which more accurate results are desired.
• Design Point (One-Point)-A pump can be defined by a single design point (Hd @ Qd). From this point, the curve's
interception with the head and discharge axes is computed as Ho = 1.33·Hd and Qo = 2.00·Qd. This type of pump is
useful for preliminary designs but should not be used for final analysis.
• Standard (Three-Point)-This pump curve is defined by three points-the shutoff head (pump head at zero
discharge), the design point (as with the single-point pump), and the maximum operating point (the highest
discharge at which the pump performs predictably).

916
WaterGEMS CONNECT Edition Help
Technical Reference

• Standard Extended-The same as the standard three-point pump but with an extended point at the zero pump head
point. This is automatically calculated by the program.
• Custom Extended-The custom extended pump is similar to the standard extended pump, but allows you to enter
the discharge at zero pump head.
• Multiple Point-This option allows you to define a custom rating curve for a pump. The pump curve is defined by
entering points for discharge rates at various heads. Since the general pump equation, shown below, is used to
simulate the pump during the network computations, the user-defined pump curve points are used to solve for
coefficients in the general pump equation:

Where: Y = Head (m, ft.)

Q = Discharge (m3/s, cfs)

A, B, C = Pump curve coefficients

The Levenberg-Marquardt Method is used to solve for A, B and C based on the given multiple-point rating curve.

Valve Theory
There are several types of valves that may be present in a pressurized system. These valves have different behaviors
and different responsibilities, but all valves are used for automatically controlling parts of the system. They can be
opened, closed, or throttled to achieve the desired result.

Check Values (CVs)

There are several types of check valves available for the prevention of reverse flow in a hydraulic system. The simplest
and often most reliable are the ubiquitous swing check valves, which should be carefully selected to ensure that their
operational characteristics (such as closing time) are sufficient for the transient flow reversals that can occur in the
system. Some transient flow reversal conditions can occur very rapidly; thus, if a check valve cannot respond quickly
enough, it may slam closed and cause the valve or piping to fail.
Check valves that have moving discs and parts of significant mass have a higher inertia and therefore tend to close
more slowly upon flow reversal. Check valves with lighter checking mechanisms have less inertia and therefore close
more quickly. External counterweights present on some check valves (such as swing check valves) assist the valve
closing following stoppage of flow. However, for systems that experience very rapid transient flow reversal, the
additional inertia of the counterweight can slow the closing time of the valve. Spring-loaded check valves can be used
to reduce closing time, but these valves have higher head loss characteristics and can induce an oscillatory phenomenon
during some flow conditions.
It is important that the modeler understand the closing characteristics of the check valves being used. For example, ball
check valves tend to close slowly, swing check valves close somewhat faster (unless they are adjusted otherwise), and
nozzle check valves have the shortest closing times. Modeling the transient event with closing times corresponding to
different types of check valves can indicate if a more expensive nozzle-type valve is worthwhile.
The following attributes describe the check valve behavior:
• Open Time: Amount of time to open the valve, from the fully closed position, after the specified Pressure
(Threshold) value is exceeded. This establishes the rate of opening if the valve's closure is partial.

917
WaterGEMS CONNECT Edition Help
Technical Reference

• Closure Time: Amount of time to close the valve, from the fully open position, after reverse flow is sensed. This
establishes the rate of opening if the valve's closure is partial.
• Allow Disruption of Operation?: Allows you to define whether an operation (opening or closing) can be
terminated prematurely due to a signal to reverse.
• Pressure (Threshold): The pressure difference between the upstream and downstream side that triggers the valve to
(re)open the (closed) valve. If 0 is entered, the valve (re)opens when the upstream pressure exceeds the downstream
pressure.

Flow Control Valves (FCVs)

FCVs are used to limit the maximum flow rate through the valve from upstream to downstream. FCVs do not limit the
minimum flow rate or negative flow rate (flow from the To Pipe to the From Pipe). These valves are commonly found
in areas where a water district has contracted with another district or a private developer to limit the maximum demand
to a value that will not adversely affect the provider’s system.

Pressure Reducing Valves (PRVs)

Pressure reducing valves are often used for separate pressure zones in water distribution networks. These valves
prevent the pressure downstream from exceeding a specified level in order to avoid pressures that could have damaging
effects on the system.

Pressure Sustaining Valves (PSVs)

A Pressure Sustaining Valve (PSV) is used to maintain a set pressure at a specific point in the pipe network. The valve
can be in one of three states:
• Partially opened (i.e., active) to maintain its pressure setting on its upstream side when the downstream pressure is
below this value.
• Fully open if the downstream pressure is above the setting.
• Closed if the pressure on the downstream side exceeds that on the upstream side (i.e., reverse flow is not allowed).

Pressure Breaker Valves (PBVs)

Pressure breaker valves create a specified headloss across the valve and are often used to model components that cannot
be easily modeled using standard minor loss elements.

Throttle Control Valves (TCVs)

Throttle control valves simulate minor loss elements whose headloss characteristics change over time.

General Purpose Valves (GPVs)

GPVs are used to model situations and devices where you specify the flow-to-headloss relationship, rather than using
standard hydraulic formulas. GPVs can be used to represent reduced pressure backflow prevention valves, well draw-
down behavior, and turbines.

918
WaterGEMS CONNECT Edition Help
Technical Reference

Friction and Minor Loss Methods

Chezy’s Equation
Chezy’s equation is rarely used directly, but it is the basis for several other methods, including Manning’s equation.
Chezy’s equation is:

Q = Discharge in the section (m

3 /s, cfs)

C = Chezy’s roughness
coefficient (m 1/2 /s, ft.
1/2 /sec.)

A = Flow area (m 2 , ft. 2 )

R = Hydraulic radius (m, ft.)

S = Friction slope (m/m, ft./ft.)

Colebrook-White Equation
The Colebrook-White equation is used to iteratively calculate for the Darcy-Weisbach friction factor:

f = Friction factor (unitless)

k = Darcy-Weisbach roughness
height (m, ft.)

919
WaterGEMS CONNECT Edition Help
Technical Reference

Re = Reynolds Number (unitless)

R = Hydraulic radius (m, ft.)

D = Pipe diameter (m, ft.)

Hazen-Williams Equation
The Hazen-Williams Formula is frequently used in the analysis of pressure pipe systems (such as water distribution
networks and sewer force mains). The formula is as follows:

Q = Discharge in the section (m

3 /s, cfs)

C = Hazen-Williams roughness
coefficient (unitless)

A = Flow area (m 2 , ft. 2 )

R = Hydraulic radius (m, ft.)

S = Friction slope (m/m, ft./ft.)

k = Constant (0.85 for SI units,

1.32 for US units).

Darcy-Weisbach Equation
Because of non-empirical origins, the Darcy-Weisbach equation is viewed by many engineers as the most accurate
method for modeling friction losses. It most commonly takes the following form:

hL = Headloss (m, ft.)

f = Darcy-Weisbach friction
factor (unitless)

D = Pipe diameter (m, ft.)

L = Pipe length (m, ft.)

V = Flow velocity (m/s, ft./sec.)

920
WaterGEMS CONNECT Edition Help
Technical Reference

g = Gravitational acceleration
constant (m/s 2 , ft./sec. 2 )

For section geometries that are not circular, this equation is adapted by relating a circular section’s full-flow hydraulic
radius to its diameter:
D = 4R

R = Hydraulic radius (m, ft.)

D = Diameter (m, ft.)

This can then be rearranged to the form:

Q = Discharge (m 3 /s, cfs)

A = Flow area (m 2 , ft. 2 )

R = Hydraulic radius (m, ft.)

S = Friction slope (m/m, ft./ft.)

f = Darcy-Weisbach friction
factor (unitless)

g = Gravitational acceleration
constant (m/s 2 , ft./sec. 2 )

The Swamee and Jain equation can then be used to calculate the friction factor.

Swamee and Jain Equation

Note: The Kinematic Viscosity is used in determining the friction coefficient in the Darcy-Weisbach Friction
Method. The default units are initially set by Bentley Systems.

f = Friction factor (unitless)

ε = Roughness height (m, ft.)

D = Pipe diameter (m, ft.)

921
WaterGEMS CONNECT Edition Help
Technical Reference

Re = Reynolds number (unitless)

The friction factor is dependent on the Reynolds number of the flow, which is dependent on the flow velocity, which is
dependent on the discharge. As you can see, this process requires the iterative selection of a friction factor until the
calculated discharge agrees with the chosen friction factor.

Manning’s Equation

Note: Manning’s roughness coefficients are the same as the roughness coefficients used in Kutter’s equation.

Manning’s equation, which is based on Chezy’s equation, is one of the most popular methods in use today for free
surface flow. For Manning’s equation, the roughness coefficient in Chezy’s equation is calculated as:

C = Chezy’s roughness
coefficient (m 1/2 /s, ft.
1/2 /sec.)

R = Hydraulic radius (m, ft.)

n = Manning’s roughness (s/m

1/3 )

k = Constant (1.00 m 1/3 /m

1/3 , 1.49 ft. 1/3 /ft. 1/3 )

Substituting this roughness into Chezy’s equation, you obtain the well-known Manning’s equation:

Q = Discharge (m 3 /s, cfs)

k = Constant (1.00 m 1/3 /s,

1.49 ft. 1/3 /sec.)

n = Manning’s roughness
(unitless)

A = Flow area (m 2 , ft. 2 )

R = Hydraulic radius (m, ft.)

S = Friction slope (m/m, ft./ft.)

922
WaterGEMS CONNECT Edition Help
Technical Reference

Minor Losses
For pipes in series, the minor loss coefficients should be added. The differences in diameter between the original pipe
and the resulting pipe should be negligible. You should be given the option to ignore minor losses in series pipes.
For pipes in parallel, you should be given the option to ignore minor losses, not skeletonize pipes with significant minor
losses (e.g., if total Km > 100) or account for them as a change in diameter.
One possible short heuristic for handling minor losses in parallel pipes is to realize that you are splitting the minor loss
over two pipes. If the pipes are roughly the same length, roughness, and diameter, then the minor loss coefficient will
be cut approximately in half. I worked through the math for coming up with an equivalent minor loss coefficient and
it’s a mess. Using half the minor loss coefficient isn’t exactly correct, but it pretty much accounts for things.

Water Quality Theory

The governing equations for WaterGEMS water quality solver are based on the principles of conservation of mass
coupled with reaction kinetics.

Advective Transport in Pipes

A dissolved substance will travel down the length of a pipe with the same average velocity as the carrier fluid while at
the same time reacting (either growing or decaying) at some given rate. Longitudinal dispersion is usually not an
important transport mechanism under most operating conditions. This means there is no intermixing of mass between
adjacent parcels of water traveling down a pipe.
Advective transport within a pipe is represented by the following equation:

Mixing at Pipe Junctions

At junctions receiving inflow from two or more pipes, the mixing of fluid is taken to be complete and instantaneous.
Thus the concentration of a substance in water leaving the junction is the flow-weighted sum of the concentrations from
the inflow pipes .
For a specific node k one can write:

923
WaterGEMS CONNECT Edition Help
Technical Reference

Mixing in Storage Facilities

It is convenient to assume that the contents of storage facilities (tanks and reservoirs) are completely mixed. This is a
reasonable assumption for many tanks operating under fill-and-draw conditions, providing that sufficient momentum
flux is imparted to the inflow (Rossman and Grayman, 1999). Under completely mixed conditions the concentration
throughout the tank is a blend of the current contents and that of any entering water. At the same time, the internal
concentration could be changing due to reactions.
The following equation expresses these phenomena:

Bulk Flow Reactions

While a substance moves down a pipe or resides in storage, it can undergo reaction with constituents in the water
column. The rate of reaction can generally be described as a power function of concentration:

924
WaterGEMS CONNECT Edition Help
Technical Reference

When a limiting concentration exists on the ultimate growth or loss of a substance, the rate expression becomes:

Some examples of different reaction rate expressions are:

Simple 1st-Order Decay

The decay of many substances, such as chlorine, can be modeled adequately as a simple first-order reaction.
First-Order Saturation Growth

This model can be applied to the growth of disinfection by-products, such as trihalomethanes, where the ultimate
formation of by-product (CL) is limited by the amount of reactive precursor present.
Two-Component, 2nd-Order Decay

925
WaterGEMS CONNECT Edition Help
Technical Reference

This model assumes that substance A reacts with substance B in some unknown ratio to produce a product P. The rate
of disappearance of A is proportional to the product of A and B remaining. CL can be either positive or negative,
depending on whether either component A or B is in excess, respectively. Clark (1998) has had success in applying this
model to chlorine decay data that did not conform to the simple first-order model.
Michaelis-Menton Decay Kinetics

Note: These expressions apply only for values of Kb and CL used with Michaelis-Menton kinetics.

As a special case, when a negative reaction order n is specified, WaterGEMS will utilize the Michaelis-Menton rate
equation, shown above for a decay reaction. (For growth reactions the denominator becomes C L + C.) This rate
equation is often used to describe enzyme-catalyzed reactions and microbial growth. It produces first-order behavior at
low concentrations and zero-order behavior at higher concentrations. Note that for decay reactions, C L must be set
higher than the initial concentration present.
Koechling (1998) has applied Michaelis-Menton kinetics to model chlorine decay in a number of different waters and
found that both Kb and CL could be related to the water's organic content and its ultraviolet absorbance as follows:

Zero-Order Growth

926
WaterGEMS CONNECT Edition Help
Technical Reference

This special case can be used to model water age, where with each unit of time the concentration (i.e., age) increases by
one unit.
The relationship between the bulk rate constant seen at one temperature (T1) to that at another temperature (T2) is often
expressed using a van't Hoff-Arrehnius equation of the form:

In one investigation for chlorine, q was estimated to be 1.1 when T1 was 20 deg. C (Koechling, 1998).

Pipe Wall Reactions

While flowing through pipes, dissolved substances can be transported to the pipe wall and react with material such as
corrosion products or biofilm that are on or close to the wall. The amount of wall area available for reaction and the rate
of mass transfer between the bulk fluid and the wall will also influence the overall rate of this reaction. The surface area
per unit volume, which for a pipe equals 2 divided by the radius, determines the former factor. The latter factor can be
represented by a mass transfer coefficient whose value depends on the molecular diffusivity of the reactive species and
on the Reynolds number of the flow (Rossman et. al, 1994).
For first-order kinetics, the rate of a pipe wall reaction can be expressed as:

For zero-order kinetics, the reaction rate cannot be any higher than the rate of mass transfer, so:

Mass transfer coefficients are usually expressed in terms of a dimensionless Sherwood number (Sh):

927
WaterGEMS CONNECT Edition Help
Technical Reference

In fully developed laminar flow, the average Sherwood number along the length of a pipe can be expressed as:

For turbulent flow, the empirical correlation of Notter and Sleicher (1971) can be used:

System of Equations
When applied to a network as a whole, Equations 1-3 represent a coupled set of differential/algebraic equations with
time-varying coefficients that must be solved for Ci in each pipe i and Cs in each storage facility s. This solution is
subject to the following set of externally imposed conditions:
• Initial conditions that specify Ci for all x in each pipe i and Cs in each storage facility s at time 0
• Boundary conditions that specify values for Ck,ext and Qk,ext for all time t at each node k which has external mass
inputs
• Hydraulic conditions which specify the volume Vs in each storage facility s and the flow Qi in each link i at all
times t

Lagrangian Transport Algorithm

WaterGEMS water quality simulator uses a Lagrangian time-based approach to track the fate of discrete parcels of
water as they move along pipes and mix together at junctions between fixed-length time steps (Liou and Kroon, 1987).
These water quality time steps are typically much shorter than the hydraulic time step (e.g., minutes rather than hours)
to accommodate the short times of travel that can occur within pipes. As time progresses, the size of the most upstream
segment in a pipe increases as water enters the pipe while an equal loss in size of the most downstream segment occurs
as water leaves the link. The size of the segments in between these remains unchanged.
The following steps occur at the end of each such time step:
1. The water quality in each segment is updated to reflect any reaction that may have occurred over the time step.

928
WaterGEMS CONNECT Edition Help
Technical Reference

2. The water from the leading segments of pipes with flow into each junction is blended together to compute a new
water quality value at the junction. The volume contributed from each segment equals the product of its pipe's flow
rate and the time step. If this volume exceeds that of the segment, then the segment is destroyed and the next one in
line behind it begins to contribute its volume.
3. Contributions from outside sources are added to the quality values at the junctions. The quality in storage tanks is
updated depending on the method used to model mixing in the tank.
4. New segments are created in pipes with flow out of each junction, reservoir, and tank. The segment volume equals
the product of the pipe flow and the time step. The segment's water quality equals the new quality value computed
for the node.
To cut down on the number of segments, this step is only carried out if the new node quality differs by a user-
specified tolerance from that of the last segment in the outflow pipe. If the difference in quality is below the
tolerance, then the size of the current last segment in the outflow pipe is increased by the volume flowing into the
pipe over the time step.
This process is then repeated for the next water-quality time step. At the start of the next hydraulic time step, the order
of segments in any links that experience a flow reversal is switched. Initially each pipe in the network consists of a
single segment whose quality equals the initial quality assigned to the upstream node.

Behavior of Segments in the Lagrangian Solution Method

929
WaterGEMS CONNECT Edition Help
Technical Reference

Genetic Algorithms Methodology

Darwin Calibrator Methodology

Computer models have become an essential tool for the management of water distribution systems around the world.
There are numerous purposes for using a computer model to simulate the flow conditions within a system. A model can
be employed to:
• Ensure adequate quantity and quality service of the potable water resource to the community
• Evaluate planning and design alternatives
• Assess system performance
• Verify operating strategies for better management of the water infrastructure system
• Perform vulnerability studies to assess risks that may be presented and affect the water supply
For these purposes, a model is constructed in which data describing network elements of pipes, junctions, valves,
pumps, tanks, and reservoirs are assembled in a systematic manner to predict pipe flow and junction hydraulic grade
lines (HGL) or pressures within a water distribution system.
Computer models are significant investments for water companies. To ensure a good investment return and correct use
of the models, the model must be capable of correctly simulating flow conditions encountered at the site. This is
achieved by calibrating the models. A calibration involves the process of adjusting model characteristics and
parameters so that the model's predicted flows and pressures match actual observed field data to some desirable or
acceptable level. This is described in more detail in Walski, Chase and Savic (2001).
Calibration of a water distribution model is a complicated task. There are many uncertain parameters that need to be
adjusted to reduce the discrepancy between the model predictions and field observations of junction HGL and pipe
discharges. Pipe roughness coefficients are often considered for calibration. However, there are many other parameters
that are uncertain and affect junction HGL and pipe flow rate. To minimize errors in model parameters and eliminate
the compensation error of calibration parameters (Walski 2001), you should consider calibrating all the model
parameters, such as junction demand, operation status of pipes and valves, and pipe roughness coefficients.
Calibrating water distribution network models relies upon field measurement data, such as junction pressures, pipe
flows, water levels in storage facilities, valve settings, pump operating status (on/off), and pump speeds. Among all
the possible field observation data, junction HGL and pipe flows are most often used to evaluate the goodness-of-fit of
the model calibration. Other parameters, such as tank levels, valve settings, and pump operating status/speed are used
as boundary conditions that are recorded when collecting a set of calibration observations of junction pressures and
pipe flow rates.
Field observation data are measured and collected at different times of the day and at various locations on site, which
may correspond to various demand loadings and boundary conditions. In order for the model simulation results to more
closely represent observed data, simulation results must use the same demand loading and boundary conditions as
observed data. Thus, the calibration process must be conducted under multiple demand loading and operating boundary
conditions.
Traditional calibration of a water distribution model is based on a trial-and-error procedure by which an engineer or
modeler first estimates the values of model parameters, runs the model to obtain a predicted pressure and flow, and
finally compares the simulated values to the observed data. If the predicted data does not compare closely with the
observed data, the engineer returns to the model, makes some adjustments to the model parameters, and calculates it
again to produce a new set of simulation results. This may have to be repeated many times to make sure that the model

930
WaterGEMS CONNECT Edition Help
Technical Reference

produces a calibrated prediction of the water distribution network in the real world. The traditional calibration
technique is, among other things, quite time consuming.
In addition, a typical network representation of a water network may include hundreds or thousands of links and nodes.
Ideally, during the water distribution model calibration process, the roughness coefficient is adjusted for each link and
demand is adjusted for each node. However, only a small percentage of representative sample measurements can be
made available for the use of model calibration due to the limited financial and labor requirements for data collection.
Therefore, it is of utmost importance to have a comprehensive methodology and efficient tool that can assist the
engineer in achieving a highly accurate model under practical conditions, including various model parameters such as
pipe roughness, junction demand, and link status, and also multiple demand and boundary conditions.

Calibration Formulation
An optimized calibrator is formulated and developed for facilitating the calibration process of a water distribution
model. The parameters are obtained by minimizing the discrepancy between the model-predicted and the field-observed
values of junction pressures (hydraulic grades) and pipe flows for given boundary conditions. The optimized calibration
is then defined as a nonlinear optimization problem with three different calibration objectives.

Calibration Objectives
The goodness-of-fit of model calibration is evaluated by the discrepancy between the model simulated and field
measured junction HGL and pipe flow. The goodness-of-fit score is calculated by using a user-specified fitness-point-
per-hydraulic head for junctions and fitness-point-per-flow for pipes. This allows a modeler to flexibly weight the
evaluation of both pipe flow and junction hydraulic head. Three fitness functions are defined as follows:

931
WaterGEMS CONNECT Edition Help
Technical Reference

Calibration Constraints
Optimized calibration is conducted by satisfying two type constraints, the hydraulic system constraints and calibration
parameter bound constraints. The system constraints are a set of implicit equations that ensure the conservation of flow

932
WaterGEMS CONNECT Edition Help
Technical Reference

continuity at nodes and energy for the loops within a water distribution system. Each trial solution generated by the GA
is analyzed using Bentley WaterGEMS hydraulic network solver.
The calibration bound constraints are used to set the minimum and maximum limits for the pipe roughness coefficients
and junction demand multiplier. They are given as follows:

Pipes that have the same physical and hydraulic characteristics are allowed to be grouped as one calibration link, and
one new roughness coefficient or one roughness coefficient multiplier is assigned to all the pipes in the same group.
Junctions that have the same demand patterns and within a same topological area can also be aggregated as one
calibration junction to which a same demand multiplier is calculated and assigned. Calibration parameters are bounded
by prescribed upper and lower limits and adjusted with a user-prescribed incremental value. For example, a Hazen-
Williams C value for a pipe or a group of pipes will be computed within a range of 40 to 140 and by an increment of 5.
Demand multipliers may range from 0.8 to 1.2 by 0.1. Parameter aggregation is useful at reducing the calibration
dimension, however caution needs to be exercised when grouping pipes and junctions, as this may affect the accuracy
of the model calibration.

Genetic Algorithm Optimized Calibration

A genetic algorithm (GA) is a robust search paradigm based on the principles of natural evolution and biological
reproduction (Goldberg, 1989). For optimizing calibration of a water distribution model, a genetic algorithm program
first generates a population of trial solutions of the model parameters. A hydraulic solver then simulates each trial
solution. The resulting hydraulic simulation predicts the HGL (junction pressures) and pipe flows at a predetermined
number of nodes (or data points) in the network. This information is then passed back to the associated calibration
module. The calibration module evaluates how closely the model simulation is to the observed data, the calibration
evaluation computes a goodness-of-fit value, which is the discrepancy between the observed data and the model
predicted pipe flows and junction pressures or HGL, for each solution. This goodness-of-fit value is then assigned as
the fitness for that solution in the genetic algorithm.
One generation produced by the genetic algorithm is then complete. The fitness measure is taken into account when
performing the next generation of the genetic algorithm operations. To find the optimal calibration solutions, fitter
solutions will be selected by mimicking Darwin's natural selection principle of survival of the fittest. The selected
solutions are used to reproduce a next generation of calibration solutions by performing genetic operations. Over many
generations, the solutions evolve, and the optimal or near optimal solutions ultimately emerge. There are numerous
variations of genetic algorithms over the last decade. Many successful applications of GA to solving model calibrations
have been carried out for optimized calibration of water resource systems (Wang 1992; Wu 1994; Babovic etc. 1994;
Wu and Larsen 1996). More recently, a competent genetic algorithm (also called fast messy GA), which has been

933
WaterGEMS CONNECT Edition Help
Technical Reference

demonstrated the most efficient GA for the optimization of a water distribution system (Wu & Simpson 2001), has been
used for the optimized calibration. A brief overview is given in the following section.

Darwin Designer Methodology

Darwin Designer uses a genetic algorithm (GA) generic search paradigm to help hydraulic engineers efficiently plan
and design a water distribution system.
The optimization model can be established to include the combination and aggregation of sizing new pipes and
rehabilitating old pipes, multiple demand loading conditions, and various boundary system conditions. This will enable
a modeler to optimize either an entire water system or a portion of the system with the minimum cost and maximum
benefit. The cost effective design and/or rehabilitation solution is determined by the least cost, the maximum benefit, or
the trade-off between the cost and benefit. You can select any one of three optimization models to best suit your
hydraulic model needs.

Model Level 1: Least Cost Optimization

The least cost design and rehabilitation is defined as a single objective optimization; the optimal solution is determined
by the minimum cost of a water distribution design and rehabilitation that satisfies prescribed hydraulic criteria such as:
• Minimum required junction pressure
• Maximum allowable junction pressure
• Maximum allowable pipe flow velocity requirement
• Minimum required pipe flow velocity

Model Level 2: Maximum Benefit Optimization

The benefit optimization model is developed to determine the maximum pressure benefit design/rehabilitation solution
for a water distribution system. A competent genetic algorithm is employed to search for the optimal solution by
maximizing the design benefit while meeting the hydraulic criteria and the available budget.

Model Level 3: Cost-Benefit Trade-off Optimization

The cost-benefit trade-off model is formulated to determine the design of optimal trade-off between the cost and
benefit, subject to the funding available for a design and/or rehabilitation. You can customize the benefit functions and
specify the maximum affordable budget. The model produces a set of non-inferior (non-dominant) solutions that
represent the Pareto optimal for different cost and benefit levels.
Both model level 1 and 2 are single-objective optimization while level 3 is the multi-objective optimization. A modeler
is able to select optimization model for a study. The optimization framework including both the cost and benefit
functions is given in the following sections:

Design Variables

Two types of design variables are used for the optimal design and rehabilitation of water distribution systems. They are
pipe sizes (d) and design actions (e).
Pipe Size

934
WaterGEMS CONNECT Edition Help
Technical Reference

Pipe diameter is treated as a design variable for a new pipe to be sized. A new pipe can be the pipe added to a
subdivision, a replacement, or a pipe that is parallel to existing pipes. A modeler can aggregate a number of pipes as
one design link. Pipes within one pipe group are sized to the same diameter. Pipe diameter can be selected from a set of
discrete and commercially available pipe sizes, given as:

Design Action
Design action is introduced as a design variable for optimizing the rehabilitation alternatives (e.g. cleaning, relining,
replacement, parallel pipe, etc.) for existing pipes. A modeler can define a set of possible actions that can be applied to
a group of pipes. The pipes within one pipe group will have the same rehabilitation action, given as:

Cost OBJECTIVE Functions

Total cost of a network design and rehabilitation is the sum of the new pipe cost (Cnew) and rehabilitation pipe cost
(Crehab). Thus the total cost is given as:
Ctotal = Cnew + Crehab

New Pipe Cost

The cost of a new design pipe is defined as a function of pipe length. Let the total number of design pipes be DP, and
let ck(dk) be the cost per unit length of the k-th pipe diameter selected from a set of available pipe diameter D 0 of DC
choices. The new pipe cost is given as:

Rehabilitation Pipe Cost

The cost of a rehabilitation pipe is associated with the pipe diameter and the rehabilitation action. Let c k (ek, dk) be cost
per unit length of a pipe for the kth rehabilitation action ek chosen from a set of possible action E0 of EC choices for the
existing pipe of diameter dk. The cost of rehabilitation pipes is formulated as:

935
WaterGEMS CONNECT Edition Help
Technical Reference

For the pipes that are grouped into one design link, the same pipe size or rehabilitation action will be applied to the
pipes.

Benefit Functions
The goal of a water system design is to maximize the value, or benefit, of the system while reducing the cost of the
system. Minimizing cost alone may result in the smallest pipe sizes, which leads to the minimum-capacity design. The
least capacity is not the preferable solution for long term system planning; some extra pipe capacity is beneficial to
allow the supply to grow into its full capacity within a planning horizon to account for uncertainty in demands and to
meet the need for reliability in case of outages.
The true benefit of water system design is to reliably supply service of adequate water quantity and quality. Provision
of sufficient water supply must be ensured for a community not only at the present time but also in a reasonable
planning horizon. During this planning period, the amount of water required for a system, or the demand, is estimated,
and this is typically performed with some uncertainty. Thus, it is difficult to precisely forecast the demand. In order that
a design is carried out for the maximum value or benefit for a water distribution system, engineers must be able to
determine the maximum benefit within a budget.
The benefits of a design and rehabilitation may result from hydraulic performance improvement (hydraulic benefit),
excess hydraulic capacity (capacity benefit), and pipe rehabilitation improvement (rehabilitation benefit). The hydraulic
benefit is measured by using a surrogate of the junction pressure improvement. In this version of Darwin Designer, only
pressure benefit is considered.
Pressure benefit is measured by the improvement of junction pressure of a design. If the pressure at a junction exceeds
the minimum required, this shows the system has some extra capacity, which is considered a benefit. For some nodes,
where the pressure is already high, you may want to exclude the node from the pressure benefit calculation because
there is no value in increasing pressure at that node. (This is done in the Pressure Constraints tab.) For other nodes, the
first unit of pressure is worth a great deal while subsequent units of pressure improvement are not worth as much. For
example, if the minimum pressure is 20 psi, the increase from 20 to 21 psi is worth a great deal but an increase from 60
to 61 psi is not worth as much. To account for this effect, you can lower the exponent b in the benefit calculation from
the default of 1 to a lower value, say 0.5.
With the definition of a benefit function as one of design objectives, the optimal design is no longer a single-objective
(minimizing cost) optimization problem but a multi-objective (minimizing cost and maximizing benefit) one. A multi-
objective optimization enables engineers to create a design that trades off between cost and benefit. The trade-off
optimization problem is solved by using a competent genetic algorithm.
Darwin Designer concurrently optimizes two conflicting objectives and produces a set of Pareto optimal (i.e. non-
dominated, non-inferior) solutions. One objective solution, such as cost, cannot be improved (minimized) without
diminishing the other objective (reducing benefit). Therefore, a Pareto optimal solution set represents the best design
solution for each cost range. Engineers can further justify the best design by other non-quantifiable criteria.

936
WaterGEMS CONNECT Edition Help
Technical Reference

Pressure Benefits

The benefit of the hydraulic performance is measured by using junction pressure (P) improvements. Two types of
pressure benefit are provided in Darwin Designer, namely dimensionless benefit and unitized benefit.
Dimensionless Pressure Benefit
The pressure improvement for dimensionless benefit is proposed as a ratio of pressure difference between the actual
pressure and a user-defined reference pressure. The benefit is normalized by the junction demand (JQ). The factors are
also introduced to enable a modeler to convert and customize the hydraulic benefit function.

Unitized Pressure Benefit

Pressure benefit resulting from a design and rehabilitation can also be quantified by using the unitized average pressure
improvement across the entire system. The benefit functions can be given as follows:

The advantage of using the unitized pressure benefit function is that a modeler is able to evaluate the average pressure
enhancement for the investment. It is worth being aware of the value of the dollars spent.

937
WaterGEMS CONNECT Edition Help
Technical Reference

Design Constraints

Each design trial solution is analyzed by a number of hydraulic simulation runs corresponding to the multiple demand
conditions. The system responses, such as junction pressures, flow velocities, and hydraulic gradients, will be checked
against the design criteria you set.
Pipe-Size Constraint
A list of available pipe sizes (and costs) is specified and used as a commonly shared data by all the pipe groups. For
each group, you specify the minimum and maximum diameters, which narrows the scope of the optimization problem.
Pipe size is selected from a list of commercially available pipe diameters within the range of the minimum and
maximum limit, such as:

A set of pipe diameters can also be introduced to exclude the unfavorable pipe sizes to a pipe group. This set can be
noted as:

Junction-Pressure Constraint
Junction pressure is often required to maintain greater than a minimum pressure level to ensure adequate water service,
and less than a maximum pressure level to reduce water leakage in a system. Thus junction pressure constraints are
given as:

Pipe Flow Constraint

A design and rehabilitation solution is also constrained by a set of pipe flow criteria that are often given as a maximum
allowable flow velocity and a maximum allowable hydraulic gradient or slope, given as:

938
WaterGEMS CONNECT Edition Help
Technical Reference

In many system improvement designs, a feasible design solution must ensure the storage tank to be refilled to a certain
water level so that a stable periodical supply can be established. To meet a tank refilling criteria, pipe flow velocity
must be greater than the minimum required velocity, given as:

Budget Constraint
Water utilities are often constrained by a budget for a new subdivision design and/or the rehabilitation of an existing
water system. When the optimization is conducted to maximize the value or benefit of the design, the optimal solution
will be constrained by the available funding.

Multi Objective Genetic Algorithm Optimized Design

Genetic algorithms have been widely applied to solving single-objective optimization problems in water resources
system analysis (Bavic et al. 1994; Wu and Simpson 1996, 1997a, 1997b and 2001; Wu et al. 2000 and 2001). In recent
years, multi-objective genetic algorithms have been found to be more effective than traditional optimization techniques
at solving multi-objective optimization problems. A wide range of multi-objective optimization problems have been
successfully solved by using evolutionary algorithms.
There is no need to modify or simplify the system hydraulics and design criteria to fit multi-objective GA. Single-
objective optimization is used to identify the optimal or near-optimal solutions according to the sole objective function.
As soon as a solution is found better than the current-best solution, it is accepted. Multi-objective optimization is to
locate the non-inferior (or non-dominated) solutions in solution space. Solution A is called non-inferior to solution B if
and only if solution A is no worse than solution B in all the objectives. It is also said that solution A dominates solution
B or that solution A is a non-dominated solution. A global non-dominated solution is defined as the solution that is no
worse than any other feasible solutions in all the objectives. There exist multiple global non-dominated solutions. The
task of a multi-objective optimization is to search for all the global non-dominated or non-inferior solutions also known
as the Pareto-optimal set or Pareto-optimal front.
Conventionally, a multi-objective optimization problem was transformed into a single-objective optimization problem
by using two approaches including weighted sum of objectives and e-constraint method (Cohon, 1978). Weighted sum

939
WaterGEMS CONNECT Edition Help
Technical Reference

approach applies a set of weighting factors to all the objectives and sums up the weighted objectives to construct a
composite single objective. It is expected that the optimization of a composite objective is equivalent to the
optimization of the original multiple objectives, but the optimal solution depends on the chosen weights and it can only
search for a single optimal solution rather than Pareto-optimal solutions in one run. The constraint method chooses one
of the objective functions and treats the other objective functions as constraints. Each of the constraints is limited to a
prescribed value. It transforms a multi-objective optimization problem into a single-objective optimization. The optimal
solution resulted by the constraint method, however, depends on the pre-defined constraint limits. Pareto-optimal
solutions can be obtained by performing multiple runs of the single-objective optimization problem using different
weighting factors or constraint limits. The more combinations of weighting factors or constraint limits, the more
optimization runs are required, the greater the computational cost. In contrast, multi-objective genetic algorithm
concurrently optimizes all the objective functions in one run without any fix-up on objective functions. It provides an
effective method for handling multi-objective optimization.
The goal of single-objective optimization is to search for an optimal solution. Multi-objective optimization has two
goals during the search process. One goal is to find a set of Pareto-optimal solutions as close as possible to Pareto-
optimal front. The second goal is to maintain a set of Pareto-optimal solutions as diverse as possible. Searching for
Pareto-optimal solutions is certainly the primary task for multi-objective optimization. A solution of single-objective
optimization problem is evaluated by the objective value, which directly contributes to the fitness of the corresponding
genotype solution. However, the fitness of a solution for multi-objective optimization problem is determined by the
solution dominance that can be defined as the number of solutions dominated among the current population of
solutions. The stronger the dominance, the greater the fitness is assigned to a solution. While identifying Pareto-optimal
solutions is important, maintaining the diversity of Pareto-optimal solutions is also essential. Dealing with multi-
objective optimization, such as minimizing cost and maximizing benefit for a water distribution system, it is anticipated
that optimal trade-off solutions are found and uniformly distributed for the entire range of cost budget. This is normally
achieved by using a method of fitness sharing or solution clustering.
To effectively solve the problem of cost-benefit trade-off optimal design, as formulated in the early section, fast messy
genetic algorithm (Goldberg et al. 1993) has been extended to handle the multi-objective functions. The multi-objective
fast messy GA has been integrated with the WaterGEMS hydraulic network solver. The integrated approach (Wu et al.
2002) provides a powerful design optimization tool to assist hydraulic engineers to practically and efficiently design a
water distribution system. It offers capability of three levels of optimization design analysis, including minimum cost
design, maximum benefit design and cost-benefit trade-off design optimization.

Competent Genetic Algorithms

The working mechanics of a genetic algorithm are derived from a simple assumption (Holland 1975) that the best
solution will be found in the solution region that contains a relatively high proportion of good solutions. A set of strings
that represent the good solutions attains certain similarities in bit values. For example, 3-bit binary strings 001, 111, 101
and 011 have a common similarity template of **1, where asterisk (*) denotes a don't-care symbol that takes a value of
either 1 or 0. The four strings represent four good solutions and contribute to the fitness values of 10, 12, 11, and 11 to
a fitness function of:

Where x1, x2, and x3 directly take a bit value as an integer from left to right. In general, a short similarity template that
contributes an above-average fitness is called a building block. Building blocks are often contained in short strings that
represent partial solutions to a specific problem. Thus, searching for good solutions uncovers and juxtaposes the good
short strings, which essentially designate a good solution region, and finally leads a search to the best solution.
Goldberg et al. (1989) developed the messy genetic algorithm as one of the competent genetic algorithm paradigms by
focusing on improving GA's capability of identifying and exchanging building blocks. The first-generation of the messy

940
WaterGEMS CONNECT Edition Help
Technical Reference

GA explicitly initializes all the short strings of a desired length k, where k is referred as to the order of a building block
defined by a short string. For a binary string representation, all the combinations of order-k building blocks require a
number of initial short strings of length k for an l-bit problem:

For example, the initial population size of short strings, by completely enumerating the building blocks of order 4 for a
40-bit problem, is more than one million. This made the application of the first-generation messy GA to a large-scale
optimization problem impossible. This bottleneck has been overcome by introducing a building block filter procedure
(Goldberg et al. 1993) into the messy GA. The filter procedure speeds up the search process and is called a fast messy
GA.
The fast messy GA emulates the powerful genetic-evolutionary process in two nested loops, an outer loop and an inner
loop. Each cycle of the outer loop, denoted as an era, invokes an initialization phase and an inner loop that consists of a
building block filtering phase and a juxtapositional phase. Like a simple genetic algorithm, the messy GA initialization
creates a population of random individuals. The population size has to be large enough to ensure the presence of all
possible building blocks. Then a building block filtering procedure is applied to select better-fit short strings and reduce
the string length. It works like a filter so that bad genes not belonging to building blocks are deleted, so that the
population contains a high proportion of short strings of good genes. The filtering procedure continues until the overall
string length is reduced to a desired length k. Finally, a juxtapositional phase follows to produce new strings. During
this phase, the processed building blocks are combined and exchanged to form offspring by applying the selection and
reproduction operators. The juxtapositional phase terminates when the maximum number of generations is reached, and
the cycle of one era iteration completes. The length of short strings that contains desired building blocks is often
specified as the same as an era, starting with one to a maximum number of era. Because of this, preferred short strings
increase in length over outer iterations. In other words, a messy GA evolves solutions from short strings starting from
length one to a maximum desired length. This enables the messy GA to mimic the natural and biological evolution
process that a simple or one cell organism evolves into a more sophisticated and intelligent organism. Goldberg et al.
(1989, 1993) has given the detail analysis and computation procedure of the messy GA.

Energy Cost Theory

The concept behind energy usage for a water distribution system is simple: pumps are used within a system to add
energy, counteracting the energy losses that occur due to pipe friction and other losses. The cost of operating these
pumps, however, can be one of the largest expenses that a utility incurs during normal operations. An accurate
understanding of these energies and the costs associated with them is the key to developing better, more efficient, and
more economical pumping strategies.

941
WaterGEMS CONNECT Edition Help
Technical Reference

Pump Powers, Efficiencies, and Energy

Power is the rate at which energy can be transferred, and there are several different powers that are associated with the
pumping process. In order for power to be transferred to the water, it needs to go through several steps: from the
electrical wires into the pump motor, from the motor into the pump, and finally from the pump to the water itself. Each
transfer results in energy losses.

Water Power

942
WaterGEMS CONNECT Edition Help
Technical Reference

Water power is the power associated with the water itself and is a function of the fluid characteristics, the gain in head,
and the rate of discharge.

Brake Power and Pump Efficiency

Brake power is the power at the pump itself and is related to the water power by:

In other words, the pump efficiency represents the ability of the pump to transfer power from the pump itself to the
water. The pump efficiency varies over the operating range of the pump, so it is important to model pump efficiency as
closely as possible to ensure an accurate representation of your system.

Motor Power and Motor Efficiency

Motor power is the power that the pump's motor receives from the electrical utility and is related to the pump brake
power by:

In other words, the motor efficiency represents that ability of the motor to transfer power from the electrical lines to the
pump itself. For most pumps, the motor efficiency can be considered to be constant over the whole operating range of
the pump.

Note: In the case of variable speed pumps, the efficiency of the variable speed drive needs to be accounted for.
This efficiency varies with pump speed among other things. You are encouraged to correct the motor efficiency
to include the variable speed drive efficiency. For variable speed pumps, there is a drive mechanism between the
motor and the pump itself. There are also energy losses associated with this drive, which may be significant in
some cases.

943
WaterGEMS CONNECT Edition Help
Technical Reference

For example, if a motor has an efficiency of 90% (0.90) and the variable speed drive has an efficiency of 85% (0.85) at
the speeds being used, then the motor efficiency should be entered as 76.5% (0.765).

Note: The variable-speed data is merely presented as an example and should not be construed as representative
of any particular pump.

You are encouraged to find the drive efficiency data for the specific drive that is being used. See the Variable Speed
Drive Efficiency table below for some typical data for variable speed drive efficiency found in the report, "Operations
and Training Manual on Energy Efficiency in Water and Wastewater Treatment Plants," TREEO Center, University of
Florida, 1986.
Variable Speed Drive Efficiency

Percent of Full Speed Variable Frequency Drive Eddy Current Coupling Hydraulic Coupling

100 83 85 83

90 82 78 75

70 81 59 56

50 76 43 33

These corrections should not be made to alternatives with constant speed pumps. If you are performing an analysis to
compare constant and variable speed pumps, you should set up two alternatives: one for the constant speed pump and a
second for the variable speed pump.

Energy
Energy is a representation of the ability to do work and is related to power by:

Although water energy and pump energy could be calculated, the motor energy is the primary consideration for water
distribution systems because this is the energy that the utility is billed for.

Cost
There are several different methods that an electrical provider may use to bill for their energy. The most common bases
of billing are:
Energy Usage Cost
Energy usage costs are simple: there is a cost associated with a unit of energy. This price may vary for different times
of day, different days of the week, different seasons, etc., but the basic concept is still the same.
Peak Usage Cost

944
WaterGEMS CONNECT Edition Help
Technical Reference

Some energy providers also charge customers based on peak usage (sometimes also called a ratchet charge). This
charge is actually based on power rather than energy, with the cost being based on the highest instantaneous power that
the customer used during the billing cycle.

Storage Considerations
Tank storage can have a considerable effect on the estimated energy costs for a system. As tanks fill or drain, they also
act as an energy (and therefore cost) storage element. If a tank is full when a simulation begins and empty when it ends,
there is an energy deficit-at some point the pumps will need to operate again in order to replenish the tank. Likewise, if
a tank begins empty and fills over the course of a simulation, that represents an energy credit when the total daily cost
is calculated.

Daily Cost Equivalents

Different scenarios may have different analysis durations, so a direct comparison of costs would not be equitable. To
normalize all analyses to a common reference, costs are also converted as daily equivalents.
For energy costs and storage costs, the total computed cost is adjusted according to the ratio of a single day to the
analysis duration. For peak usage cost, a daily cost is computed by dividing the peak usage cost by the number of days
in a billing cycle.

VSP Interactions with Simple and Logical Controls

The VSP model and APEX have been designed to fully integrate with the simple and rule based control framework
within WaterGEMS CONNECT. You must keep in mind that the definition of controls requires that the state (On, Off,
Fixed Speed Override) and speed setting of a VSP be properly managed during the simulation. Therefore, the
interactions between VSPs and controls can be rather complex. We have tried to the extent possible to simplify these
interactions while maintaining the power and flexibility to model real world behaviors. The paragraphs that follow
describe guidelines for defining simple and logical controls with VSPs.
• Pattern based VSPs—The pattern of relative speed factors specified for a VSP takes precedence over all simple
and logical control commands. Therefore, the use of controls with pattern based VSPs is not recommended. Rather,
the pattern of relative speed factors should be defined such that control objectives are implicitly met.
• VSPs with APEX—A VSP can be switched into any one of three different states. When the VSP is On, the APEX
will estimate the relative speed sufficient to maintain a constant pressure head at the control node. When the VSP is
Off, the relative speed factor and flow through the pump are set to zero, and the pressure head at the control node is
a function of the prevailing network boundary and demand conditions. When the control state of a VSP is Fixed
Speed Override, the pump will operate at the maximum speed setting and the target head will no longer be
maintained. The Temporarily Closed state for a VSP indicates that the check valve (CV) within the pump has closed
in response to prevailing hydraulic conditions, and that the target head cannot be maintained. The VSP control node
can be specified at any junction node or tank in a network model. As described below, however, the behavior of
simple and logical controls depends on the type of control node selected.
• Junction Nodes—When the VSP control node type selected is a junction node, the VSP will behave according to
some automatic behaviors in addition to the controls defined for the pump. If the head at the control node is above
the target head, the pump state will automatically switch to Off. If the head at the control node is less then the target
head, the pump state will automatically switch to On. The VSP will automatically switch into and out of the Fixed
Speed Override and Temporarily Closed states in order to maintain the fixed head at the control node and prevent
reverse flow through the pump. Additional controls can be added to model more complex use cases.

945
WaterGEMS CONNECT Edition Help
Technical Reference

• Tanks—When the VSP control node is a tank, you must manage the state of the pump through control definitions,
allowing for flexible modeling of the complex control behaviors that may be desired for tanks. If a VSP has a state
of On, the pump will maintain the current level of the tank. For example, at the beginning of a simulation, if a VSP
has status of on it will maintain the initial level of the tank. As the simulation progresses and the pump happens to
turn off, temporarily close, or go into fixed speed override, the level in the tank will be determined in response to
the hydraulic conditions prevailing in the network. When the VSP turns on again, it will maintain the current level
of the tank, not the initial level. Thus control statements must be written that dictate what state the pump should
switch to depending on the level in the tank. A pump station with a VSP and a fixed-speed pump operating in a
coordinated fashion can be used to model tank drain and fill operations.

Performing Advanced Analyses

This section outlines the rules that Skelebrator uses for creating equivalent pipes from parallel or series pipes.
These equations can be solved for equivalent diameter or roughness (C, n or k). With the Darcy-Weisbach equation, the
equations are solved only for D because there are situations where the roughness can be negative. Both solutions are
presented. In general, there will be one pipe that is the dominant pipe, and the properties of that pipe will be used when
a decision must be made. There will be some default rule for picking the dominant pipe, but you will be able to override
it.
You will not use equivalent lengths because you want to preserve the system geometry. For pipes in parallel, you will
use the length of the dominant pipe while for pipes in series, you will add the lengths of the two pipes as follows:
Lr = L1 + L2

Hydraulic Equivalency Theory

This section outlines the rules that Skelebrator uses for creating equivalent pipes from parallel or series pipes.
These equations can be solved for equivalent diameter or roughness (C, n or k). With the Darcy-Weisbach equation, the
equations are solved only for D because there are situations where the roughness can be negative. Both solutions are
presented. In general, there will be one pipe that is the dominant pipe, and the properties of that pipe will be used when
a decision must be made. There will be some default rule for picking the dominant pipe, but you will be able to override
it.
You will not use equivalent lengths because you want to preserve the system geometry. For pipes in parallel, you will
use the length of the dominant pipe while for pipes in series, you will add the lengths of the two pipes as follows:
Lr = L1 + L2

Principles
The equations derived below are based on the following principles. The equations below are for two pipes but can be
extended to n pipes.
For pipes in series:
Qr = Q1 = Q2
where Q = flow, r refers to the resulting pipe, and 1 and 2 refer to the pipes being removed.
hr = h1 + h2

946
WaterGEMS CONNECT Edition Help
Technical Reference

For pipes in parallel:

Qr = Q1 + Q2
and
hr = h1 = h2
As long as the units are consistent, then any appropriate units can be used. For example, if the diameters are in feet,
then the resulting diameter will be in feet.

Hazen-Williams Equation

K depends on the units but cancels out in equivalent pipe calculations.

Series Pipes
For series pipes, the length is based on the sum of the lengths.
Solved for C:

Solved for D:

Parallel Pipes
Solved for C:

947
WaterGEMS CONNECT Edition Help
Technical Reference

Solved for D:

Manning’s Equation

Series Pipes
Solved for n:

Solved for D:

948
WaterGEMS CONNECT Edition Help
Technical Reference

Parallel Pipes
Solved for n:

Solved for D:

Darcy-Weisbach Equation

It is the roughness k-not f-that is a property of the pipe. While f behaves well, the roughness can take on negative
values in the parallel pipe case. Therefore, only solutions for D will be developed.
The other problem with the Darcy-Weisbach equation is that D and f are not uniquely related and depend on the
Reynolds number, which is a function of velocity. So the question that must be first answered is, Which value of f
should be used in the equations? This is especially tricky when the individual pipes have different values of k. First, a
velocity of 1 m/s will be used as a reference velocity to calculate Reynolds number for the individual pipes. Second, an
iterative solution must be used to solve for D.
That is
1. Pick a D and k based on the dominant pipe.
2. Calculate f for the resultant pipe using Swamee-Jain formula.
3. Use that f for fr in the equations below.
4. Check if Dr is close enough to D used to calculate f.
5. Repeat until convergence.
The Swamee-Jain equation is:

949
WaterGEMS CONNECT Edition Help
Technical Reference

where

v must be selected so that the units cancel. Typical values are 1.00e-6 m 2/s or 1.088e-5 ft.2/s.
Series Pipes

Parallel Pipes

Check Valves
For series pipes, if any pipe has a check valve, then the resulting pipe will have a check valve. For parallel pipes, if both
pipes have check valves, then the resulting pipe will have a check valve.
The degenerative case is when one of the parallel pipes has a check valve. This should not happen in terms of good
engineering. If it does, the parallel pipes should not be combined and a warning message should be issued.

Minor Losses
For pipes in series, the minor loss coefficients should be added. The differences in diameter between the original pipe
and the resulting pipe should be negligible. You should be given the option to ignore minor losses in series pipes.
For pipes in parallel, you should be given the option to ignore minor losses, not skeletonize pipes with significant minor
losses (e.g., if total Km > 100) or account for them as a change in diameter.
One possible short heuristic for handling minor losses in parallel pipes is to realize that you are splitting the minor loss
over two pipes. If the pipes are roughly the same length, roughness, and diameter, then the minor loss coefficient will
be cut approximately in half. I worked through the math for coming up with an equivalent minor loss coefficient and
it’s a mess. Using half the minor loss coefficient isn’t exactly correct, but it pretty much accounts for things.

950
WaterGEMS CONNECT Edition Help
Technical Reference

Numerical Check
To check the equations, run through examples of each. Solve for head loss in each pipe individually and then combine
to see how the head loss in the equivalent pipe compares for series pipes and for parallel, see how the flow compares.
Stick with the SI units (i.e., flow in m3/s, D, L and h in m).
Series
Use Q = 1 m3/s and solve for head loss. Pipe 1 is the dominant pipe.
Comparison between the Sum of the Headlosses from the Two Pipes and the Headloss from the Equivalent Pipe

Pipe 1 Pipe 2 Resulting, solve for D Resulting, solve for C,n

Length 100 80 180 180

Diameter 1 0.75 0.88 0.75k, 0.855n

C 100 120 100 71

k 0.002 0.0015 0.002 X

n 0.013 0.012 0.013 0.0197

h (Hazen) 0.21 0.49 0.72 0.72

h (Manning) 0.17 0.55 0.72 0.72

h (Darcy) 0.20 0.58 0.77 X

Parallel
Use head loss = 1 m and solve for Q .
Comparison between the Sum of the Flows from the Two Pipes and the Flow from the Equivalent Pipe

Pipe 1 Pipe 2 Resulting, solve for D Resulting, solve for C,n

Length 100 80 100 100

Diameter 1 0.75 0.88 1.18n, 1.21k

C 100 120 100 163

k 0.002 0.0015 0.002 X

n 0.013 0.012 0.013 0.0083

Q (Hazen) 2.31 1.47 3.74 3.77

Q (Manning) 2.40 1.35 3.72 3.75

Q (Darcy) 2.26 1.31 3.55 X

951
WaterGEMS CONNECT Edition Help
Technical Reference

Thiessen Polygon Generation Theory

Plane Sweep Method (on page 952)

Naïve Method
A Thiessen polygon of a site, also called a Voronoi region, is the set of points that are closer to the site than to any of
the other sites.
Let P = {p1, p2,…pn} be the set of sites and V = {v(p1), v(p2),…v(pn)} represent the Voronoi regions or Thiessen
polygons for Pi,which is the intersection of all of the half planes defined by the perpendicular bisectors of pi and the
other sites. Thus, a naïve method for constructing Thiessen Polygons can be formulated as follows:
Step 1 For each i such that i = 1, 2,…, n, generate n - 1 half planes H(pi,pj), 1 </= j </= n, i <> j, and construct their
common intersection v(pi).
Step 2 Report V = {v(p1), v(p2),…v(pn)} as the output and stop.
This naïve procedure is, however, very inefficient for generating Thiessen polygons. The computation time increases
exponentially as the number of sites increases. There are many other more competent methods for constructing a
Thiessen polygon.

Plane Sweep Method

952
WaterGEMS CONNECT Edition Help
Technical Reference

Method for Modeling Pressure Dependent Demand

A water distribution system does not always supply the required or normal demand to customers under all conditions. It
is important for water companies to be informed to what degree or level that a water system is able to supply its
customers when an emergency or calamity scenario occurs. A calamity event can be one or more than one element out

953
WaterGEMS CONNECT Edition Help
Technical Reference

of service. When such an event occurs, it is expected that the service can only be maintained to a certain level before
the outage is fully recovered.
In order to deal with a recoverable calamity, the concept of water supply is introduced to quantify the supply capacity
of a water distribution system. It is defined as a percentage of the supplied demand over the normal demand. Water
companies are required to comply the minimum water supply level under a calamity of one element outage, which is
expected to be fully repaired within 24 hours. The modeling approach for evaluating water supply level for the use
cases as follows.
Use Cases (on page 954)

Use Cases
In 1994, the Dutch water authority posted the guideline for water companies to evaluate the level of water supply while
coping with calamity events. A tentative guideline requirement is that a water system must meet 75% of the original
demand for the majority of customers and no large group of customers (2000 resident addresses) should receive less
than 75% of their original demand.
The guideline is applicable to all the elements between the source and tap in a water system and is required to find the
effect of every element. In order to calculate the water supply level under a calamity event, a hydraulic modeling
approach is proposed:
1. Take one element at a time out of a model, copying the calamity event of element outage
2. Run the model for peak hours of all demand types and also the peak hours of tank filling. The actual demand needs
to be modeled as a function of pressure; the supply is considered unaffected if the pressure is above the required
pressure threshold
3. Evaluate the water supply level for each demand node. If there is less than 2000 resident customers receiving less
than 75% of the normal demand, then the requirement is met. Repeat Step 1 to simulate another calamity event. If
the requirement is not met, continue with step 4.
4. Perform 24 hours pressure dependent demand simulation for the maximum demand day under the calamity even
5. Sum up the actual demand for each node over 24 hours
6. Check if there is any node where the totalized demand over 24 hours is less than 75% of the maximum day demand;
if not, the guideline is met. Otherwise an appropriate system improvement needs to be identified in order to meet the
guideline.
UK water companies are required by law to provide water at a pressure that will, under normal circumstances, enable it
to reach the top floor of a house. In order to assess if this requirement is satisfied, companies are required to report
against a service level corresponding to a pressure head of 10 meters at a flow of 9 liters per minute. In addition, water
companies are also required to report the supply reference for unplanned and planned service interruptions.
Both use cases provide some generality for water utilities world wide to evaluate the performance of water systems
under emergency and low pressure conditions. An emergency event can be specified as one set of element outages. In
order to quantify the water supply level under such an event, the demand must be modeled as a function of nodal
pressure. Hydraulic model needs to be enhanced to perform pressure dependent demand simulation and to compute the
level of certainty/supply level.

Supply Level Evaluation

Assume Qi to be the normal demand at node i. Qis,j represents the actual supplied demand at node i under calamity
event j, the supply level at node i for event j is given as:

954
WaterGEMS CONNECT Edition Help
Technical Reference

This gives the percentage of the demand that a system supplies to node i under calamity event j. The key is to calculate
the actual supply demand Qis under the outage that may cause lower than required junction pressure. The less the
demand, the greater the impact the calamity is on the system supplied capacity and the more critical the element is to
the system.

Pressure Dependent Demand

Whenever a calamity occurs, the systems pressures are affected. Some locations may not have the required pressure.
Nodal demand, water available at a location, is dependent on the pressure at the node when the pressure is low. Unlike
the conventional approach of demand driven analysis, demand is a function of pressure, Pressure Dependent Demand
(PDD). However, it is believed that a junction demand is not affected by pressure if the pressure is above a threshold.
The junction demand is reduced when the pressure is dropping below the pressure threshold and it is zero when the
pressure is zero.
PDD can be defined as one of two pressure demand relationships including a power function and a pressure demand
piecewise linear curve (table). The power function is given as:

Where:
Hi = calculated pressure at node iQri = requested demand or reference demand at node iQsi = calculated demand at
node iHri = reference pressure that is deemed to supply full requested/reference demandHt = pressure threshold above
which the demand is independent of nodal pressure

= exponent of pressure demand relationship.

A typical PDD power function is illustrated below. The actual demand increases to the full requested demand (100%)
as pressure increases but remains constant after the pressure is greater than the pressure threshold, namely the percent
of pressure threshold is greater than 100%.

955
WaterGEMS CONNECT Edition Help
Technical Reference

Pressure demand piecewise linear curve is specified as a table of pressure percentage vs. demand percentage. Pressure
percentage is the ratio of actual pressure to a nodal threshold pressure while demand percentage is the ratio of the
calculated demand to the reference demand.

Demand Deficit
When a calamity event is modeled, the total supplied demand may be less than the normal required demand. The
difference between the calculated demand and the normal required demand is a demand deficit that is evaluated under a
prescribed supply level threshold. The total system demand deficit under one possible calamity event j:

Where

is the deficit demand at event j and St is the threshold of supply level. This formula provides the method for evaluating
water supply level, element criticality, and modeling pressure dependent demand.

Solution Methodology

956
WaterGEMS CONNECT Edition Help
Technical Reference

The key solution methodology is how to solve for the pressure dependent demand. Conventionally, nodal demand is a
known value. Applying the mass conservation law to each node and energy conservation law to each loop, the network
hydraulics solution can be obtained by iteratively solving a set of linear and non-linear equations. A unified formulation
for solving network hydraulics is given as a global gradient algorithm (GGA).

Where Q is the unknown pipe discharge and H is the unknown nodal head. q is the set of nodal demand that is not
dependent on the nodal head H.
For pressure dependent demand, the demand is no longer a known value but a function of nodal pressure. The solution
matrix becomes:

A new diagonal matrix A22 is added to the solution matrix. The non-zero diagonal element is given as

Modified GGA Solution

By following the original derivation of GGA, pressure dependent demand formula can be solved as:

The difference from the original GGA is the new diagonal matrix D22, which is the deviation of A22 of pressure head
H.

957
WaterGEMS CONNECT Edition Help
Technical Reference

The modified GGA is to calculate D22 for each pressure dependent demand node and add at A(i, i) as follows:

where j denotes the pipe j that is connected with node i. This notation is the same as the EPANET2 engine code.

Direct GGA Solution

Babovic V., Wu Z. Y. & Larsen L. C., “Calibrating Hydrodynamic Models by Means of Simulated Evolution,” in
Proceeding of Hydroinformatics, Delft, Netherlands, pp193-200, 1994.
Benedict, R. P., Fundamentals of Pipe Flow, John Wiley and Sons, Inc., New York, 1980.
Brater, Ernest F. and Horace W. King, Handbook of Hydraulics, McGraw-Hill Book Company, New York, 1976.
Boulos, P. F. and D. J. Wood, “Explicit Calculation of Pipe-Network Parameters,” Journal of Hydraulic Engineering,
ASCE, 116(11) 1329-1344, 1987.
Cesario, A. Lee, Modeling, Analysis, and Design of Water Distribution Systems, AWWA, 1995.
Clark, R.M., “Chlorine demand and Trihalomethane formation kinetics: a second-order model,” Journal of
Environmental Engineering, Vol. 124, No. 1, pp. 16-24, 1998.
Clark, R. M., W. M. Grayman, R. M. Males, and A. F. Hess, “Modeling Contaminant propagation in Drinking Water
Distribution Systems,” Journal of Environmental Engineering, ASCE, New York, 1993.
Cohon, J.L., Multi-objective Programming and Planning. Academic Press, New York, 1978.
Computer Applications in Hydraulic Engineering, Fifth Edition, Waterbury, Connecticut, Haestad Press, 2002.
CulvertMaster User’s Guide, Waterbury, Connecticut, Haestad Methods, 2000.
Dunlop, E.J., WADI Users Manual, Local Government Computer Services Board, Dublin, Ireland, 1991.
Essential Hydraulics and Hydrology, Waterbury, Connecticut, Haestad Press, 1998.
FlowMaster PE Version 6.1 User’s Guide, Waterbury, Connecticut, Haestad Methods, 2000.
George, A. & Liu, J. W-H., Computer Solution of Large Sparse Positive Definite Systems, Prentice-Hall, Englewood
Cliffs, NJ, 1981.
Goldberg, D.E., Genetic Algorithms in Search, Optimization and Machine Learning. Addison Wesley, Reading, MA,
1989.

958
WaterGEMS CONNECT Edition Help
Technical Reference

Goldberg, D. E., Korb, B., & Deb, K., “Messy genetic algorithms: Motivation, analysis, and first results,” Complex
Systems, 3, 493-530, 1989.
Goldberg, D. E., Deb, K., Kargupta, H., & Harik G., “Rapid, Accurate Optimization of Difficult Problems Using Fast
Messy Genetic Algorithms,” IlliGAL Report No. 93004, Illinois Genetic Algorithms Laboratory, University of Illinois
at Urbana-Champaign, Urbana, IL 61801, 1993.
Hamam, Y.M., & Brameller, A., “Hybrid method for the solution of piping networks,” Proc. IEE, Vol. 113, No. 11, pp.
1607-1612, 1971.
International Conference on Computer Applications for Water Supply and Distribution, Leicester Polytechnic, UK,
September 8-10.
Koechling, M.T., Assessment and Modeling of Chlorine Reactions with Natural Organic Matter: Impact of Source
Water Quality and Reaction Conditions, Ph.D. Thesis, Department of Civil and Environmental Engineering, University
of Cincinnati, Cincinnati, Ohio, 1998.
Lingireddy, S. and D.J. Wood, “Improved Operation of Water Distribution Systems Using Variable Speed Pumps,”
Journal of Energy Engineering, ASCE, 124(3) 90-103, 1998.
Liou, C.P. and Kroon, J.R., “Modeling the propagation of waterborne substances in distribution networks,” J. AWWA,
79(11), 54-58, 1987.
Males R. M., W. M. Grayman and R. M. Clark, “Modeling Water Quality in Distribution System,” Journal of Water
Resources Planning and Management, ASCE, New York, 1988.
Notter, R.H. and Sleicher, C.A., “The eddy diffusivity in the turbulent boundary layer near a wall,” Chem. Eng. Sci.,
Vol. 26, pp. 161-171, 1971.
Osiadacz, A.J., Simulation and Analysis of Gas Networks, E. & F.N. Spon, London, 1987.
Practical Guide to Hydraulics and Hydrology, Waterbury, Connecticut, Haestad Press, 1997.
Roberson, John A., John J. Cassidy, and Hanif M. Chaudhry, Hydraulic Engineering, Houghton Mifflin Company,
Massachusetts, 1988.
Roberson, John A. and Clayton T. Crowe, Engineering Fluid Mechanics 4th Edition, Houghton Mifflin Company,
Massachusetts, 1990.
Rossman, Lewis A., EPANET User’s Manual (AWWA Workshop Edition), Risk Reduction Engineering Laboratory,
Office of Research and Development, USEPA, Ohio, 1993.
Rossman, Lewis A. et al., “Numerical Methods for Modeling Water Quality in Distribution Systems: A Comparison,”
Journal of Water Resources Planning and Management, ASCE, New York, 1996.
Rossman, Lewis A., R. M. Clark, and W. M. Grayman, “Modeling Chlorine Residuals in Drinking-water Distribution
Systems,” Journal of Environmental Engineering, ASCE, New York, 1994.
Rossman, L.A., Boulos, P.F., and Altman, T., “Discrete volume-element method for network water-quality models,”
Journal of Water Resource Planning and Management, Vol. 119, No. 5, 505-517, 1993.
Rossman, L.A., Clark, R.M., and Grayman, W.M., “Modeling chlorine residuals in drinking-water distribution
systems,” Journal of Environmental Engineering, Vol. 120, No. 4, 803-820, 1994.
Rossman, L.A. and Boulos, P.F., “Numerical methods for modeling water quality in distribution systems: A
comparison,” Journal of Water Resource Planning and Management, Vol. 122, No. 2, 137-146, 1996.
Rossman, L.A. and Grayman, W.M., “Scale-model studies of mixing in drinking water storage tanks,” Journal of
Environmental Engineering, Vol. 125, No. 8, pp. 755-761, 1999.

959
WaterGEMS CONNECT Edition Help
Technical Reference

Salgado, R., Todini, E., & O’Connell, P.E., “Extending the gradient method to include pressure regulating valves in
pipe networks,” Proc. Inter. Symposium on Computer Modeling of Water Distribution Systems, University of
Kentucky, May 12-13, 1988.
Sanks, Robert L., Pumping Station Design, Butterworth-Heinemann, Inc., Stoneham, Massachusetts, 1989.
Streeter, Victor L. and Wylie, E. Benjamin, Fluid Mechanics, McGraw-Hill Book Company, New York, 1985.
Todini, E. and S. Pilati, “A Gradient Algorithm for the Analysis of Pipe Networks,” Computer Applications in Water
Supply, Volume 1 - Systems Analysis and Simulation, ed. Bryan Coulbeck and Chun-Hou Orr, Research Studies Press
Ltd., Letchworth, Hertfordshire, England.
Todini, E. & Pilati, S., “A gradient method for the analysis of pipe networks,” 1987.
Walski, T.M., “Model Calibration Data: The Good, The Bad and The Useless,” J. AWWA, 92(1), p. 94, 2000.
Walski, T. M., “Understanding the adjustments for water distribution system model calibration,” Journal of Indian
Water Works Association, April-June, 2001, pp151-157, 2001.
Walski, T.M., Chase, D.V. and Savic, D.A., Water Distribution Modeling, Haestad Press, Waterbury, CT, 2001.
Walski, Thomas M., Water System Modeling Using CYBERNET, Waterbury, Connecticut, Haestad Methods, 1993.
Wang Q.J., “The Genetic Algorithm and its Application to Conceptual Rainfall-Runoff Models,” Water Resources
Research, Vol.27, No.9, pp2467-2482, 1991.
Wu Z.Y., “Automatic Model Calibration by Simulating Evolution,” M.Sc. Thesis, H.H. 191, International Institute for
Infrastructure, Hydraulic and Environmental Engineering, Delft, Netherlands, 1994.
Wu, Z. Y., Boulos, P.F., Orr, C.H., and Ro, J.J., “An Efficient Genetic Algorithms Approach to an Intelligent Decision
Support System for Water Distribution Networks,” in Proceedings of the Hydroinformatics 2000 Conference, Iowa,
IW, July 26-29, 2000.
Wu, Z. Y., Boulos P. F., Orr C.-H. and Ro J. J., “Rehabilitation of water distribution system using genetic algorithm,”
Journal of AWWA, Vol. 93, No. 11, pp74-85, 2001.
Wu Z.Y. & Larsen C.L., “Verification of hydrological and hydrodynamic models calibrated by genetic algorithms,”
Proc. of the 2nd International Conference on Water Resources & Environmental Research, Vol. 2, Kyoto, Japan,
pp175-182, 1996.
Wu, Z. Y. and Simpson A. R., “An Efficient Genetic Algorithm Paradigm for Discrete Optimization of Pipeline
Networks,” International Congress on Modeling and Simulation, Hobart, Tasmania, Australia, 8-11 December, 1997b.
Wu, Z. Y. and Simpson A. R., “Competent Genetic Algorithm Optimization of Water Distribution Systems,” Journal of
Computing in Civil Engineering, ASCE, Vol 15, No. 2, pp89-101, 2001.
Wu, Z. Y. and Simpson A. R., “Messy Genetic Algorithm for Optimal Design of Water Distribution Systems,”
Research Report, No. 140, Department of Civil & Environmental Engineering, University of Adelaide, South
Australia., 1996
Wu, Z. Y and Simpson A. R., “Optimal Rehabilitation of Water Distribution Systems Using a Messy Genetic
Algorithm,” AWWA 17th Federal Convention Water in the Balance, Melbourne, Australia, 16-21 March 1997a.
Wu, Z. Y, Walski, T., Mankowski, R., Cook, J. Tryby, M. and Herrin G., “Optimal Capacity of Water Distribution
Systems,” in Proceeding of 1st Annual Environmental and Water Resources Systems Analysis (EWRSA) Symposium,
Roanoke, VA, May 19-22, 2002.
Zipparro, Vincent J. and Hasen Hans, Davis’ Handbook of Applied Hydraulics, McGraw-Hill Book Company, New
York, 1993.

960
WaterGEMS CONNECT Edition Help
Technical Reference

References

Babovic V., Wu Z. Y. & Larsen L. C., “Calibrating Hydrodynamic Models by Means of Simulated Evolution,” in
Proceeding of Hydroinformatics, Delft, Netherlands, pp193-200, 1994.
Benedict, R. P., Fundamentals of Pipe Flow, John Wiley and Sons, Inc., New York, 1980.
Brater, Ernest F. and Horace W. King, Handbook of Hydraulics, McGraw-Hill Book Company, New York, 1976.
Boulos, P. F. and D. J. Wood, “Explicit Calculation of Pipe-Network Parameters,” Journal of Hydraulic Engineering,
ASCE, 116(11) 1329-1344, 1987.
Cesario, A. Lee, Modeling, Analysis, and Design of Water Distribution Systems, AWWA, 1995.
Clark, R.M., “Chlorine demand and Trihalomethane formation kinetics: a second-order model,” Journal of
Environmental Engineering, Vol. 124, No. 1, pp. 16-24, 1998.
Clark, R. M., W. M. Grayman, R. M. Males, and A. F. Hess, “Modeling Contaminant propagation in Drinking Water
Distribution Systems,” Journal of Environmental Engineering, ASCE, New York, 1993.
Cohon, J.L., Multi-objective Programming and Planning. Academic Press, New York, 1978.
Computer Applications in Hydraulic Engineering, Fifth Edition, Waterbury, Connecticut, Haestad Press, 2002.
CulvertMaster User’s Guide, Waterbury, Connecticut, Haestad Methods, 2000.
Dunlop, E.J., WADI Users Manual, Local Government Computer Services Board, Dublin, Ireland, 1991.
Essential Hydraulics and Hydrology, Waterbury, Connecticut, Haestad Press, 1998.
FlowMaster PE Version 6.1 User’s Guide, Waterbury, Connecticut, Haestad Methods, 2000.
George, A. & Liu, J. W-H., Computer Solution of Large Sparse Positive Definite Systems, Prentice-Hall, Englewood
Cliffs, NJ, 1981.
Goldberg, D.E., Genetic Algorithms in Search, Optimization and Machine Learning. Addison Wesley, Reading, MA,
1989.
Goldberg, D. E., Korb, B., & Deb, K., “Messy genetic algorithms: Motivation, analysis, and first results,” Complex
Systems, 3, 493-530, 1989.
Goldberg, D. E., Deb, K., Kargupta, H., & Harik G., “Rapid, Accurate Optimization of Difficult Problems Using Fast
Messy Genetic Algorithms,” IlliGAL Report No. 93004, Illinois Genetic Algorithms Laboratory, University of Illinois
at Urbana-Champaign, Urbana, IL 61801, 1993.
Hamam, Y.M., & Brameller, A., “Hybrid method for the solution of piping networks,” Proc. IEE, Vol. 113, No. 11, pp.
1607-1612, 1971.
International Conference on Computer Applications for Water Supply and Distribution, Leicester Polytechnic, UK,
September 8-10.
Koechling, M.T., Assessment and Modeling of Chlorine Reactions with Natural Organic Matter: Impact of Source
Water Quality and Reaction Conditions, Ph.D. Thesis, Department of Civil and Environmental Engineering, University
of Cincinnati, Cincinnati, Ohio, 1998.
Lingireddy, S. and D.J. Wood, “Improved Operation of Water Distribution Systems Using Variable Speed Pumps,”
Journal of Energy Engineering, ASCE, 124(3) 90-103, 1998.

961
WaterGEMS CONNECT Edition Help
Technical Reference

Liou, C.P. and Kroon, J.R., “Modeling the propagation of waterborne substances in distribution networks,” J. AWWA,
79(11), 54-58, 1987.
Males R. M., W. M. Grayman and R. M. Clark, “Modeling Water Quality in Distribution System,” Journal of Water
Resources Planning and Management, ASCE, New York, 1988.
Notter, R.H. and Sleicher, C.A., “The eddy diffusivity in the turbulent boundary layer near a wall,” Chem. Eng. Sci.,
Vol. 26, pp. 161-171, 1971.
Osiadacz, A.J., Simulation and Analysis of Gas Networks, E. & F.N. Spon, London, 1987.
Practical Guide to Hydraulics and Hydrology, Waterbury, Connecticut, Haestad Press, 1997.
Roberson, John A., John J. Cassidy, and Hanif M. Chaudhry, Hydraulic Engineering, Houghton Mifflin Company,
Massachusetts, 1988.
Roberson, John A. and Clayton T. Crowe, Engineering Fluid Mechanics 4th Edition, Houghton Mifflin Company,
Massachusetts, 1990.
Rossman, Lewis A., EPANET User’s Manual (AWWA Workshop Edition), Risk Reduction Engineering Laboratory,
Office of Research and Development, USEPA, Ohio, 1993.
Rossman, Lewis A. et al., “Numerical Methods for Modeling Water Quality in Distribution Systems: A Comparison,”
Journal of Water Resources Planning and Management, ASCE, New York, 1996.
Rossman, Lewis A., R. M. Clark, and W. M. Grayman, “Modeling Chlorine Residuals in Drinking-water Distribution
Systems,” Journal of Environmental Engineering, ASCE, New York, 1994.
Rossman, L.A., Boulos, P.F., and Altman, T., “Discrete volume-element method for network water-quality models,”
Journal of Water Resource Planning and Management, Vol. 119, No. 5, 505-517, 1993.
Rossman, L.A., Clark, R.M., and Grayman, W.M., “Modeling chlorine residuals in drinking-water distribution
systems,” Journal of Environmental Engineering, Vol. 120, No. 4, 803-820, 1994.
Rossman, L.A. and Boulos, P.F., “Numerical methods for modeling water quality in distribution systems: A
comparison,” Journal of Water Resource Planning and Management, Vol. 122, No. 2, 137-146, 1996.
Rossman, L.A. and Grayman, W.M., “Scale-model studies of mixing in drinking water storage tanks,” Journal of
Environmental Engineering, Vol. 125, No. 8, pp. 755-761, 1999.
Salgado, R., Todini, E., & O’Connell, P.E., “Extending the gradient method to include pressure regulating valves in
pipe networks,” Proc. Inter. Symposium on Computer Modeling of Water Distribution Systems, University of
Kentucky, May 12-13, 1988.
Sanks, Robert L., Pumping Station Design, Butterworth-Heinemann, Inc., Stoneham, Massachusetts, 1989.
Streeter, Victor L. and Wylie, E. Benjamin, Fluid Mechanics, McGraw-Hill Book Company, New York, 1985.
Todini, E. and S. Pilati, “A Gradient Algorithm for the Analysis of Pipe Networks,” Computer Applications in Water
Supply, Volume 1 - Systems Analysis and Simulation, ed. Bryan Coulbeck and Chun-Hou Orr, Research Studies Press
Ltd., Letchworth, Hertfordshire, England.
Todini, E. & Pilati, S., “A gradient method for the analysis of pipe networks,” 1987.
Walski, T.M., “Model Calibration Data: The Good, The Bad and The Useless,” J. AWWA, 92(1), p. 94, 2000.
Walski, T. M., “Understanding the adjustments for water distribution system model calibration,” Journal of Indian
Water Works Association, April-June, 2001, pp151-157, 2001.
Walski, T.M., Chase, D.V. and Savic, D.A., Water Distribution Modeling, Haestad Press, Waterbury, CT, 2001.
Walski, Thomas M., Water System Modeling Using CYBERNET, Waterbury, Connecticut, Haestad Methods, 1993.

962
WaterGEMS CONNECT Edition Help
Technical Reference

Wang Q.J., “The Genetic Algorithm and its Application to Conceptual Rainfall-Runoff Models,” Water Resources
Research, Vol.27, No.9, pp2467-2482, 1991.
Wu Z.Y., “Automatic Model Calibration by Simulating Evolution,” M.Sc. Thesis, H.H. 191, International Institute for
Infrastructure, Hydraulic and Environmental Engineering, Delft, Netherlands, 1994.
Wu, Z. Y., Boulos, P.F., Orr, C.H., and Ro, J.J., “An Efficient Genetic Algorithms Approach to an Intelligent Decision
Support System for Water Distribution Networks,” in Proceedings of the Hydroinformatics 2000 Conference, Iowa,
IW, July 26-29, 2000.
Wu, Z. Y., Boulos P. F., Orr C.-H. and Ro J. J., “Rehabilitation of water distribution system using genetic algorithm,”
Journal of AWWA, Vol. 93, No. 11, pp74-85, 2001.
Wu Z.Y. & Larsen C.L., “Verification of hydrological and hydrodynamic models calibrated by genetic algorithms,”
Proc. of the 2nd International Conference on Water Resources & Environmental Research, Vol. 2, Kyoto, Japan,
pp175-182, 1996.
Wu, Z. Y. and Simpson A. R., “An Efficient Genetic Algorithm Paradigm for Discrete Optimization of Pipeline
Networks,” International Congress on Modeling and Simulation, Hobart, Tasmania, Australia, 8-11 December, 1997b.
Wu, Z. Y. and Simpson A. R., “Competent Genetic Algorithm Optimization of Water Distribution Systems,” Journal of
Computing in Civil Engineering, ASCE, Vol 15, No. 2, pp89-101, 2001.
Wu, Z. Y. and Simpson A. R., “Messy Genetic Algorithm for Optimal Design of Water Distribution Systems,”
Research Report, No. 140, Department of Civil & Environmental Engineering, University of Adelaide, South
Australia., 1996
Wu, Z. Y and Simpson A. R., “Optimal Rehabilitation of Water Distribution Systems Using a Messy Genetic
Algorithm,” AWWA 17th Federal Convention Water in the Balance, Melbourne, Australia, 16-21 March 1997a.
Wu, Z. Y, Walski, T., Mankowski, R., Cook, J. Tryby, M. and Herrin G., “Optimal Capacity of Water Distribution
Systems,” in Proceeding of 1st Annual Environmental and Water Resources Systems Analysis (EWRSA) Symposium,
Roanoke, VA, May 19-22, 2002.
Zipparro, Vincent J. and Hasen Hans, Davis’ Handbook of Applied Hydraulics, McGraw-Hill Book Company, New
York, 1993.

Engineer’s Reference

This section provides you with tables of commonly used roughness values and fitting loss coefficients.

Roughness Values-Manning's Equation

Commonly used roughness values for different materials are:
Manning's Coefficient (n) for Closed Metal Conduits Flowing Partly Full

Channel Type and Description Minimum Normal Maximum

a. Brass, smooth 0.009 0.010 0.013

b. Steel

1. Lockbar and welded 0.010 0.012 0.014

963
WaterGEMS CONNECT Edition Help
Technical Reference

Channel Type and Description Minimum Normal Maximum

2. Riveted and spiral 0.013 0.016 0.017

c. Cast iron

1. Coated 0.010 0.013 0.014

2. Uncoated 0.011 0.014 0.016

d. Wrought iron

1. Black 0.012 0.014 0.015

2. Galvanized 0.013 0.016 0.017

e. Corrugated metal

1. Subdrain 0.017 0.019 0.021

2. Storm drain 0.021 0.024 0.030

Roughness Values-Darcy-Weisbach Equation (Colebrook-White)

Commonly used roughness values for different materials are:
Darcy-Weisbach Roughness Heights e for Closed Conduits

Pipe Material e (mm) e (ft)

Glass, drawn brass, copper (new) 0.0015 0.000005

Seamless commercial steel (new) 0.004 0.000013

Commercial steel (enamel coated) 0.0048 0.000016

Commercial steel (new) 0.045 0.00015

Wrought iron (new) 0.045 0.00015

Asphalted cast iron (new) 0.12 0.0004

Galvanized iron 0.15 0.0005

Cast iron (new) 0.26 0.00085

Concrete (steel forms, smooth) 0.18 0.0006

Concrete (good joints, average) 0.36 0.0012

Concrete (rough, visible, form marks) 0.60 0.002

964
WaterGEMS CONNECT Edition Help
Technical Reference

Pipe Material e (mm) e (ft)

Riveted steel (new) 0.9 - 9.0 0.003 - 0.03

Corrugated metal 45 0.15

Roughness Values-Hazen-Williams Equation

Commonly used roughness values for different materials are:
Hazen-Williams Roughness Coefficients (C)

Pipe Material C

Asbestos Cement 140

Brass 130-140

Brick Sewer 100

Cast iron

New, unlined 130

10 yr. Old 107-113

20 yr. Old 89-100

30 yr. Old 75-90

40 yr. Old 64-83

Concrete or concrete lined

Steel forms 140

Wooden forms 120

Centrifugally spun 135

Copper 130-140

Galvanized iron 120

Glass 140

Lead 130-140

Plastic 140-150

Steel

965
WaterGEMS CONNECT Edition Help
Technical Reference

Pipe Material C

Coal-tar enamel, lined 145-150

New unlined 140-150

Riveted 110

Tin 130

Vitrified clay (good condition) 110-140 110-140

Wood stave (average condition) 120

Typical Roughness Values for Pressure Pipes

Typical pipe roughness values are shown below. These values may vary depending on the manufacturer, workmanship,
age, and many other factors.

Comparative Pipe Roughness Values

Material Manning's Coefficient n Hazen-Williams Darcy-Weisbach Roughness Height

C

k (mm) k (0.001 ft.)

Asbestos cement 0.011 140 0.0015 0.005

Brass 0.011 135 0.0015 0.005

Brick 0.015 100 0.6 2

Cast-iron, new 0.012 130 0.26 0.85

Concrete:

Steel forms 0.011 140 0.18 0.6

Wooden forms 0.015 120 0.6 2

Centrifugally spun 0.013 135 0.36 1.2

Copper 0.011 135 0.0015 0.005

Corrugated metal 0.022 - 45 150

Galvanized iron 0.016 120 0.15 0.5

Glass 0.011 140 0.0015 0.005

Lead 0.011 135 0.0015 0.005

966
WaterGEMS CONNECT Edition Help
Technical Reference

Plastic 0.009 150 0.0015 0.005

Steel

Coal-tar enamel 0.010 148 0.0048 0.016

New unlined 0.011 145 0.045 0.15

Riveted 0.019 110 0.9 3

Wood stave 0.012 120 0.18 0.6S

Fitting Loss Coefficients

For similar fittings, the K-value is highly dependent on things such as bend radius and contraction ratios.

Typical Fitting K Coefficients

Fitting K Value Fitting K Value

Pipe Entrance 90° Smooth Bend

Bellmouth 0.03-0.05 Bend Radius / D = 4 0.16-0.18

Rounded 0.12-0.25 Bend Radius / D = 2 0.19-0.25

Sharp-Edged 0.50 Bend Radius / D = 1 0.35-0.40

Projecting 0.80 Mitered Bend

Contraction-Sudden θ = 15° 0.05

D 2 /D 1 = 0.80 0.18 θ = 30° 0.10

D 2 /D 1 = 0.50 0.37 θ = 45° 0.20

D 2 /D 1 = 0.20 0.49 θ = 60° 0.35

Contraction-Conical θ = 90° 0.80

D 2 /D 1 = 0.80 0.05 Tee

D 2 /D 1 = 0.50 0.07 Line Flow 0.30-0.40

D 2 /D 1 = 0.20 0.08 Branch Flow 0.75-1.80

Expansion-Sudden Cross

D 2 /D 1 = 0.80 0.16 Line Flow 0.50

D 2 /D 1 = 0.50 0.57 Branch Flow 0.75

967
WaterGEMS CONNECT Edition Help
Technical Information Resources

D 2 /D 1 = 0.20 0.92 45° Wye

Expansion-Conical Line Flow 0.30

D 2 /D 1 = 0.80 0.03 Branch Flow 0.50

D 2 /D 1 = 0.50 0.08

D 2 /D 1 = 0.20 0.13

Technical Information Resources

To learn more about technical information resources, click the links below:

docs.bentley.com

docs.bentley.com is your repository of product help files and books. You can browse through online help for specific
information or download it to ensure you have the most recent help available on your computer. Also through this site,
many product books are available as free, downloadable PDFs, or can be purchased pre-bound with a credit card.

Bentley Services

There are a variety of Bentley Services, including Bentley SELECTR priority services, one-on-one consulting, training
programs, MicroStation resellers, as well as your local technical support provider.

U.S./Canada/Latin America [email protected]

Europe/Middle East/Africa [email protected]

Asia/Pacific [email protected]

Bentley SELECTR
Bentley SELECTR is the comprehensive delivery and support subscription program that features product updates and
upgrades via Web downloads and MySELECT CD, around-the-clock technical support, exclusive licensing options,
discounts on training and consulting services, as well as technical information and support channels. For more detailed
information go online at http://www.bentley.com and click the Support link.
Bentley Professional Services
Bentley Professional Services is a team of project managers, technical managers, application specialists, and developers
organized regionally and assigned by skill sets. By adding their extensive knowledge to your project, they provide
customized services on a one-to-one basis to help you maximize your investment in Bentley technology. For more
information visit http://www.bentley.com/Services/ and click the Bentley Professional Services link.
Bentley Institute

968
WaterGEMS CONNECT Edition Help
Technical Information Resources

The Bentley Institute manages professional training programs to ensure consistent, high quality, user training for a
variety of Bentley products and for varying levels of application experience.
Bentley Institute training is developed to maximize your productivity by using examples relevant to your day-to-day
project efforts. Training is developed concurrently with software applications to provide knowledge of the latest tools
and features. Additionally, all Bentley Institute faculty meet rigorous certification requirements.
To access the Bentley Institute home page directly from WaterGEMS CONNECT, choose Help > Bentley Institute
Training, or visit http://www.bentley.com/Training/.

Bentley Discussion Groups

Meet other users of Bentley products, exchange ideas, and discuss a wide range of technical subjects in Bentley's
discussion groups. They can be accessed via most common discussion group newsreaders or Web browsers and are a
good source of how-to tips, technical information, and programming techniques from Bentley employees and
professionals who use our products.
A current list of discussion groups as well as helpful information regarding them can be found at http://
discussion.bentley.com/help/.

Bentley on the Web

Visit Bentley on the web at http://www.bentley.com/. Here you will find links to products, services, industries, events
and training, community information, and the latest corporate news announcements pertaining to Bentley Systems,
Incorporated, your global provider of collaborative software solutions.

TechNotes/Frequently Asked Questions

TechNotes, FAQs and other technical support information are available online at WaterGEMS CONNECT Technical
Support page, in the SELECTservices area: http://selectservices.bentley.com.

BE Magazine

The BE Magazine is a quarterly e-magazine focused on the Bentley community of users. It serves as a showcase for
Bentley users and their work improving the world's infrastructure.
Each issue is an open forum for the world community of architecture, engineering, and construction professionals and
owner-operators. Visit http://www.be.org and click the BE Magazine link to subscribe or to view the magazine online.

BE Newsletter

The BE Newsletter is an email newsletter covering industry news, Bentley updates and events, technical tips, and more.
Visit http://www.be.org and click the BE Magazine link to subscribe or to view the newsletter online.

Client Server

969
WaterGEMS CONNECT Edition Help
Technical Information Resources

Client Server is an online newsletter for Bentley SELECT subscribers. This online resource is filled with the latest
technical news and information.
Archives of Client Server provide an abundant resource of technical information in the form of book excerpts, case
studies, commentary and analysis, and productivity tips. For more detailed information go online to http://
www.bentley.com and click the Support link.

BE Careers Network

The BE (Bentley Empowered) Careers Network is a program dedicated to supporting accredited academic institutions
by providing the latest releases of Bentley products, as well as world-renowned support, online communities, and the
latest engineering news and information. For details about the BE Careers Network go online at http://
www.becareers.org/.

Contact Bentley Systems

Contact Bentley Systems if you want product information, to upgrade your software, or need technical support.
Sales
Bentley Systems' professional staff is ready to answer your questions. Please contact your sales representative for any
questions regarding Bentley Systems' latest products and prices.
Toll-free U.S. Phone
800-727-6555
Worldwide Phone
+1-203-755-1666
Fax
+1-203-597-1488
Email
[email protected]
Technical Support
We hope that everything runs smoothly and you never have a need for our technical support staff. However, if you do
need support, our highly-skilled staff offers their services seven days a week and may be contacted by phone, fax,
email, and the Internet. For information on the various levels of support that we offer, contact our sales team today and
request information on our Bentley SELECT program, or visit our Web site.
When contacting us for support, in order to assist our technicians in troubleshooting your problem, please be in front of
your computer and have the following information available:
• Your computer's operating system.
• Name and build number of the Bentley Systems software you are calling about. The build number can be
determined by clicking Help > About WaterGEMS CONNECT . The build number is the number in brackets
located in the lower-left corner of the dialog box that opens.
• A note of exactly what you were doing when you encountered the problem.
• Any error messages or other information displayed on your screen.

970
WaterGEMS CONNECT Edition Help
Technical Information Resources

When emailing us for support, please provide the following details, in addition to the above, to enable us to provide a
more timely and accurate response:
• Company name, address, and phone number
• A detailed explanation of your concerns
• If you are emailing us, the WaterGEMS .log.csv file located in the product directory (C:\Users\<User Directory>
\AppData\Local\Bentley\<Product Name>\10).
Available 24 hours a day, seven days a week. You can contact our technical support team at: http://
selectservices.bentley.com
Addresses
Internet
http://selectservices.bentley.com
Email
[email protected]
Mail
Bentley Systems, Incorporated
Haestad Methods Solutions Center
Suite 200W
27 Siemon Company Drive
Watertown, CT 06795

Save to Package
Save to Package allows the user to compress the currently open model and related files to a single zip file so it can be
easily sent to our technical support team for assistance.

The Save to Package button is available on the File tab. The feature saves the core model files (project, drawing,
database and profile files) automatically. In addition, you can choose to include the following:
• application log file, this WaterGEMS .log.csv file is located typically in C:\Users\<user.name>\AppData\Local
\Bentley\ folder; it helps our technical support team diagnose problems with the model when errors occur;
• result files that get generated during calculations; these files tend to be large depending on the number of elements
in the model, use caution when including these files; in most situations, they don't need to be included;

971
WaterGEMS CONNECT Edition Help
Element Properties Reference

• backup files, they get generated when you save your work over the existing model; if the model becomes corrupt,
the backup files may contain an older, working copy of your model;
• background layer files, are the pictures behind your network, they may be large and are typically not necessary to
diagnose problems with the model and don't need to be included.
Once you make your selections and click the OK button in the Save to Package Options dialog you will be prompted to
choose the name and location of the zip file. By default, the name of the zip file will be the model name and it will be
located next to your model files. Click Save next and the files will get saved to the specified location. Once the
compression process is done you will be prompted with a dialog letting you know the full path to the zip file. You can
open a Windows Explorer window in the location where you saved the zip file by clicking Yes in the dialog. You can
also choose to skip the dialog and always open the Explorer Window at the end of the process by clicking the 'Do not
prompt again' check box.

Element Properties Reference

Edit Element Properties

• Double-click the element in the drawing pane,

• Choose the element to edit, then choose View > Properties,
• Or press <F4>.
Properties displayed in the Property Editor are grouped into categories. An expanded category can be collapsed by
clicking plus (+) next to the category heading. A collapsed category can be expanded by clicking minus (-) next to the
category heading.

Pipe Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Material: The pipe's material type.
• Diameter: Value represents the internal diameter of a circular pipe or four times the hydraulic radius for non-
circular cross-sections.
• Manning's n: Mannings N
• Hazen-Williams C: Hazen Williams C Factor
• Darcy-Weisbach e: Darcy-Weisbach roughness height for the pipe wall.
• Has User Defined Length?: Allows the calculated scaled pipe lengths to be overridden with a user defined value.
• Length (User Defined): A user defined pipe length that is not scaled from the underlying map dimensions.
• Has Check Valve?: Defines whether the pipe contains a check valve that limits flow to a single direction. Direction
of flow is with the direction of the pipe.
• Specify Local Minor Loss?: If true then the minor coefficient for the element is manually set, otherwise the value
is derived from the minor loss library.

972
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Minor Losses: List of all associated minor losses associated with the element, and can be used to generate the
composite minor loss coefficient.
• Status (Initial): Choices: Open, Closed
• Specify Local Bulk Reaction Rate?: If true than a local Bulk Reaction Rate can be specified for the pipe,
otherwise the bulk reaction rate associated with selected constituent will govern.
• Bulk Reaction Rate (Local): Coefficient defining how rapidly a constituent grows or decays over time.
• Specify Local Wall Rate?: If true then a local wall reaction rate can be specified for the selected pipe.
• Wall Reaction Rate (First Order): First order coefficient defining the rate at which a substance reacts with the
wall of a pipe. Is available if global constituent is set to first order.
• Wall Reaction Rate (Zero Order): Zero order coefficient defining the rate at which a substance reacts with the
wall of a pipe. Is available if the global constituent is set to zero order.
• Zone: Specify the zone for the element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Wave Speed: The speed with which a disturbance (i.e. pressure wave) moves through the fluid in the pipe.
• Flow (Initial): A value corresponding to flow in the pipe at the beginning of the transient simulation.
• Hydraulic Grade (Initial Start): The start node hydraulic grade elevation at the beginning of the transient
simulation.
• Hydraulic Grade (Initial Stop): The stop node hydraulic grade elevation at the beginning of the transient
simulation.
• Pressure (Start): Pressure at the start node of the pipe.
• Pressure (Stop): Pressure at the stop node of the pipe.
• Number of Breaks: The number of breaks that occurred on this pipe.
• Use Local Duration of Pipe Failure History?: Override the global duration of pipe failure history with a local
value.
• Duration of Pipe Failure History: The duration of pipe failure history for this pipe. By default uses the global
duration.
• Pipe Break Group: The pipe break group this pipe belongs to.
• Cost of Break: The cost of the break for this pipe.
• Flow: Total flow through the pipe. If the value is negative the flow is traveling from the stop node to the start node,
and vice versa if positivie.
• Velocity: Velocity of fluid through the pipe.
• Headloss Gradient: The headloss per unit length in the pipe.
• Headloss: Total headloss occuring in the pipe, including both friction and minor headlosses and any minor losses
from isolation valves.
• Pressure Loss Gradient: The pressure loss per unit length in the pipe.
• Pressure Loss: Total pressure loss occuring in the pipe, including both friction and minor pressure losses and any
minor losses from isolation valves.
• Flow (Absolute): Absolute value of flow through the pipe.
• Hydraulic Grade (Start): Hydraulic grade at start node of pipe.
• Hydraulic Grade (Stop): Hydraulic grade at stop node of pipe.
• Length: Displays either the scaled length or the user defined length depending on which option is set for the pipe.
• Travel Time: The length of the pipe divided by the velocity of flow through pipe.
• Headloss (Minor): Headloss resulting from minor losses in the pipe only. (Excludes isolation valve minor losses).
• Headloss (Friction): Headloss through pipe resulting from friction. (Includes any isolation valve minor losses).
• Area Full: Cross-sectional area of pipe.
• Shear Stress: Shear stress at current time step.
• Length (3D): Length derived from x, y and z coordinates of bounding node.

973
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Status (Calculated): Choices: Open, Closed

• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Concentration (Start): Concentration at start end of the pipe.
• Concentration (Stop): Concentration at the stop end of the pipe.
• Trace (Start): Trace percentage at start end of the pipe.
• Trace (Stop): Trace percentage at stop end of the pipe.
• Age (Start): Water age at the start end of the pipe.
• Age (Stop): Water age at the stop end of the pipe.
• Flow (Minimum Absolute): Minimum flow magnitude through pipe over the course of the simulation.
• Flow (Maximum Absolute): Maximum flow magnitude through the pipe over the course of the simulation.
• Velocity (Maximum): Maximum velocity of flow that occurs in pipe over the course of the simulation.
• Velocity (Minimum): Minimum velocity of flow that occurs in pipe over the course of the simulation.
• Headloss Gradient (Minimum): Minimum headloss gradient that occurs at the selected pipe.
• Headloss Gradient (Maximum): Maximum headloss gradient that occurs at the selected pipe.
• Flow (Minimum): Minimum flow through pipe over the course of the simulation.
• Flow (Maximum): Maximum flow through the pipe over the course of the simulation.
• Age (Minimum): Minimum age in the pipe over the course of the simulation.
• Age (Maximum): Maximum age in the pipe over the course of the simulation.
• Trace (Minimum): Minimum trace in the pipe over the course of the simulation.
• Trace (Maximum): Maximum trace in the pipe over the course of the simulation.
• Concentration (Minimum): Minimum concentration in the pipe over the course of the simulation.
• Concentration (Maximum): Maximum concentration in the pipe over the course of the simulation.
• Age (Start) (Minimum): Minimum age at the start end of the pipe over the course of the simulation.
• Age (Start) (Maximum): Maximum age at the start end of the pipe over the course of the simulation.
• Age (Stop) (Minimum): Minimum age at the stop end of the pipe over the course of the simulation.
• Age (Stop) (Maximum): Maximum age at the stop end of the pipe over the course of the simulation.
• Trace (Start) (Minimum): Minimum trace at the start end of the pipe over the course of the simulation.
• Trace (Start) (Maximum): Maximum trace at the start end of the pipe over the course of the simulation.
• Trace (Stop) (Minimum): Minimum trace at the stop end of the pipe over the course of the simulation.
• Trace (Stop) (Maximum): Maximum trace at the stop end of the pipe over the course of the simulation.
• Concentration (Start) (Minimum): Minimum concentration at the start end of the pipe over the course of the
simulation.
• Concentration (Start) (Maximum): Maximum concentration at the start end of the pipe over the course of the
simulation.
• Concentration (Stop) (Minimum): Minimum concentration at the stop end of the pipe over the course of the
simulation.
• Concentration (Stop) (Maximum): Maximum concentration at the stop end of the pipe over the course of the
simulation.
• Alert Level (Now): Maximum alert severity of the current element for the current time step.
• Alert Level (Ever): Maximum alert severity of the current element.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.

974
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Has Flow Reversal? (Now): True if the flow direction reversed compared to the previous time step.
• Has Flow Reversal? (Ever): True if the flow direction reversed during the calculation time.
• Controlled?: Is true if a control action in the current control set references the selected element.
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Head (Maximum, Transient): Maximum head at any point along the pipe over the course of the transient
simulation.
• Head (Minimum, Transient): Minimum head at any point along the pipe over the course of the transient
simulation.
• Pressure (Maximum, Transient): Maximum pressure at any point along the pipe over the course of the transient
simulation.
• Pressure (Minimum, Transient): Minimum pressure at any point along the pipe over the course of the transient
simulation.
• Flow (Maximum, Transient): Maximum flow at any point along the pipe over the course of the transient
simulation.
• Flow (Minimum, Transient): Minimum flow at any point along the pipe over the course of the transient
simulation.
• Velocity (Minimum, Transient): Minimum velocity at any point along the pipe over the course of the transient
simulation.
• Velocity (Maximum, Transient): Maximum velocity at any point along the pipe over the course of the transient
simulation.
• Wave Speed Adjustment Percent: The wave speed adjustment applied to this pipe (relative to the original wave
speed) so that a sharp pressure-wave front can travel the length of one of the pipe's interior segments in one time
step.
• Wave Speed Adjustment: The wave speed adjustment applied to this pipe so that a sharp pressure-wave front can
travel the length of one of the pipe's interior segments in one time step.
• Length Adjustment Percent: The length adjustment applied to this pipe (relative to the original length) so that a
sharp pressure-wave front can travel the length of one of the pipe's interior segments in one time step.
• Length Adjustment: The length adjustment applied to this pipe so that a sharp pressure-wave front can travel the
length of one of the pipe's interior segments in one time step.
• Velocity (Initial, Transient): The flow velocity along the pipe at the beginning of the transient simulation.
• Pressure (Maximum at Stop Node, Transient): Maximum pressure at the pipe's stop node over the course of the
transient simulation.
• Pressure (Maximum at Start Node, Transient): Maximum pressure at the pipe's start node over the course of the
transient simulation.
• Pressure (Minimum at Stop Node, Transient): Minimum pressure at the pipe's stop node over the course of the
transient simulation.
• Pressure (Minimum at Start Node, Transient): Minimum pressure at the pipe's start node over the course of the
transient simulation.
• Head (Maximum at Stop Node, Transient): Maximum head at the pipe's stop node over the course of the transient
simulation.
• Head (Maximum at Start Node, Transient): Maximum head at the pipe's start node over the course of the
transient simulation.
• Head (Minimum at Start Node, Transient): Minimum head at the pipe's start node over the course of the transient
simulation.
• Head (Minimum at Stop Node, Transient): Minimum head at the pipe's stop node over the course of the transient
simulation.

975
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Upsurge Ratio at Start Node: Ratio of maximum pressure at the pipe's start node over the course of the transient
simulation to the pressure at the beginning of the transient simulation.
• Upsurge Ratio at Stop Node: Ratio of maximum pressure at the pipe's stop node over the course of the transient
simulation to the pressure at the beginning of the transient simulation.
• Head (Initial at Start Node, Transient): The head at the pipe's start node at the beginning of the transient
simulation.
• Head (Initial at Stop Node, Transient): The head at the pipe's stop node at the beginning of the transient
simulation.
• Air Volume (Maximum, Transient): Maximum air volume along the pipe over the course of the transient
simulation.
• Vapor Volume (Maximum, Transient): Maximum vapor volume along the pipe over the course of the transient
simulation.
• Velocity (Maximum Flushing): The maximum achieved pipe velocity across all flushing events. If comparing
against previous results (for other alternatives/scenarios) this result is the maximum achieved velocity across all
flushing events for which results exist.
• Shear Stress (Maxmum Flushing): The maximum achieved shear stress across all flushing events. If comparing
against previous results (for other alternatives/scenarios) this result is the maximum achieved shear stress across all
flushing events for which results exist.
• Flushing Event: The flushing event that resulted in the pipe maximum achieved velocity. If comparing against
previous results, this flushing event may be defined in another alternative/scenario.
• Satisfies Flushing Target Velocity?: True if the maximum achieved velocity for the pipe is greater than or equal to
the target velocity.
• Satisfies Flushing Target Shear Stress?: True if the maximum achieved shear stress for the pipe is greater than or
equal to the target shear stress.
• Break Rate: The break rate for the pipe over time.
• Break Rate (Pipe Group): The break rate for the group the pipe belongs to.
• Projected Breaks: The projected number of breaks for this pipe.
• Annual Expected Cost: The annual expected cost of the breaks for this pipe.
• Present Worth: How much the pipe is currently worth based on the projection cost.
• Break Rate (Scaled): A weighted combination of the individual pipe break rate and the pipe break rate of the group
to which the pipe belongs.

Junction Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Specify Local Fire Flow Constraints?: If set to true then local fire flow constraints which override the global
values can be set for the current junction.
• Fire Flow (Needed): The flow rate required at the junction to meet fire flow demands. This value will be added to
or replace the junctions baseline demand, depending on the default setting for applying fire flows as specified in the
Fire Flow Alternative dialog box.
• Fire Flow (Upper Limit): This input defines the maximum allowable fire flow that a junction can provide and the
maximum allowable fire flow that can occur at any single withdrawal location.

976
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Pressure (Residual Lower Limit): Minimum residual pressure to occur at the junction node. The program
determines the amount of fire flow available such that the residual pressure at the junction node does not fall below
this target pressure.
• Pressure (Zone Lower Limit): Minimum pressure to occur at all junction nodes within the Zone you are testing.
The model determines the available fire flow such that the minimum zone pressures do not fall below this target
pressure.
• Pressure (System Lower Limit): Minimum pressure allowed at any junction in the entire system as a result of the
fire flow withdrawal. If a node's pressure anywhere in the system falls below this constraint while withdrawing
fire flow, fire flow will not be satisfied.
• Use Velocity Constraint: If set to true, then a velocity constraint can be specified for the node.
• Velocity (Upper Limit): Maximum velocity allowed in the associated pipe set.
• Use Minimum System Pressure Constraints?: If set to true then the fire flow analysis by pressure throughout the
entire system.
• Emitter Coefficient: Discharge coefficient for an emitter (sprinkler or nozzle) placed at junction. Units are flow
units at 1 unit of pressure drop (psi or m). Leave blank or set to 0 if no emitter is present.
• Percent of Demand that is Pressure Dependent: The percent of demand that is pressure dependent for the current
junction. Overrides the global value that is set in the pressure dependent demand alternative
• Pressure (Reference): Overrides the reference pressure defined in the pressure dependent demand alternative for
the current junction.
• Local Function: Defines the relationship between the pressure and the demand for the current junction. This
function will be used instead of the global function defined in the pressure dependent demand alternative.
• Use Local Pressure Dependent Demand Data?: If set to true, then pressure dependent demand parameters that
override the global default values can be set for the current junction.
• Vapor Volume (Initial): Volume of vapour at the node at the start of the transient simulation. If volume is nonzero,
then liquid is at the vapour pressure. Only applicable at dead ends.
• Pressure Drop (Typical): Pressure drop across the orifice corresponding to the initial/typical flow.
• Flow (Typical): If the initial flow is zero, then this is a typical (positive) flow.
• Demand Collection: A collection of baseline demands and associated temporal patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts, and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Demand Shortage: Difference between the target demand and the demand the system can supply during the current
time step.

977
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Demand (Cumulative): Total required demand volume at current node up to the current time step.
• Supply (Cumulative): Total volume of flow that the system can actually supply up to the current time step.
• Shortfall (Cumulative): The cumulative difference in volume between the target demand and the flow supplied up
to the current time step.
• Supply Rate (Cumulative): The cumulative ratio of supply/demand up to the current time step.
• Demand (Target): The demand required at the node. Calculated from the nodes input data.
• Satisfies Fire Flow Constraints?: Set to true if hydraulic calculations met accuracy constraints within the allotted
number of trials.
• Fire Flow (Available): Amount of flow available for fire protection while maintaining all fire flow pressure
constraints.
• Pressure (Calculated Residual): Calculated pressure at the junction node during the fire flow withdrawal.
• Pressure (Calculated Zone Lower Limit): Minimum calculated pressure of all junctions in the same zone as this
junction.
• Junction w/ Minimum Pressure (Zone): Label of the junction corresponding to the minimum zone pressure.
• Pressure (Calculated System Lower Limit): Minimum calculated pressure of all junctions in the system.
• Junction w/ Minimum Pressure (System): Junction corresponding to the minimum system pressure.
• Is Fire Flow Run Balanced?: If set to true then the fire flow analysis was able to solve.
• Fire Flow Iterations: Number of iterations required to hone in on the fire flow result.
• Flow (Total Needed): If fire flow is added to baseline demand this equals the sum of the calculated demand and the
needed fire flow, otherwise is equivalent to the needed fire flow.
• Flow (Total Available): If fire flow is added to the baseline demand this equals the sum of the calculated demand
and the available fire flow at the node, otherwise it is equivalent to the available fire flow.
• Fire Flow (Total Upper Limit): If fire flow is added to base line, this equals the sum of the demand at the junction
plus the fire flow upper limit, otherwise it is equivalent to the fire flow upper limit.
• Junction w/ Minimum Pressure (Zone @ Total Flow Needed): If baseline flow is added to demand, this
represents the junction with the minimum pressure in the zone as a result of the total needed demand and fire flow.
• Pressure (Calculated Residual @ Total Flow Needed): Lower limit for system pressure at node.
• Pressure (Calculated Zone Lower Limit @ Total Flow Needed): Lower limit for pressure in zone at node
• Pipe w/ Maximum Velocity: Label of pipe with max velocity
• Velocity of Maximum Pipe: Velocity in pipe with highest velocity.
• Demand (Minimum): Minimum demand at node over the course of the simulation.
• Demand (Maximum): Maximum demand at node over the course of the simulation.
• Hydraulic Grade (Maximum): Maximum calculated hydraulic grade at node over the course of the simulation.
• Hydraulic Grade (Minimum): Minimum calculated hydraulic grade at node over the course of simulation.
• Pressure (Minimum): Minimum pressure at node over the course of the simulation.
• Pressure (Maximum): Maximum pressure at node over the course of the simulation.
• Age (Minimum): Minimum age at node over the course of the simulation.
• Age (Maximum): Maximum age at node over the course of the simulation.
• Trace (Minimum): Minimum trace at node over the course of the simulation.
• Trace (Maximum): Maximum trace at node over the course of the simulation.
• Concentration (Minimum): Minimum concentration at node over the course of the simulation.
• Concentration (Maximum): Minimum concentration at node over the course of the simulation.
• Demand: Total calculated demand at selected element.
• Demand Adjusted Population: Population of area supplied by current node. This value is derived from the unit
demand loads applied to the collection and their equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.

978
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Trace (Calculated): Trace at selected element for current time step.

• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Hydrant Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Include Hydrant Lateral Loss?: Specifies whether the lateral loss of the hydrant should be accounted for or not. If
so, you can specify the properties of the hydrant lateral.
• Diameter (Hydrant Lateral): The diameter of the hydrant lateral.
• Minor Loss Coefficient (Hydrant Lateral): The minor loss coefficient of the hydrant lateral.
• Length (Hydrant Lateral): The length of the hydrant lateral.
• Hydrant Status: Choices: Open, Closed
• Specify Local Fire Flow Constraints?: If set to true then local fire flow constraints which override the global
values can be set for the current junction.
• Fire Flow (Needed): The flow rate required at the junction to meet fire flow demands. This value will be added to
or replace the junctions baseline demand, depending on the default setting for applying fire flows as specified in the
Fire Flow Alternative dialog box.
• Fire Flow (Upper Limit): This input defines the maximum allowable fire flow that a junction can provide and the
maximum allowable fire flow that can occur at any single withdrawal location.
• Pressure (Residual Lower Limit): Minimum residual pressure to occur at the junction node. The program
determines the amount of fire flow available such that the residual pressure at the junction node does not fall below
this target pressure.
• Pressure (Zone Lower Limit): Minimum pressure to occur at all junction nodes within the Zone you are testing.
The model determines the available fire flow such that the minimum zone pressures do not fall below this target
pressure.
• Pressure (System Lower Limit): Minimum pressure allowed at any junction in the entire system as a result of the
fire flow withdrawal. If a node's pressure anywhere in the system falls below this constraint while withdrawing fire
flow, fire flow will not be satisfied.
• Use Velocity Constraint: If set to true, then a velocity constraint can be specified for the node.
• Velocity (Upper Limit): Maximum velocity allowed in the associated pipe set.
• Use Minimum System Pressure Constraints?: If set to true then the fire flow analysis by pressure throughout the
entire system.

979
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Emitter Coefficient: Discharge coefficient for an emitter (sprinkler or nozzle) placed at junction. Units are flow
units at 1 unit of pressure drop (psi or m). Leave blank or set to 0 if no emitter is present.
• Percent of Demand that is Pressure Dependent: The percent of demand that is pressure dependent for the current
junction. Overrides the global value that is set in the pressure dependent demand alternative
• Pressure (Reference): Overrides the reference pressure defined in the pressure dependent demand alternative for
the current junction.
• Local Function: Defines the relationship between the pressure and the demand for the current junction. This
function will be used instead of the global function defined in the pressure dependent demand alternative.
• Use Local Pressure Dependent Demand Data?: If set to true, then pressure dependent demand parameters that
override the global default values can be set for the current junction.
• Vapor Volume (Initial): Volume of vapour at the node at the start of the transient simulation. If volume is nonzero,
then liquid is at the vapour pressure. Only applicable at dead ends.
• Pressure Drop (Typical): Pressure drop across the orifice corresponding to the initial/typical flow.
• Flow (Typical): If the initial flow is zero, then this is a typical (positive) flow.
• Demand Collection: A collection of baseline demands and associated temporal patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts, and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Demand Shortage: Difference between the target demand and the demand the system can supply during the current
time step.
• Demand (Cumulative): Total required demand volume at current node up to the current time step.
• Supply (Cumulative): Total volume of flow that the system can actually supply up to the current time step.
• Shortfall (Cumulative): The cumulative difference in volume between the target demand and the flow supplied up
to the current time step.
• Supply Rate (Cumulative): The cumulative ratio of supply/demand up to the current time step.
• Demand (Target): The demand required at the node. Calculated from the nodes input data.
• Satisfies Fire Flow Constraints?: Set to true if hydraulic calculations met accuracy constraints within the allotted
number of trials.
• Fire Flow (Available): Amount of flow available for fire protection while maintaining all fire flow pressure
constraints.
• Pressure (Calculated Residual): Calculated pressure at the junction node during the fire flow withdrawal.

980
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Pressure (Calculated Zone Lower Limit): Minimum calculated pressure of all junctions in the same zone as this
junction.
• Junction w/ Minimum Pressure (Zone): Label of the junction corresponding to the minimum zone pressure.
• Pressure (Calculated System Lower Limit): Minimum calculated pressure of all junctions in the system.
• Junction w/ Minimum Pressure (System): Junction corresponding to the minimum system pressure.
• Is Fire Flow Run Balanced?: If set to true then the fire flow analysis was able to solve.
• Fire Flow Iterations: Number of iterations required to hone in on the fire flow result.
• Flow (Total Needed): If fire flow is added to baseline demand this equals the sum of the calculated demand and the
needed fire flow, otherwise is equivalent to the needed fire flow.
• Flow (Total Available): If fire flow is added to the baseline demand this equals the sum of the calculated demand
and the available fire flow at the node, otherwise it is equivalent to the available fire flow.
• Fire Flow (Total Upper Limit): If fire flow is added to base line, this equals the sum of the demand at the junction
plus the fire flow upper limit, otherwise it is equivalent to the fire flow upper limit.
• Junction w/ Minimum Pressure (Zone @ Total Flow Needed): If baseline flow is added to demand, this
represents the junction with the minimum pressure in the zone as a result of the total needed demand and fire flow.
• Pressure (Calculated Residual @ Total Flow Needed): Lower limit for system pressure at node.
• Pressure (Calculated Zone Lower Limit @ Total Flow Needed): Lower limit for pressure in zone at node
• Pipe w/ Maximum Velocity: Label of pipe with max velocity
• Velocity of Maximum Pipe: Velocity in pipe with highest velocity.
• Demand (Minimum): Minimum demand at node over the course of the simulation.
• Demand (Maximum): Maximum demand at node over the course of the simulation.
• Hydraulic Grade (Maximum): Maximum calculated hydraulic grade at node over the course of the simulation.
• Hydraulic Grade (Minimum): Minimum calculated hydraulic grade at node over the course of simulation.
• Pressure (Minimum): Minimum pressure at node over the course of the simulation.
• Pressure (Maximum): Maximum pressure at node over the course of the simulation.
• Age (Minimum): Minimum age at node over the course of the simulation.
• Age (Maximum): Maximum age at node over the course of the simulation.
• Trace (Minimum): Minimum trace at node over the course of the simulation.
• Trace (Maximum): Maximum trace at node over the course of the simulation.
• Concentration (Minimum): Minimum concentration at node over the course of the simulation.
• Concentration (Maximum): Minimum concentration at node over the course of the simulation.
• Demand: Total calculated demand at selected element.
• Demand Adjusted Population: Population of area supplied by current node. This value is derived from the unit
demand loads applied to the collection and their equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.

981
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Tank Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Include in Energy Calculation?: If set to true, cost generated by the element will be included in the calculations,
otherwise they will be excluded.
• Has Separate Inlet?: Specifies whether this tank has a separate inlet pipe (only significant when modeling top fill
tanks or throttling inlets).
• Inlet Pipe: Specifies which pipe will be used to model a top fill inlet, throttling inlet, or both.
• Tank Fills From Top?: Set this to true if you wish to model a top fill inlet.
• Level (Inlet Invert): Specify the invert level for the inlet. If the upstream HGL is lower than this level the tank will
not fill.
• Inlet Valve Throttles?: Set this to true if there is a throttling valve (such as a float valve) on the inlet.
• Discharge Coefficient (Fully Open): Specifies the discharge or flow coefficient of the inlet valve in its fully open
position.
• Level Inlet Valve Fully Closes: Specifies the level at which the throttling valve becomes fully closed allowing no
more flow to pass into the tank.
• Valve Characteristics: Specifies the valve characteristics definition to be used for this valve. If the Valve
Characteristic Curve is not defined then a default curve will be used. The default curve will have (Relative Closure,
Relative Area) points of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Elevation (Base): Elevation of the storage tank base used as a reference when entering water surface elevations in
the tank in terms of levels.
• Elevation (Maximum): Highest allowable water surface elevation or level. If the tank fills above this point, it will
be automatically shut off from the system.
• Level (Maximum): A reference level to compare the hydraulic grade in the tank. Does not influence the
calculations.
• Diameter: Diameter of tank with constant circular cross-section.
• Area (Average): Cross-Sectional area of tank for constant x-section tanks.
• Volume Full (Input): The full active volume of the variable area tank (i.e., the volume at 100% depth), exclusive of
any inactive volume.
• Operating Range Type: Choices: Elevation, Level
• Section: Choices: Circular, Non-Circular, Variable Area
• Cross-Section Curve: Defines a curve which specifies the relationship between depth and volume.
• Specify Local Bulk Rate?: If true than a local Bulk Reaction Rate can be specified for the tank, otherwise the bulk
reaction rate associated with selected constituent will govern.
• Bulk Reaction Rate (Local): Coefficient defining how rapidly a constituent grows or decays over time.
• Tank Mixing Model: Choices: 2-Compartment, Completely Mixed, FIFO, LIFO
• Compartment 1: Percent of available storage that makes up the first compartment. Inflow and outflow is assumed
to take place in the first compartment.

982
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Compartment 2: Percent of available storage that makes up the second compartment. The second compartment
receives overflow from the first, and this overflow is completely mixed.
• Elevation (Minimum): Lowest allowable water surface elevation or level. If the tank drains below this point, it will
be automatically shut off from the system.
• Volume (Inactive): The inactive volume of the tank. This volume is the inaccessible volume of the tank that is
below the tank active operating range and can become important in water quality simulations subject to the selected
mixing model.
• Level (Minimum): Lowest allowable water surface elevation or level. If the tank drains below this point, it will be
automatically shut off from the system.
• Elevation (High Alarm): The elevation above which the high level alarm is generated. Calculation notifications are
produced to advise you of any alarm level violations.
• Level (High Alarm): The level above which the high level alarm is generated. Calculation notifications are
produced to advise you of any alarm level violations.
• Elevation (Low Alarm): The elevation below which the low level alarm is generated. Calculation notifications are
produced to advise you of any alarm level violations.
• Level (Low Alarm): The level below which the low level alarm is generated. Calculation notifications are produced
to advise you of any alarm level violations.
• Use High Alarm?: Specifies whether or not to check high alarm levels during Steady State/EPS calculation and
generate messages if the levels are violated.
• Use Low Alarm?: Specifies whether or not to check low alarm levels during Steady State/EPS calculation and
generate messages if the levels are violated.
• Elevation (Initial): Starting water surface elevation/level in the tank.
• Level (Initial): Starting water surface elevation/level in the tank.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Elevation (Initial, Transient): Enter a value only if a check valve is installed (i.e., case of a one-way surge tank),
or there is an initial inflow/outflow head loss. By default, the intial water surface level is taken equal to the head in
the adjacent pipe.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this
printout is suppressed.
• Demand Collection: A collection of baseline demands and associated temporal patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts, and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.

983
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Relative Closure (Calculated, Inlet Valve): The initial relative closure used at the start of a steady state or EPS
run. (A relative closure of 0% means the valve is 0% closed, or 100% open. Conversely, a relative closure of 100%
means the valve is 100% closed or 0 % open).
• Discharge Coefficient Setting (Calculated, Inlet Valve): The discharge coefficient of the throttling inlet valve at
the current time step. (Only applies if the inlet throttles).
• Headloss (Inlet Valve): The headloss across the separate inlet valve at the current time step.
• Hydraulic Grade (Inlet Valve, From): Calculated hydraulic grade at the entrance of the separate inlet valve.
• Hydraulic Grade (Inlet Valve, To): Calculated hydraulic grade at the exit of the separate inlet valve.
• Status (Calculated, Inlet Valve): Choices: Active, Inactive, Closed
• Volume Full (Calculated): The full active volume of the tank between the limits of the defined operating range,
exclusive of any inactive volume.
• Level (Calculated): Difference between calcuted hydraulic grade and the base elevation of the tank.
• Volume (Calculated): Total volume of fluid in tank including the inactive volume.
• Percent Full: The ratio of tank active volume to the calculated tank full active volume. Active volume is the tank
volume within the operating range and is exclusive of inactive volume.
• Status (Calculated): Choices: Empty, Emptying, Filling, Full, Stagnant
• Flow (Out net): Net flow out of the element.
• Flow (In net): Net flow into the element.
• Demand Adjusted Population: Population of area supplied by current node. This value is derived from the unit
demand loads applied to the collection and their equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.

Reservoir Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Hydraulic Grade Pattern: Allows you to apply a pattern for changes to the reservoirs hydraulic grade line over
time for extended period simulations.
• Elevation (Inlet/Outlet Invert): Elevation of the reservoir inlet/outlet invert.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.

984
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Zone: Specify the zone for the element.

• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Flow (Out net): Net flow out of the element.
• Flow (In net): Net flow into the element.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Periodic Head-Flow Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Sinusoidal: If sinusoidal, then mean value, amplitude and phase are entered; otherwise, a table of values is required.
A sinusoidal quantity X has the form: X = X0 + A sin( 2 * PI * t / T + Phase ).
• Mean Value (Head): The mean head value. Required only if sinusoidal data specified.
• Amplitude (Head): The amplitude of the sinusoidal head curve. Required only if sinusoidal data specified.
• Phase: Phase of the sinusoidal flow or head curve. Default option is 0 such that periodic component of head or flow
is zero at time zero.
• Period: Oscillation period of the sinusoidal flow or head curve (must be positive), or the period after which a
tabular flow or head pattern repeats.
• Mean Value (Flow): The mean flow value. Required only if sinusoidal data specified.
• Amplitude (Flow): The amplitude of the sinusoidal flow curve. Required only if sinusoidal data specified.

985
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Transient Parameter: Choices: Head, Flow

• Flow Pattern: A collection of time/flow pairs representing the transient flow pattern.
• Head Pattern: A collection of time/head pairs representing the transient flow pattern.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Discharge (Calculated): Calculated discharge from the node.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Pump Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Pump Definition: Select the pump definition to apply to the selected pump.
• Is Variable Speed Pump?: If set to true then the pump will act as a Variable Speed Pump.

986
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Relative Speed Factor (Maximum): The highest relative speed factor that the pump can be set at to meet the target
head at the control node. If the target head cannot be met when the pump is set at the maximum relative speed
factor, the maximum will be used.
• VSP Type: Choices: Pattern Based, Fixed Head, Fixed Flow
• Flow (Target): The relative speed of a VSP of type "Fixed Flow" will be adjusted to meet the Flow (Target).
• Pattern (Relative Speeds): Select the pattern by which the relative speed factor is adjusted over the course of the
simulation. (Note that patterns override settings changes made by controls).
• Control Node: The node that the VSP checks to determine whether to increase, maintain, or decrease its relative
speed factor.
• Hydraulic Grade (Target): The Head that the VSP will attempt to maintain for the Control Node.
• Control Node on Suction Side?: Specifies if the VSP has a suction side control node.
• Relative Speed Factor (Initial): Determines the initial speed of the pump impeller relative to the speed at which
the pump curve is defined.
• Status (Initial): Choices: On, Off
• Include in Energy Calculation?: If set to true, cost generated by the element will be included in the calculations,
otherwise they will be excluded.
• Energy Pricing: Specify which energy pricing definition is to be used when calculating costs of the corresponding
pump.
• Diameter (Pump Valve): Diameter refers to the valve at full opening, typically equal to the internal diameter of the
discharge flange.
• Flow (Nominal): Rated or duty flow for the pump, often at or near the best efficiency point.
• Head (Nominal): Rated or duty head for the pump, often at or near the best efficiency point.
• Relative Speed (Initial, Transient): The initial pump relative speed to be used in the transient analysis.
• Torque (Nominal): Specifies the nominal torque that, when multiplied by the Operating Rule's pattern multiplier
values will result in the torque values used by the engine.
• Pump Type (Transient): Choices: Shut Down After Time Delay, Constant Speed - No Pump Curve, Constant
Speed - Pump Curve, Variable Speed/Torque, Pump Start - Variable Speed/Torque
• Time (Delay until Shut Down): Time at which power to pump motor is shut off. By default, there is no time delay.
• Time (For Valve to Close): The time taken for the pump discharge control valve to close after the transient
simulation begins.
• Time (For Valve to Operate): Time to close check valve (or to open it if initial flow is zero). If the check valve
allows flow only in one direction, enter 0.
• Control Variable: Choices: Speed, Torque
• Status (Initial, Transient): Choices: On, Off
• Pump Valve Type: Choices: Check Valve, Control Valve
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this
printout is suppressed.
• Pump Station: The Pump Station to which this Pump belongs.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Relative Speed Factor (Calculated): Current relative speed factor of pump at current time step.

987
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Hydraulic Grade (Suction): Calculated hydraulic grade at suction side of the pump.
• Hydraulic Grade (Discharge): Calculated hydraulic grade at discharge side of the pump.
• Flow (Total): Total flow pumped by standard pump or the pump battery.
• Pump Head: Head gain between suction and discharge side of the pump.
• Pressure (Suction): Calculated pressure at suction side of the pump.
• Pressure (Discharge): Calculated pressure at discharge side of the pump.
• Flow (Absolute): The magnitude of flow through the pump regardless of flow direction.
• Pump Exceeds Operating Range?: Is true if the system demands on the pump exceeds its capabilities.
• Status (Calculated): Choices: On, Off, Pump Cannot Deliver Head (Closed), Pump Result Cannot Deliver
Flow (Open)
• Peak Power: Displays the peak energy usage, as calculated during the extended period simulation. This result is
displayed even if Peak Demand Charges are not applied.
• Time of Peak Energy Cost: Time when energy cost is maximum.
• Demand Charge: The charge applied per kW.
• Demand Charge Period: Time over which demand charge is averaged in order to get $/day.
• Peak Power Cost: Displays the energy cost as calculated during the extended period simulation. If no Peak
Demand Charge has been applied to the associated Energy Price Definition, this field will display as zero.
• Peak Power Cost (Daily): The cost associated with the Peak Demand Charge.
• Volume Pumped (Incremental): Total volume of flow pumped during current time step.
• Volume Pumped (Cumulative): Total volume of flow pumped up to the current time step.
• Water Power: The amount of energy transferred to the water by the pump.
• 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.
• Wire to Water Efficiency: The ratio of the Water Power to the Wire Power.
• Wire Power: The amount of energy delivered to the pump motor.
• Energy Used (Incremental): Total energy used during current time step.
• Energy Used (Cumulative): Total amount of energy used up to the current time step.
• Energy Price: Cost per unit of energy.
• Energy Cost (Incremental): The energy cost during the current time step.
• Energy Cost (Cumulative): The total energy cost up to the current time step.
• Cost per Unit Volume: Cost per unit of volume pumped for current time step.
• Relative Speed Factor (Energy Cost Engine): Relative speed of pump at current time step.
• Motor Efficiency: The Motor Efficiency value is representative of the ability of the motor to transform electrical
energy to rotary mechanical energy.
• Time of Use: The amount of time the pump is turned on over the course of the simulation.
• Utilization: Percentage of total time during the EPS that the pump was On.
• Volume Pumped (Total): The total volume of fluid pumped during the simulation.
• Water Power (Average): The average amount of energy transferred to the water by the pump over the course of the
simulation.
• Pump Efficiency (Average): The average pump efficiency during the simulation.
• Wire to Water Efficiency (Average): The average ratio of the Water Power to the Wire Power.
• Wire Power (Average): The average amount of energy delivered to the pump motor during the simulation.
• Energy Usage (Total): The total energy used during the simulation.
• Energy Use Cost (Total): Total cost of energy used during simulation.
• Energy Usage (Daily): Amount of energy used during a 24-hour period.

988
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Energy Use Cost (Daily): The cost of the energy used during a 24-hour period, determined by the calculated energy
usage and the energy pricing pattern.
• Cost per Unit Volume (Summary): Cost per unit of volume pumped over course of simulation.
• Head (Shutoff): Displays the shutoff head of the referenced pump definition if applicable.
• Head (Design): Displays the design head of the referenced pump definition if applicable.
• Flow (Design): Displays the design flow of the referenced pump definition if applicable.
• Head (Maximum Operating): Displays the maximum operating head of the referenced pump definition if
applicable.
• Flow (Maximum Operating): Displays the maximum operating flow of the referenced pump definition if
applicable.
• Flow (Maximum Extended): Displays the maximum extended flow of the referenced pump definition if
applicable.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.
• Speed (Maximum, Transient): Maximum pump speed over the course of the transient simulation.
• Speed (Minimum, Transient): Minimum pump speed over the course of the transient simulation.

Pump Station Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Geometry: Specify the geometric coordinates for this entity.
• Scaled Area: A polygon area value obtained from the underlying map dimensions.
• Is Active?: Specifies whether this element is active in the current scenario.
• Controls: Opens a filtered controls editor that only displays the controls associated with the pumps in the selected
pump station.

989
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Pumps: Pump elements that belong to this pump station.

• Time of Use: The total number of pump hours run during the simulation.
• Volume Pumped: The total volume of fluid pumped during the simulation.
• Water Power: The total amount of energy transferred to the water by the pumps in the pump station over the course
of the simulation.
• Efficiency (Average) Pump Station: Water power out divided by motor brake power in as a percentage.
• Wire to Water Efficiency (Average): Water power out divided by wire power in as a percentage.
• Wire Power (Total): The total amount of energy delivered to all the pump motors in the pump station during the
simulation.
• Energy Usage (Total): The total energy used during the simulation.
• Energy Use Cost (Total): Total cost of energy used during the simulation.
• Energy Usage (Daily): Amount of energy used during the 24-hour period.
• Energy Use Cost (Daily): The cost of energy used during a 24-hour period, determined by the calculated energy
usage and the energy pricing pattern.
• Cost per Unit Volume (Summary): Cost of energy divided by the volume pumped over the course of the
simulation.
• Flow (Total): Total flow pumped by pumps in the pump station at the current time step.
• Volume Pumped (Incremental): Total volume of flow pumped during the current time step.
• Volume Pumped (Cumulative): Total volume of flow pumped up to the current time step.
• Water Power: The amount of power transferred to the water by the pumps in the pump station at the current time
step.
• Efficiency Pump Station: Water power out from the station divided by the motor brake power in at the current time
step, expressed as a percentage.
• Wire to Water Efficiency: Water power from the station divided by the wire power in to the station at the current
time step, expressed as a percentage.
• Wire Power: The amount of power delivered to the pump motors at the pump station at the current time step.
• Energy Used (Incremental): Total energy used during the current time step.
• Energy Used (Cumulative): Total amount of energy used up to the current time step.
• Energy Price: Cost per unit of energy at the current time step.
• Energy Cost (Incremental): The cost of energy used during the current time step.
• Energy Cost (Cumulative): The total cost of energy used up to the current time step.
• Cost per Unit Volume: Cost per unit of volume pumped for the current time step.

Variable Speed Pump Battery Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Battery Pump Definition: Select pump definition for the lead and lag pumps in the battery.
• Control Node: The node that the battery checks to determine whether to increase, maintain, or decrease its relative
speed factor.
• Hydraulic Grade (Target): The Head that the battery will attempt to maintain for the Control Node.

990
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Relative Speed Factor (Maximum): The highest relative speed factor that the pump can be set at to meet the target
head at the control node. If the target head cannot be met when the pump is set at the maximum relative speed
factor, the maximum will be used.
• Lag Pump Count: Number of lag pumps (identical to the lead pump) whose relative speed factor is adjusted to
maintain the target head for a target head VSPB. (Lag pumps are not used for constant flow VSPBs).
• Control Node on Suction Side?: Specifies if the VSPB has a suction side control node.
• Target Flow: The relative speed of the lead pump will be adjusted to meet the Flow (Target). (Lag pumps are not
used for constant flow VSPBs).
• VSBP Type: Choices: Target Head, Fixed Flow
• Number of Running Lag Pumps (Initial): The initial number of running lag pumps for the transient simulation.
• Relative Speed Factor (Initial): Determines the initial speed of the pump impeller relative to the speed at which the
pump curve is defined.
• Status (Initial): Choices: On, Off
• Include in Energy Calculation?: If set to true, cost generated by the element will be included in the calculations,
otherwise they will be excluded.
• Energy Pricing: Specify which energy pricing definition is to be used when calculating costs of the corresponding
pump.
• Diameter (Pump Valve): Diameter refers to the valve at full opening, typically equal to the internal diameter of the
discharge flange.
• Flow (Nominal): Rated or duty flow for the pump, often at or near the best efficiency point.
• Head (Nominal): Rated or duty head for the pump, often at or near the best efficiency point.
• Relative Speed (Initial, Transient): The initial pump relative speed to be used in the transient analysis.
• Torque (Nominal): Specifies the nominal torque that, when multiplied by the Operating Rule's pattern multiplier
values will result in the torque values used by the engine.
• Pump Type (Transient): Choices: Shut Down After Time Delay, Constant Speed - No Pump Curve, Constant Speed
- Pump Curve, Variable Speed/Torque, Pump Start - Variable Speed/Torque
• Time (Delay until Shut Down): Time at which power to pump motor is shut off. By default, there is no time delay.
• Time (For Valve to Close): The time taken for the pump discharge control valve to close after the transient
simulation begins.
• Time (For Valve to Operate): Time to close check valve (or to open it if initial flow is zero). If the check valve
allows flow only in one direction, enter 0.
• Control Variable: Choices: Speed, Torque
• Status (Initial, Transient): Choices: On, Off
• Pump Valve Type: Choices: Check Valve, Control Valve
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this printout
is suppressed.
• Pump Station: The Pump Station to which this Pump belongs.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow (Lead Pump): Flow contributed by the lead pump in the pump battery.
• Number of Running Lag Pumps: Number of pump battery lag pumps running duing the current time step.

991
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Lag Pump Results: The collection of results for each lag pump in the battery.
• Relative Speed Factor (Calculated): Current relative speed factor of pump at current time step.
• Hydraulic Grade (Suction): Calculated hydraulic grade at suction side of the pump.
• Hydraulic Grade (Discharge): Calculated hydraulic grade at discharge side of the pump.
• Flow (Total): Total flow pumped by standard pump or the pump battery.
• Pump Head: Head gain between suction and discharge side of the pump.
• Pressure (Suction): Calculated pressure at suction side of the pump.
• Pressure (Discharge): Calculated pressure at discharge side of the pump.
• Flow (Absolute): The magnitude of flow through the pump regardless of flow direction.
• Pump Exceeds Operating Range?: Is true if the system demands on the pump exceeds its capabilities.
• Status (Calculated): Choices: On, Off, Pump Cannot Deliver Head (Closed), Pump Result Cannot Deliver
Flow (Open)
• Peak Power: Displays the peak energy usage, as calculated during the extended period simulation. This result is
displayed even if Peak Demand Charges are not applied.
• Time of Peak Energy Cost: Time when energy cost is maximum.
• Demand Charge: The charge applied per kW.
• Demand Charge Period: Time over which demand charge is averaged in order to get $/day.
• Peak Power Cost: Displays the energy cost as calculated during the extended period simulation. If no Peak Demand
Charge has been applied to the associated Energy Price Definition, this field will display as zero.
• Peak Power Cost (Daily): The cost associated with the Peak Demand Charge.
• Volume Pumped (Incremental): Total volume of flow pumped during current time step.
• Volume Pumped (Cumulative): Total volume of flow pumped up to the current time step.
• Water Power: The amount of energy transferred to the water by the pump.
• 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.
• Wire to Water Efficiency: The ratio of the Water Power to the Wire Power.
• Wire Power: The amount of energy delivered to the pump motor.
• Energy Used (Incremental): Total energy used during current time step.
• Energy Used (Cumulative): Total amount of energy used up to the current time step.
• Energy Price: Cost per unit of energy.
• Energy Cost (Incremental): The energy cost during the current time step.
• Energy Cost (Cumulative): The total energy cost up to the current time step.
• Cost per Unit Volume: Cost per unit of volume pumped for current time step.
• Relative Speed Factor (Energy Cost Engine): Relative speed of pump at current time step.
• Motor Efficiency: The Motor Efficiency value is representative of the ability of the motor to transform electrical
energy to rotary mechanical energy.
• Time of Use: The amount of time the pump is turned on over the course of the simulation.
• Utilization: Percentage of total time during the EPS that the pump was On.
• Volume Pumped (Total): The total volume of fluid pumped during the simulation.
• Water Power (Average): The average amount of energy transferred to the water by the pump over the course of the
simulation.
• Pump Efficiency (Average): The average pump efficiency during the simulation.
• Wire to Water Efficiency (Average): The average ratio of the Water Power to the Wire Power.
• Wire Power (Average): The average amount of energy delivered to the pump motor during the simulation.
• Energy Usage (Total): The total energy used during the simulation.
• Energy Use Cost (Total): Total cost of energy used during simulation.

992
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Energy Usage (Daily): Amount of energy used during a 24-hour period.

• Energy Use Cost (Daily): The cost of the energy used during a 24-hour period, determined by the calculated energy
usage and the energy pricing pattern.
• Cost per Unit Volume (Summary): Cost per unit of volume pumped over course of simulation.
• Head (Shutoff): Displays the shutoff head of the referenced pump definition if applicable.
• Head (Design): Displays the design head of the referenced pump definition if applicable.
• Flow (Design): Displays the design flow of the referenced pump definition if applicable.
• Head (Maximum Operating): Displays the maximum operating head of the referenced pump definition if applicable.
• Flow (Maximum Operating): Displays the maximum operating flow of the referenced pump definition if applicable.
• Flow (Maximum Extended): Displays the maximum extended flow of the referenced pump definition if applicable.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient simulation.
Not applicable to Reservoirs and Rating curves.

Turbine Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Time (Delay until Valve Operates): The time delay prior to operating the spherical valve.
• Time For Valve To Operate: Time required to operate the spherical valve. By default, it is set equal to one time
step.
• Diameter (Spherical Valve): The diameter of the spherical valve.
• Efficiency: The efficiency of the turbine. A typical value is 90.
• Moment of Inertia: The (weight) moment of inertia accounts for the turbine, generator, and entrained water.
• Speed (Rotational): Also known as synchronous speed for a turbine. The power it generates depends on it.
• Pattern (Gate Opening): Operating Rule describes the percent wicket gate opening vs time.

993
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Specific Speed: This represents the type of turbine. HAMMER ships with 4-quadrant curves for: 30, 45, or 60 (US
units), 115, 170, or 230 (metric units). You can add your own curves to this library.
• Flow (Rated): Nominal or rated flow of the turbine.
• Head (Rated): Nominal or rated head of the turbine.
• Operating Case: Choices: Instant Load Rejection, Load Rejection, Load Acceptance, Load Variation
• Turbine Curve: Turbine Curve is only required for a steady run. For a transient run, HAMMER uses a 4-quadrant
curve based on Specific Speed, Rated Head and Rated Flow.
• Electrical Torque Curve: Defines the time vs torque response for the turbine. Only applies to the Load Rejection
operating case.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this
printout is suppressed.
• Status (Initial): Choices: Open, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the turbine.
• Headloss: Change in head across turbine.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the turbine.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the turbine.
• Pressure (From): Calculated pressure at the entrance of the turbine.
• Pressure (To): Calculated pressure at the exit to the turbine.
• Flow (Absolute): Magnitude of flow through the selected turbine.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.
• Speed (Maximum, Transient): Maximum turbine speed over the course of the transient simulation.
• Speed (Minimum, Transient): Minimum turbine speed over the course of the transient simulation.

994
WaterGEMS CONNECT Edition Help
Element Properties Reference

Valve Attributes

Pressure Reducing Valve (PRV) Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow / (Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Hydraulic Grade Setting (Initial, Transient): The initial HGL setting for the transient simulation.
• Valve Characteristics: Specifies the valve characteristics definition to be used for this valve. If the Valve
Characteristic Curve is not defined then a default curve will be used. The default curve will have (Relative Closure,
Relative Area) points of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Setting Type: Choices: Pressure, Hydraulic Grade
• Pressure Setting (Initial): Specify the initial pressure setting for the valve.
• Hydraulic Grade Setting (Initial): Specify the initial hydraulic grade setting for the valve.
• Pattern (Valve Settings): Allows you to apply a pattern to make changes to the valve's setting over time for use in
extended period simulations. For settings patterns to work the valve must have a Status (Initial) equal to Active. For
pressure valves the setting applies to the valve's effective pressure setting irrespective of the Setting Type. Note that
changes made to a valve's setting by patterns will override any settings changes made by controls.
• Status (Initial): Choices: Active, Inactive, Closed
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.
• Valve Coefficient Type: Specifies which type of coefficient to enter for the control valve. If entering discharge
coefficient, the value is internally converted into an equivalent headloss coefficient (minor loss).
• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when fully open. Used in lieu of minor
loss for valves of this coefficient type.
• Specify Local Minor Loss?: If True, the minor coefficient for the element is manually set in the Minor Loss
Coefficient (Local) field; otherwise the value is derived from the minor loss library.
• Minor Loss Coefficient (Local): User-input minor loss coefficient. You can either type the value directly in this
field or select the value from the minor loss library. The minor loss is applied to the valve when it is fully open
(inactive). Note that minor losses do not apply to the following valve types: General Purpose Valve and Valve With
Linear Area Change. These two valve types do not support a (fully) open status and always apply the head/flow
relationship defined by their headloss curve and discharge coefficient, respectively.
• Valve Type: Specify the type of valve. Choices are Butterfly, Needle, Circular Gate, Globe, Ball, and User Defined.
• Modulate Valve During Transient?: If True, the valve closure will be automatically adjusted to maintain constant
valve outlet pressure.
• Opening Rate Coefficient: A constant that relates PRV opening rate during a transient simulation to the difference
between the PRV pressure setting and the computed PRV outlet pressure. Units are change in the valve relative
closure per second per unit of pressure difference.

995
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Closing Rate Coefficient: A constant that relates PRV closure rate during a transient simulation to the difference
between the PRV pressure setting and the computed PRV outlet pressure. Units are change in the valve relative
closure per second per unit of pressure difference.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Hydraulic Grade Setting (Calculated): Hydraulic Grade Setting during current time step.
• Pressure Setting (Calculated): Pressure setting for valve at current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.
Pressure Sustaining Valve (PSV) Attributes

996
WaterGEMS CONNECT Edition Help
Element Properties Reference

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow / (Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Hydraulic Grade Setting (Initial, Transient): The initial HGL setting for the transient simulation.
• Valve Characteristics: Specifies the valve characteristics definition to be used for this valve. If the Valve
Characteristic Curve is not defined then a default curve will be used. The default curve will have (Relative Closure,
Relative Area) points of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Setting Type: Choices: Pressure, Hydraulic Grade
• Pressure Setting (Initial): Specify the initial pressure setting for the valve.
• Hydraulic Grade Setting (Initial): Specify the initial hydraulic grade setting for the valve.
• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's setting over time for extended
period simulations. (Note that patterns override settings changes made by controls).
• Status (Initial): Choices: Active, Inactive, Closed
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.
• Valve Coefficient Type: Specifies which type of coefficient to enter for the control valve. If entering discharge
coefficient, the value is internally converted into an equivalent headloss coefficient (minor loss).
• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when fully open. Used in lieu of minor
loss for valves of this coefficient type.
• Specify Local Minor Loss?: If True, the minor coefficient for the element is manually set in the Minor Loss
Coefficient (Local) field; otherwise the value is derived from the minor loss library.
• Minor Loss Coefficient (Local): User-input minor loss coefficient. You can either type the value directly in this
field or select the value from the minor loss library. The minor loss is applied to the valve when it is fully open
(inactive). Note that minor losses do not apply to the following valve types: General Purpose Valve and Valve With
Linear Area Change. These two valve types do not support a (fully) open status and always apply the head/flow
relationship defined by their headloss curve and discharge coefficient, respectively.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Hydraulic Grade Setting (Calculated): Hydraulic Grade Setting during current time step.
• Pressure Setting (Calculated): Pressure setting for valve at current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.

997
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Pressure (From): Calculated pressure at the entrance of the valve.

• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Pressure Breaker Valve (PBV) Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Flow (Initial): This is a typical (positive) flow through the valve.
• Pressure Drop (Initial): Pressure drop corresponding to the typical flow.
• Setting Type: Choices: Pressure, Hydraulic Grade
• Pressure Setting (Initial): Specify the initial pressure setting for the valve.
• Hydraulic Grade Setting (Initial): Specify the initial hydraulic grade setting for the valve.
• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's setting over time for extended
period simulations. (Note that patterns override settings changes made by controls).
• Status (Initial): Choices: Active, Inactive, Closed
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.
• Valve Coefficient Type: Specifies which type of coefficient to enter for the control valve. If entering discharge
coefficient, the value is internally converted into an equivalent headloss coefficient (minor loss).

998
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when fully open. Used in lieu of minor
loss for valves of this coefficient type.
• Specify Local Minor Loss?: If True, the minor coefficient for the element is manually set in the Minor Loss
Coefficient (Local) field; otherwise the value is derived from the minor loss library.
• Minor Loss Coefficient (Local): User-input minor loss coefficient. You can either type the value directly in this
field or select the value from the minor loss library. The minor loss is applied to the valve when it is fully open
(inactive). Note that minor losses do not apply to the following valve types: General Purpose Valve and Valve With
Linear Area Change. These two valve types do not support a (fully) open status and always apply the head/flow
relationship defined by their headloss curve and discharge coefficient, respectively.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Hydraulic Grade Setting (Calculated): Hydraulic Grade Setting during current time step.
• Pressure Setting (Calculated): Pressure setting for valve at current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.

999
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Flow Control Vale (FCV) Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Flow Setting (Initial): Initial flow setting for the flow control valve.
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow / (Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Flow (Initial, Transient): The initial flow to be used in the transient analysis.
• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's setting over time for extended
period simulations. (Note that patterns override settings changes made by controls).
• Valve Characteristics: Specifies the valve characteristics definition to be used for this valve. If the Valve
Characteristic Curve is not defined then a default curve will be used. The default curve will have (Relative Closure,
Relative Area) points of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Status (Initial): Choices: Active, Inactive, Closed
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.
• Valve Coefficient Type: Specifies which type of coefficient to enter for the control valve. If entering discharge
coefficient, the value is internally converted into an equivalent headloss coefficient (minor loss).
• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when fully open. Used in lieu of minor
loss for valves of this coefficient type.
• Specify Local Minor Loss?: If True, the minor coefficient for the element is manually set in the Minor Loss
Coefficient (Local) field; otherwise the value is derived from the minor loss library.
• Minor Loss Coefficient (Local): User-input minor loss coefficient. You can either type the value directly in this
field or select the value from the minor loss library. The minor loss is applied to the valve when it is fully open
(inactive). Note that minor losses do not apply to the following valve types: General Purpose Valve and Valve With
Linear Area Change. These two valve types do not support a (fully) open status and always apply the head/flow
relationship defined by their headloss curve and discharge coefficient, respectively.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow Setting (Calculated): Flow setting at selected valve for current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.

1000
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Headloss: Change in head across the valve.

• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Throttle Control Valve (TCV) Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Headloss Coefficient Setting (Initial): Set the initial headloss coefficient for the valve.
• Discharge Coefficient (Initial): The discharge coefficient used at the start of a steady state or EPS run.
• Relative Closure (Initial): The initial relative closure used at the start of a steady state or EPS run. (A relative
closure of 0%% means the valve is 0%% closed, or 100%% open. Conversely, a relative closure of 100%% means
the valve is 100%% closed, or 0%% open).
• Coefficient Type: Choices: Headloss Coefficient, Discharge Coefficient, Valve Characteristics Curve
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow / (Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.

1001
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's setting over time for extended
period simulations. (Note that patterns override settings changes made by controls).
• Pattern (Relative Closures): Allows you to apply a pattern for changes to the valve's relative closure over time for
extended period simulations. (Note that patterns override settings changes made by controls).
• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when fully open. Used in lieu of minor
loss for valves of this coefficient type.
• Relative Closure (Initial Transient): The initial relative closure of the valve at the start of the transient calculation.
• Valve Characteristics: Specifies the valve characteristics definition to be used for this valve. If the Valve
Characteristic Curve is not defined then a default curve will be used. The default curve will have (Relative Closure,
Relative Area) points of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Status (Initial): Choices: Active, Inactive, Closed
• Specify Local Minor Loss?: If true then the minor coefficent for the element is manually set, otherwise the value is
derived from the minor loss library.
• Minor Losses: List of all associated minor losses associated with the element, and can be used to generate the
composite minor loss coefficient.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Headloss Coefficient Setting (Calculated): TCV headloss coefficient setting at the current time step.
• Discharge Coefficient Setting (Calculated): TCV discharge coefficient setting at the current time step.
• Relative Closure (Calculated): TCV relative closure at the current time step. (A relative closure of 0%% means
the valve is 0%% closed, or 100%% open. Conversely, a relative closure of 100%% means the valve is 100%%
closed, or 0%% open).
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.

1002
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

General Purpose Valve (GPV) Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Flow (Initial): This is a typical (positive) flow through the valve.
• Pressure Drop (Initial): Pressure drop corresponding to the typical flow.
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow / (Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Transient Analysis Behavior: Choices: Orifice, Valve
• Valve Characteristics: Specifies the valve characteristics definition to be used for this valve. If the Valve
Characteristic Curve is not defined then a default curve will be used. The default curve will have (Relative Closure,
Relative Area) points of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Status (Initial): Choices: Active, Closed
• Specify Local Minor Loss?: If true then the minor coefficent for the element is manually set, otherwise the value is
derived from the minor loss library.
• Minor Losses: List of all associated minor losses associated with the element, and can be used to generate the
composite minor loss coefficient.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.

1003
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Flow: Total flow through the valve.

• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Valve With Linear Area Change Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Status (Initial): Choices: Active, Closed
• Specify Local Minor Loss?: If true then the minor coefficent for the element is manually set, otherwise the value is
derived from the minor loss library.
• Minor Losses: List of all associated minor losses associated with the element, and can be used to generate the
composite minor loss coefficient.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.

1004
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Status (Initial, Transient): Choices: Active, Closed

• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the element, depending on whether its
derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient simulation.
Not applicable to Reservoirs and Rating curves.

Check Valve Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.

1005
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Flow (Typical): This value is 0 should the valve be initially closed.
• Pressure (Threshold): The pressure difference between upstream and downstream side to (re)open the (closed)
valve. If 0 entered, the valve (re)opens when the upstream pressure exceeds the downstream pressure.
• Closure Time: Time to close the valve, from the fully open position, after reverse flow is sensed. This establishes
the rate of closure in case the valve's opening is partial.
• Open Time: Time to open the valve, from the fully closed position, after specified pressure difference is exceeded.
This establishes the rate of opening in case the valve's closure is partial.
• Allow Disruption of Operation?: Determines whether an operation (opening or closing) can be terminated
prematurely due to a signal to reverse.
• Located At Wye?: Specifies whether the check valve is simulated as a simple check valve in a run of pipe, or if it is
simulated as a wye connection.
• Flow Direction: Choices: Towards Wye, Away from Wye
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the check valve.
• Flow (Absolute): Magnitude of flow through the selected check valve.
• Pressure: Calculated pressure at the check valve.
• Hydraulic Grade: Calculated hydraulic grade at the check valve.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Orifice Between Pipes Attributes

1006
WaterGEMS CONNECT Edition Help
Element Properties Reference

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Pressure Drop (Typical): Pressure drop corresponding to the typical flow.
• Flow (Typical): This is a typical (positive) flow through the orifice or valve.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the orifice.
• Headloss: Change in head across orifice.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the orifice.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the orifice.
• Pressure (From): Calculated pressure at the entrance of the orifice.
• Pressure (To): Calculated pressure at the exit to the orifice.
• Flow (Absolute): Magnitude of flow through the selected orifice.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed" or "Off."
• Controlled?: Is true if a control action in the current control set references the selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot deliver flow warning was generated
for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient simulation.
Not applicable to Reservoirs and Rating curves.

Discharge To Atmosphere Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.

1007
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Notes: Additional information about this element.

• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Discharge Element Type: Choices: Orifice, Valve, Rating Curve
• Gas Volume (Initial): The accumulated air at the orifice at the beginning of the simulation.
• Time to Start Operating: Valve starts to operate after this time.
• Time to Fully Open or Close: Time to close (or open, if zero initial flow) the valve.
• Valve Initial Status: Choices: Open, Closed
• Pressure Head vs. Flow: Specify a collection of Pressure Head vs. Flow points.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this
printout is suppressed.
• Pressure Drop (Typical): Pressure drop corresponding to the typical flow.
• Flow (Typical): This is a typical (positive) flow through the orifice or valve.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Discharge (Calculated): Calculated discharge from the node.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

1008
WaterGEMS CONNECT Edition Help
Element Properties Reference

Surge Tank Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Diameter (Orifice): Specifies the diameter of the tank inlet orifice. Only used by the transient engine.
• Ratio of Losses: Ratio of the head losses for equal inflows to / outflows from the tank via the orifice. Default value
is 2.5.
• Headloss Coefficient: Applies to flow from the tank to the pipe/riser. This must be a positive number.
• Surge Tank Type: Choices: Simple, Differential
• Has Check Valve?: Specify whether there is a check valve installed on the tank inlet/outlet. For the case of steady
state and EPS simulations, a surge tank with a check valve is simulated as a pressure junction.
• Diameter (Internal Riser): This is the upper riser.
• Elevation (Top of Internal Riser): The top of the upper riser.
• Elevation (Junction of Risers): Elevation at which the external and internal risers meet.
• Diameter (External Riser): This is the lower riser.
• Elevation (Orifice from Internal Riser to Tank): Elevation of the internal riser orifice.
• Elevation (Top of Tank Base): The elevation of the top of the hemisherical base of the tank. For a cylindrical tank,
this is equal to the pipe elevation.
• Weir Length: The width of the weir.
• Treat as Junction?: Specifies whether or not to treat the surge tank as a junction in steady state and EPS
simulations.
• Elevation (Base): Elevation of the storage tank base used as a reference when entering water surface elevations in
the tank in terms of levels.
• Elevation (Maximum): Highest allowable water surface elevation or level. If the tank fills above this point, it will
be automatically shut off from the system.
• Level (Maximum): A reference level to compare the hydraulic grade in the tank. Does not influence the
calculations.
• Diameter: Diameter of tank with constant circular cross-section.
• Area (Average): Cross-Sectional area of tank for constant x-section tanks.
• Volume Full (Input): full active volume of the variable area tank (i.e., the volume at 100% depth), exclusive of any
inactive volume.
• Operating Range Type: Choices: Elevation, Level
• Section: Choices: Circular, Non-Circular, Variable Area
• Cross-Section Curve: Defines a curve which specifies the relationship between depth and volume.
• Specify Local Bulk Rate?: If true than a local Bulk Reaction Rate can be specified for the tank, otherwise the bulk
reaction rate associated with selected constituent will govern.
• Bulk Reaction Rate (Local): Coefficient defining how rapidly a constituent grows or decays over time.
• Tank Mixing Model: Choices: 2-Compartment, Completely Mixed, FIFO, LIFO
• Compartment 1: Percent of available storage that makes up the first compartment. Inflow and outflow is assumed
to take place in the first compartment.
• Compartment 2: Percent of available storage that makes up the second compartment. The second compartment
receives overflow from the first, and this overflow is completely mixed.

1009
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Elevation (Minimum): Lowest allowable water surface elevation or level. If the tank drains below this point, it will
be automatically shut off from the system.
• Volume (Inactive): The inactive volume of the tank. This volume is the inaccessible volume of the tank that is
below the tank active operating range and can become important in water quality simulations subject to the selected
mixing model.
• Level (Minimum): Lowest allowable water surface elevation or level. If the tank drains below this point, it will be
automatically shut off from the system.
• Elevation (High Alarm): The elevation above which the high level alarm is generated. Calculation notifications are
produced to advise you of any alarm level violations.
• Level (High Alarm): The level above which the high level alarm is generated. Calculation notifications are
produced to advise you of any alarm level violations.
• Elevation (Low Alarm): The elevation below which the low level alarm is generated. Calculation notifications are
produced to advise you of any alarm level violations.
• Level (Low Alarm): The level below which the low level alarm is generated. Calculation notifications are produced
to advise you of any alarm level violations.
• Use High Alarm?: Specifies whether or not to check high alarm levels during Steady State/EPS calculation and
generate messages if the levels are violated.
• Use Low Alarm?: Specifies whether or not to check low alarm levels during Steady State/EPS calculation and
generate messages if the levels are violated.
• Elevation (Initial): Starting water surface elevation/level in the tank.
• Level (Initial): Starting water surface elevation/level in the tank.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Elevation (Initial, Transient): Enter a value only if a check valve is installed (i.e., case of a one-way surge tank),
or there is an initial inflow/outflow head loss. By default, the intial water surface level is taken equal to the head in
the adjacent pipe.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this
printout is suppressed.
• Demand Collection: A collection of baseline demands and associated temporal patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts, and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Volume Full (Calculated): The full active volume of the tank between the limits of the defined operating range,
exclusive of any inactive volume.
• Level (Calculated): Difference between calcuted hydraulic grade and the base elevation of the tank.
• Volume (Calculated): Total volume of fluid in tank including the inactive volume.

1010
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Percent Full: The ratio of tank active volume to the calculated tank full active volume. Active volume is the tank
volume within the operating range and is exclusive of inactive volume.
• Status (Calculated): Choices: Empty, Emptying, Filling, Full, Stagnant
• Flow (Out net): Net flow out of the element.
• Flow (In net): Net flow into the element.
• Demand Adjusted Population: Population of area supplied by current node. This value is derived from the unit
demand loads applied to the collection and their equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Hydropneumatic Tank Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Volume of Gas (Initial): The initial volume of gas in the pressure vessel at the start of the simulation. During the
transient event, this gas volume expands or compresses, depending on the transient pressures in the system. Not
used in steady state or EPS analyses.
• Diameter (Tank Inlet Orifice): The size of the opening between the gas vessel and the main pipe line. It is
typically smaller than the main pipe size.
• Ratio of Losses: For same flow magnitude, ratio of inflow head loss to outflow loss. Default value is 2.5.
• Gas Law Exponent: Refers to the exponent to be used in the gas law equation. The usual range of this exponent is
1.0 to 1.4.
• Pressure (Gas-Preset): If there is a bladder, this is the pressure of the gas prior to exposing the tank to pipeline
pressure; otherwise, this should be omitted as it is ignored.
• Liquid Elevation (Mean): The mean elevation of the liquid at the gas-liquid interface. (Liquid level referenced
from a datum of 0).
• Elevation Type: Choices: Fixed, Mean Elevation, Variable Elevation
• Variable Elevation Curve: Defines the gas vessel chamber geometry as a function of liquid elevation versus
equivalent diameter.
• Minor Loss Coefficient (Outflow): Dimensionless quantity, typical value = 2.5. This property is used only for
transient analysis, to restrict the flow out of the hydropneumatic tank.

1011
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Elevation (Base): Elevation of the storage tank base used as a reference when entering water surface elevations in
the tank in terms of levels.
• Treat as Junction? - Selects whether or not the hydropneumatic tank is treated as a junction in steady state and
EPS simulations. Note that if you wish to use the steady state/EPS results as input for a HAMMER transient
analysis and you set this field to True, you will need to manually enter the Volume of Gas (Initial) for the tank for
HAMMER
• Volume of Gas (Initial) - The initial volume of gas in the pressure vessel at the start of the simulation. During the
transient event, the gas volume expands or compresses, depending on the transient pressures in the system. This
value is not used in steady state or EPS analyses.
• Operating Range Type: Choices: Elevation, Level
• Tank Calculation Model: Choices: Constant Area Approximation, Gas Law Model
• Volume (Effective): The effective volume of the constrant area approximation hydropneumatic tank.
• HGL On: The lowest operational hydraulic grade desired for the hydropneumatic tank. You should define a simple
or logical control that uses this hydraulic grade as the minimum operational value. For example, define a control to
turn on a pump.
• HGL Off: The highest operational hydraulic grade desired for the hydropneumatic tank. You should define a simple
or logical control that uses this hydraulic grade as the maximum operational value. For example, define a control to
turn off a pump.
• Atmospheric Pressure Head: This field represents atmospheric pressure and is used in the gas law model
computation of the hydropneumatic tank.
• HGL (Initial): Starting water surface elevation/level in the tank. Used in steady state and EPS analyses.
• Level (Initial): Starting water surface elevation/level in the tank. Used in steady state and EPS analyses.
• Liquid Volume (Initial): Starting liquid volume in the tank. For constant area approximation tanks this volume
includes the inactive volume of the tank that lies below the effective volume. Only used in steady state and EPS
analyses.
• Air Flow Curve (Air Inflow Orifice): Curve that defines orifice behavior for the injection of air into the pipeline.
• Air Flow Curve (Air Outflow Orifice): Curve that defines discharge of air when the volume is greater than or
equal to the transition volume (TV).
• Air Flow Calculation Method: Choices: Orifice Diameter, Air Flow Curve
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Elevation (Initial, Transient): Enter a value only if a check valve is installed (i.e., case of a one-way surge tank),
or there is an initial inflow/outflow head loss. By default, the intial water surface level is taken equal to the head in
the adjacent pipe.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this
printout is suppressed.
• Demand Collection: A collection of baseline demands and associated temporal patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts, and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster

1012
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Gas Volume (Calculated): The calculated volume of gas in the hydropneumatic tank.
• Pressure (Calculated): The calculated pressure in the hydropenumatic tank.
• Liquid Volume (Calculated): The calculated liquid volume in the hydropneumatic tank.
• Percent Full: The ratio of the fluid volume in the tank to the calculated full volume of the tank.
• Flow (Out net): Net flow out of the element.
• Flow (In net): Net flow into the element.
• Demand Adjusted Population: Population of area supplied by current node. This value is derived from the unit
demand loads applied to the collection and their equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.
• Gas Pressure (Maximum, Transient): Maximum gas pressure at node over the course of the transient simulation.
• Gas Pressure (Minimum, Transient): Minimum gas pressure at node over the course of the transient simulation.
• Gas Volume (Maximum, Transient): Maximum gas volume at node over the course of the transient simulation.
• Gas Volume (Minimum, Transient): Minimum gas volume at node over the course of the transient simulation.
• Water Level (Maximum, Transient): Maximum water level in tank over the course of the transient simulation.
• Water Level (Minimum, Transient): Minimum water level in tank over the course of the transient simulation.

Air Valve Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Air Volume (Initial): Volume of air near the valve at the start of the simulation. The default is zero. If volume is
nonzero, the pressure must be zero.
• Time to Close: For an air valve, adiabatic compression (i.e., gas law exponent = 1.4) is assumed.The valve starts to
close linearly with respect to area only when air begins to exit from the pipe. If air subsequently re-enters, then the

1013
WaterGEMS CONNECT Edition Help
Element Properties Reference

valve opens fully again. It is possible for liquid to be discharged through this valve for a period after the air has been
expelled.
• Diameter (Small Air Outflow Orifice): Diameter of the air outflow orifice (the orifice through which air is
expelled from the pipeline) when the local air volume is less than the transition volume (TV), or the air pressure is
greater than the transition pressure (TP) (depending on which trigger is used to switch the outflow orifice size). This
diameter is typically small enough for the injected air to be compressed, which can help prevent severe transient
pressures. Generally air flows out the large air outflow orifice for some time before switching to the small air
outflow orifice for the final stages of air release.
• Diameter (Large Air Outflow Orifice): Refers to the discharge of air when the local air volume is greater than or
equal to the transition volume (TV), or the air pressure is less than or equal to the transition pressure (TP)
(depending on which trigger is used to switch the outflow orifice size). This diameter is typically large enough that
there is little or no restriction to air outflow. Generally air flows out the large air outflow orifice for some time
before switching to the small air outflow orifice for the final stages or air release.
• Diameter (Air Inflow Orifice): Diameter of the air inflow orifice (the orifice through which air enters the pipeline
when the pipe internal pressure is less than atmospheric pressure). This diameter should be large enough to allow
the free entry of air into the pipeline. If set to zero, this diameter is considered infinite (i.e. there is no restriction to
air inflow).
• Diameter (Air Outflow Orifice): Diameter of the air outflow orifice (the orifice through which air is expelled from
the pipeline).
• Transition Pressure: The local internal system air pressure at the air valve above which the transient solver
switches from using the large air orifice to the small air orifice (in order to minimize transients).
• Transition Volume: The local volume of air at the air valve below which the transient solver switches from using
the large air orifice to the small air orifice (in order to minimize transients). This volume often corresponds to the
volume of the body of the air valve.
• Air Flow Curve (Small Air Outflow Orifice): Curve that defines discharge of air when the air volume is less than
the transition volume (TV), or the air pressure is greater than the transition pressure (TP).
• Air Flow Curve (Large Air Outflow Orifice): Curve that defines discharge of air when the air volume is greater
than or equal to the transition volume (TV), or the air pressure is less than or equal to the transition pressure (TP).
• Air Valve Type: Choices: Slow Closing, Double Acting, Triple Acting, Vacuum Breaker
• Trigger to Switch Outflow Orifice Size: Select whether the transient solver switches from the large air
outflow orifice to the small air outflow orifice based on Transition Volume or Transition Pressure.
• Report Period (Transient): Number of time steps between successive printouts of operation. By default, this
printout is suppressed.
• Treat Air Valve as Junction?: Specifies whether or not to treat the air-valve as a junction element in steady state
and EPS simulations. If false, the valve may allow part full flow subject to the prevailing hydraulic conditions.
• Air Flow Curve (Air Inflow Orifice): Curve that defines orifice behavior for the injection of air into the pipeline.
• Air Flow Curve (Air Outflow Orifice): Curve that defines discharge of air when the volume is greater than or
equal to the transition volume (TV).
• Air Flow Calculation Method: Choices: Orifice Diameter, Air Flow Curve
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster

1014
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Surge Valve Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Diameter (SAV): The valve's characteristics are determined by its Cv and type, so that the diameter is only used for
descriptive purposes.
• Threshold Pressure (SAV): Pressure below which the SAV opens.
• Time for SAV to Open: Time for the SAV to open fully after being triggered.
• Time SAV Stays Fully Open: Time that SAV remains fully open (i.e., time between the end of the opening phase
and the start of the closing phase).
• Time for SAV to Close: Time for the SAV to close fully, measured from the time that it was completely open.
• Discharge Coefficient (when SAV Fully Open): Discharge coefficient, Cv, is defined as: Flow / (Pressure Drop) ^
0.5.
• Threshold Pressure (SRV): Pressure above which the SRV opens.
• Diameter (SRV): The diameter of the SRV.
• Spring Constant (SRV): Change in restoring force of the return spring per unit lift off seat. A possible value is 150
lb/in. (26.27 N/mm).
• SAV / SRV Type: Choices: Surge Anticipator Valve, Surge Relief Valve, Surge Anticipator & Relief Valve
• Valve Type: Choices: Needle, Circular Gate, Globe, Ball, Butterfly
• SAV Closure Trigger: Choices: Time, Threshold Pressure

1015
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Rupture Disk Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Pressure Threshold: The pressure above which the rupture disk breaks to vent the liquid to atmosphere.
• Pressure Drop (Typical): Pressure drop corresponding to the typical flow.
• Flow (Typical): This is a typical (positive) flow through the orifice or valve.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.

1016
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Concentration (Initial): Specify the initial concentration for the global concentration at the selected element.
• Is Constituent Source?: If true then the selected node can inject a set concentration of the global constituent into
the system.
• Pattern (Constituent): Specify the pattern which dictates how the injected constituent concentration varies over
time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint Booster, Mass Booster
• Concentration (Base): This data field allows you to specify the corresponding constituent concentration at this
node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constituent mass rate at this node over
time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time step.
• Has Calculation Messages Now?: If true then the current element has associated calculation warning messages for
the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the transient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the transient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course of the transient simulation. Not
applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the course of the transient
simulation. Not applicable to Reservoirs and Rating curves.

Isolation Valve Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity through the valve and a
corresponding minor loss when a minor loss coefficient is entered.
• Minor Loss Coefficient: K value in the minor headloss equation.
• Is Operable?: If true, valve can be used in identifying segments.
• Status (Initial): Choices: Open, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground elevation at tanks; the hydraulic grade
at reservoirs.
• Installation Year: Specify the install year of the element. It does not affect the calculations.
• Zone: Specify the zone for the element.
• Hydraulic Grade: Hydraulic Grade at valve location on pipe.
• Pressure: Pressure at valve location on pipe.

1017
WaterGEMS CONNECT Edition Help
Element Properties Reference

• Flow: Magnitude of flow through isolation valve.

• Velocity: Velocity through the isolation valve.
• Distance from End Point (Unified): Presents the active Distance From End Point for the current isolation valve.
• Is Closed?: True if current isolation valve is closed during the current time step.

Spot Elevation Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document, or other file with this element.
• Hydraulic Grade (Enhanced) Interpolated hydraulic grade at this location.
• Pressure (Enhanced) Pressure based on the interpolated hydraulic grade

1018
 Index
A Creating a Selection Set from a M
Actions Tab 537 Selection 225
MicroStation Environment 48
Active Topology Selection Creating Alternatives 421
MicroStation Mode Graphical
Dialog Box 541 Creating Prototypes 240
Layout 50
Adding Elements to a Selection Creating Queries 261
Minimizing Effort through
Set 226 Creating Scenarios 417
Attribute Inheritance
Alternative Editor Dialog Box Custom Sort Dialog Box 817
410
420 Customization Editor Dialog Box
Minimizing Effort through
Annotating Your Model 790 275
Scenario Inheritance
Assign Taps to Links Dialog Box Customizing a Graph 882
411
210 ModelBuilder Wizard 295
associating
CONNECTED projects 16
D Modeling Curved Pipes 208
disassociating
CONNECTED projects 17 N
B Drawing Synchronization 59 Naming and Renaming
Batch Pipe Split Dialog Box 211 FlexTables 813
Bentley CONNECT 15
E
Editing Alternatives 421 O
C Editing FlexTables 813 Observed Data Dialog Box 844
Chart Options Dialog Box 847 Editing Scenarios 417 Opening FlexTables 812
Color Coding Your Model 794 Engineering Libraries 253
Conditions Tab 533 Extended Period Simulation 447
CONNECT 15 P
CONNECTED Project Panning 37
assign project dialog 16
F Pattern Curve Dialog Box 529
Finalizing the Model 414 Preparing to Use ModelBuilder
registering 18
FlexTable Dialog Box 810 290
CONNECTED projects
FlexTables Manager 807 Profile Setup 803
associating 16
disassociating 17 Profile Viewer Dialog Box 805
CONNECTION Client 15 G ProjectWise Cross-Discipline
Constituent Alternatives 430 GIS-IDs 309 Coordination Services
Contour Plot 800 GIS-IDs Collection Dialog Box Support 98
Controlling Results Output 519 310 Property Editor 216
Controls Tab 530 Graph Dialog Box 838
Copying Graph Manager 836 R
Exporting Graphing 836
Relabeling Elements 218
and Printing
Removing Elements from 226
FlexTable
Data 821
I Running Multiple Scenarios at
Import Bentley SewerCAD 55 Once (Batch Runs) 417
Creating a New FlexTable 813

1019
S Step 4-Additional Options 299 Using Prototypes 240
Sample Observed Data Source Step 5-Specify Field mappings Using Selection Sets 221
845 for each Table/Feature Using the Like Operator 264
SCADAConnect Overview 552 Class 300
Scenario Cycle 407 Subtypes 307
Selection Sets Manager 222 W
Sharing User Data Extensions Warnings 306
Among Element Types T Working in AutoCAD Mode 56
269 Time Browser 448 Working with Engineering
Sorting and Filtering FlexTable Time Series Field Data 888 Libraries 254
Data 815 Totalizing Flow Meter Editor Working with FlexTable Folders
Specifying Network Dialog 455 810
Connectivity in Totalizing Flow Meters Manager Working with Graph Data
ModelBuilder 307 Dialog 454 Viewing and Copying 838
Splitting Pipes 207
Step 1-Specify Data Source 295 U Z
Step 2-Specify Spatial Options User Data Extensions 264 Zooming 38
296 User Notifications 454
Step 3 - Specify Element Create/ Using Background Layers 42
Remove/Update Options Using Folders in the Element
298 Symbology Manager 791

1020