WaterGEMS V8i User's Guide

Last Updated: August 05, 2015
Table of Contents
WaterGEMS V8i (SELECTseries 6) Help .............................................................................................. 7
Getting Started in WaterGEMS V8i ..............................................................................................................................................................7
What's New in WaterGEMS V8i? ................................................................................................................................................. 7
What is WaterGEMS V8i? ................................................................................................................................................................7
Municipal License Administrator Auto-Configuration ...................................................................................................... 8
Starting WaterGEMS V8i ................................................................................................................................................................ 8
Working with WaterGEMS V8i Files .......................................................................................................................................... 8
Exiting WaterGEMS V8i ..................................................................................................................................................................9
Image Properties ................................................................................................................................................................................ 9
Image Properties ............................................................................................................................................................................. 11
Be Communities Search Button ............................................................................................................................................... 13
RSS Feeds ........................................................................................................................................................................................... 13
Software Updates via the Web and Bentley SELECT ....................................................................................................... 13
DXF Properties ................................................................................................................................................................................. 14
Show Flow Arrows (Stand-Alone) ........................................................................................................................................... 15
Application Window Layout ....................................................................................................................................................... 15
WaterObjects Help for Model Users ........................................................................................................................................ 27
Understanding the Workspace .................................................................................................................................................................. 27
Stand-Alone ........................................................................................................................................................................................27
MicroStation Environment ..........................................................................................................................................................37
Working in AutoCAD Mode ........................................................................................................................................................ 46
Working in ArcGIS ...........................................................................................................................................................................52
Creating Models ................................................................................................................................................................................................66
Starting a Project ............................................................................................................................................................................. 66
Elements and Element Attributes ............................................................................................................................................ 91
Adding Elements to Your Model .............................................................................................................................................180
Manipulating Elements .............................................................................................................................................................. 180
Editing Element Attributes .......................................................................................................................................................188
Using Named Views ..................................................................................................................................................................... 192
Using Selection Sets ..................................................................................................................................................................... 194
Using the Network Navigator ..................................................................................................................................................200
Using the Pressure Zone Manager .........................................................................................................................................204
Using Prototypes ...........................................................................................................................................................................213
Zones .................................................................................................................................................................................................. 214
Engineering Libraries ................................................................................................................................................................. 215
Hyperlinks ...................................................................................................................................................................................... 218
Using Queries ..................................................................................................................................................................................220
User Data Extensions .................................................................................................................................................................. 228
Property Grid Customizations Manager ............................................................................................................................. 236
Tooltip Customization ................................................................................................................................................................ 237
i-Models ............................................................................................................................................................................................ 239
Storage Chambers Dialog Box ................................................................................................................................................. 246
Using ModelBuilder to Transfer Existing Data .................................................................................................................................250
Preparing to Use ModelBuilder .............................................................................................................................................. 250
ModelBuilder Connections Manager ....................................................................................................................................251
2
ModelBuilder Wizard ..................................................................................................................................................................254
Reviewing Your Results ............................................................................................................................................................. 262
Multi-select Data Source Types .............................................................................................................................................. 262
ModelBuilder Warnings and Error Messages .................................................................................................................. 263
ESRI ArcGIS Geodatabase Support ........................................................................................................................................264
Specifying Network Connectivity in ModelBuilder ........................................................................................................265
GIS-IDs ............................................................................................................................................................................................... 267
Specifying a SQL WHERE clause in ModelBuilder .........................................................................................................268
Modelbuilder Import Procedures ..........................................................................................................................................269
Oracle as a Data Source for ModelBuilder ......................................................................................................................... 281
Applying Elevation Data with TRex ...................................................................................................................................................... 282
The Importance of Accurate Elevation Data ..................................................................................................................... 282
Numerical Value of Elevation .................................................................................................................................................. 283
Obtaining Elevation Data ...........................................................................................................................................................284
Record Types .................................................................................................................................................................................. 285
Calibration Nodes ......................................................................................................................................................................... 285
TRex Terrain Extractor .............................................................................................................................................................. 286
TRex Wizard ....................................................................................................................................................................................287
Allocating Demands using LoadBuilder .............................................................................................................................................. 291
Using GIS for Demand Allocation ...........................................................................................................................................291
Using LoadBuilder to Assign Loading Data ...................................................................................................................... 296
Generating Thiessen Polygons ................................................................................................................................................307
Demand Control Center ............................................................................................................................................................. 311
Unit Demands Dialog Box ..........................................................................................................................................................314
Unit Demand Control Center ................................................................................................................................................... 316
Pressure Dependent Demands ............................................................................................................................................... 317
Reducing Model Complexity with Skelebrator .................................................................................................................................322
Skeletonization ............................................................................................................................................................................. 322
Common Automated Skeletonization Techniques ......................................................................................................... 324
Skeletonization Using Skelebrator ........................................................................................................................................326
Using the Skelebrator Software ..............................................................................................................................................332
Backing Up Your Model ..............................................................................................................................................................349
Scenarios and Alternatives ....................................................................................................................................................................... 352
Understanding Scenarios and Alternatives .......................................................................................................................352
Scenario Example - A Water Distribution System .......................................................................................................... 358
Scenarios .......................................................................................................................................................................................... 362
Alternatives ..................................................................................................................................................................................... 366
Scenario Comparison .................................................................................................................................................................. 390
Modeling Capabilities .................................................................................................................................................................................. 394
Model and Optimize a Distribution System .......................................................................................................................394
Steady-State/Extended Period Simulation ........................................................................................................................395
Calculate Network ....................................................................................................................................................................... 399
Global Demand and Roughness Adjustments ...................................................................................................................399
Check Data and Validate ........................................................................................................................................................... 401
User Notifications ......................................................................................................................................................................... 402
Using the Totalizing Flow Meter ............................................................................................................................................ 402
System Head Curves .................................................................................................................................................................... 404
Post Calculation Processor ....................................................................................................................................................... 405
Flow Emitters ................................................................................................................................................................................. 406
Parallel VSPs .................................................................................................................................................................................. 407
Fire Flow Analysis ....................................................................................................................................................................... 408
3
Water Quality Analysis ..............................................................................................................................................................412
Criticality Analysis ....................................................................................................................................................................... 442
Calculation Options ......................................................................................................................................................................453
Patterns ............................................................................................................................................................................................464
Controls .............................................................................................................................................................................................468
Active Topology .............................................................................................................................................................................480
External Tools ................................................................................................................................................................................ 481
Hydraulic Transient Pressure Analysis ...............................................................................................................................483
Copy Initial Conditions Dialog Box ........................................................................................................................................490
Selection of the Time Step ....................................................................................................................................................... 491
SCADAConnect Overview .........................................................................................................................................................492
Flushing Simulation ..................................................................................................................................................................... 538
Modeling Tips .................................................................................................................................................................................553
Pipe Renewal Planner ................................................................................................................................................................563
Pipe Break Analysis .................................................................................................................................................................... 571
Calibrating Your Model with Darwin Calibrator ............................................................................................................................. 579
Calibration Studies .......................................................................................................................................................................581
Optimized Runs ............................................................................................................................................................................ 588
Manual Runs .................................................................................................................................................................................. 591
Calibration Solutions ...................................................................................................................................................................593
Importing Field Data into Darwin Calibrator Using ModelBuilder .........................................................................596
GA-Optimized Calibration Tips ...............................................................................................................................................599
Optimizing Capital Improvement Plans with Darwin Designer ................................................................................................602
Darwin Designer .......................................................................................................................................................................... 602
Design Study .................................................................................................................................................................................. 603
Optimized Runs ............................................................................................................................................................................ 623
Manual Design Run ...................................................................................................................................................................... 626
Manual Cost Estimating ............................................................................................................................................................ 641
Advanced Darwin Designer Tips ............................................................................................................................................644
Optimizing Pump Operations .................................................................................................................................................................. 650
Energy Management and Scenario Energy Cost Calculations ................................................................................... 650
Optimizing Pump Schedules Using Darwin Scheduler ..................................................................................................................666
Best Practices and Tips ............................................................................................................................................................. 666
Darwin Scheduler ........................................................................................................................................................................ 669
Darwin Scheduler FAQ ............................................................................................................................................................... 694
Presenting Your Results ............................................................................................................................................................................. 704
Node Histories Tab ...................................................................................................................................................................... 704
Annotating Your Model .............................................................................................................................................................. 705
Color Coding Your Model .......................................................................................................................................................... 709
Contours ........................................................................................................................................................................................... 711
Using Profiles ..................................................................................................................................................................................715
Viewing and Editing Data in FlexTables ............................................................................................................................. 721
Reporting ..........................................................................................................................................................................................737
Graphing ........................................................................................................................................................................................... 740
Time Series Field Data ................................................................................................................................................................788
Calculation Summary .................................................................................................................................................................789
Transient Results Viewer .........................................................................................................................................................790
Transients Results Viewer Dialog (New) .......................................................................................................................... 794
Results Table Dialog Box ........................................................................................................................................................... 800
Print Preview Window ............................................................................................................................................................... 800
Print Preparation ..........................................................................................................................................................................802
4
Importing and Exporting Data .................................................................................................................................................................802
Moving Data and Images Between Model(s) and other Files ................................................................................... 802
Importing a WaterGEMS V8i Database .............................................................................................................................. 803
Importing and Exporting EPANET Files ............................................................................................................................ 804
Importing and Exporting Submodel Files ......................................................................................................................... 804
Exporting a DXF File .................................................................................................................................................................... 805
File Upgrade Wizard ....................................................................................................................................................................806
Export to Shapefile .......................................................................................................................................................................806
Menus ................................................................................................................................................................................................................. 807
File Menu .......................................................................................................................................................................................... 807
Edit Menu ......................................................................................................................................................................................... 809
Analysis Menu ................................................................................................................................................................................ 810
Components Menu ....................................................................................................................................................................... 812
View Menu ....................................................................................................................................................................................... 813
Tools Menu ...................................................................................................................................................................................... 814
Report Menu ................................................................................................................................................................................... 817
Help Menu ........................................................................................................................................................................................817
Technical Reference .....................................................................................................................................................................................818
Pressure Network Hydraulics ................................................................................................................................................. 818
Friction and Minor Loss Methods ..........................................................................................................................................828
VSP Interactions with Simple and Logical Controls .......................................................................................................833
Performing Advanced Analyses ............................................................................................................................................. 833
Hydraulic Equivalency Theory ............................................................................................................................................... 834
Thiessen Polygon Generation Theory ..................................................................................................................................838
Method for Modeling Pressure Dependent Demand .....................................................................................................839
References ....................................................................................................................................................................................... 846
Technical Information Resources .......................................................................................................................................................... 848
docs.bentley.com ...........................................................................................................................................................................848
Bentley Services ............................................................................................................................................................................ 848
Bentley Discussion Groups ....................................................................................................................................................... 849
Bentley on the Web ......................................................................................................................................................................849
TechNotes/Frequently Asked Questions ........................................................................................................................... 849
BE Magazine ....................................................................................................................................................................................850
BE Newsletter .................................................................................................................................................................................850
Client Server ....................................................................................................................................................................................850
BE Careers Network .................................................................................................................................................................... 850
Contact Bentley Systems ........................................................................................................................................................... 850
Element Properties Reference ..................................................................................................................................................................852
Edit Element Properties ........................................................................................................................................................... 852
Pipe Attributes ............................................................................................................................................................................... 852
Junction Attributes .......................................................................................................................................................................856
Hydrant Attributes .......................................................................................................................................................................859
Tank Attributes ..............................................................................................................................................................................861
Reservoir Attributes ....................................................................................................................................................................864
Periodic Head-Flow Attributes ............................................................................................................................................... 865
Pump Attributes ............................................................................................................................................................................ 866
Pump Station Attributes ............................................................................................................................................................ 869
Variable Speed Pump Battery Attributes ........................................................................................................................... 870
Turbine Attributes ....................................................................................................................................................................... 873
Valve Attributes .............................................................................................................................................................................874
Valve With Linear Area Change Attributes ........................................................................................................................884
5
Check Valve Attributes ............................................................................................................................................................... 885
Orifice Between Pipes Attributes ...........................................................................................................................................886
Discharge To Atmosphere Attributes .................................................................................................................................. 887
Surge Tank Attributes .................................................................................................................................................................888
Hydropneumatic Tank Attributes ......................................................................................................................................... 891
Air Valve Attributes ..................................................................................................................................................................... 893
Surge Valve Attributes ................................................................................................................................................................895
Rupture Disk Attributes .............................................................................................................................................................896
Isolation Valve Attributes ......................................................................................................................................................... 897
Spot Elevation Attributes .......................................................................................................................................................... 897
6
WaterGEMS V8i (SELECTseries 6) Help
Getting Started in WaterGEMS V8i

Click the links below to learn about getting started in WaterGEMS V8i:
What's New in WaterGEMS V8i?
New and improved features in WaterGEMS V8i include:

Major upgrade to SCADAConnect features
Complete rewrite of user interface for SCADAConnect Simulator making it much easier for non-modeler to
create runs for pipe breaks, fire flows, shut downs, unusual demands, or overriding controls
Improved capability for importing, using and viewing SCADA data
Improvements to flushing planning
Easier layout of uni-directional flushing runs
Greatly improved field operator reports
Better visualization of flushing events
Improved variable speed pump modeling
Ability to modify set points over time
More stable runs with multiple pumps
Better management of customer meter elements in criticality and pressure zone manager
Multi-threading of fire flow calculations
Improved Pipe Renewal Planner scoring for risk calculation
Warnings if pressure drops below vapor pressure
Availability of RSS feeds in model
Updated platform support
What is WaterGEMS V8i?
WaterGEMS V8i is a powerful yet easy-to-use program that helps engineers analyze complex pumping systems and
piping networks as they transition from one steady state to another. Hydraulic transients only last from seconds to a few
minutes, but they can damage a system or cause significant operational difficulties. For example, WaterGEMS V8i
name is due to the loud "water hammer" knocking sound that can be heard when sudden hydraulic transients occur.
WaterGEMS V8i helps engineers understand their pumping and piping networks better, enabling them to design safe
and economical surge-control systems.
WaterGEMS V8i is based on technology originally created by GENIVAR (formerly Environmental Hydraulics Group
Inc.), the water WaterGEMS V8i specialists, and backed by a long-term collaboration between GENIVAR and Bentley.
Bentley and GENIVAR are committed to continuously improving WaterGEMS V8i.
7
Municipal License Administrator Auto-Configuration
At the conclusion of the installation process, the Municipal License Administrator will be executed, to automatically
detect and set the default configuration for your product, if possible. However, if multiple license configurations are
detected on the license server, you will need to select which one to use by default, each time the product starts. If this is
the case, you will see the following warning: Multiple license configurations are available... Simply press OK to clear
the Warning dialog, then press Refresh Configurations to display the list of available configurations. Select one and
press Make Default, then exit the License Administrator. (You only need to repeat this step if you decide to make a
different configuration the default in the future.)
Starting WaterGEMS V8i
After you have finished installing WaterGEMS V8i, restart your system before starting WaterGEMS V8i for the first
time.
To start WaterGEMS V8i:
1. Double-click on the WaterGEMS V8i icon on your desktop, or
2. Click Start > All Programs > Bentley > WaterGEMS V8i > WaterGEMS V8i.
Working with WaterGEMS V8i Files
WaterGEMS V8i uses an assortment of data, input, and output files. It is important to understand which are essential,
which are temporary holding places for results and which must be transmitted when sending a model to another user. In
general, the model is contained in a file with the wtg.sqlite extension. This file contains essentially all of the
information needed to run the model. This file can be zipped to dramatically reduce its size for moving the file.
The .wtg file and the drawing file (.dwh, dgn, dwg or .sqlite) file contain user supplied data that makes it easier to view
the model and should also be zipped and transmitted with the model when moving the model.
Other files found with the model are results files. These can be regenerated by running the model again. In general
these are binary files which can only be read by the model. Saving these files makes it easy to look at results without
the need to rerun the model. Because they can be easily regenerated, these files can be deleted to save space on the
storage media.
When archiving a model at the end of the study, usually only the *.wtg.sqlite, *.wtg files, and the platform specific
supporting files (*.dwh, *.dgn, *.dwg or *.sqlite) need to be saved.The file extensions are explained below:
.bak - backup files of the model files
.cri - results of criticality analysis
.dgn - drawing file for MicroStation platform
.dwg - drawing file for AutoCAD platform
.dwh - drawing file for stand alone platform
.sqlite - access database file for ArcGIS platform
.nrg - results of energy calculations
.osm - outage segmentation results
.out - primary output file from hydraulic and water quality analyses
.out.fl - output file from flushing analysis
8
.rpc - report file from hydraulic analysis with user notifications

.seg - results of segmentation analysis
wtg.sqlite - main model file
.wtg - display settings (e.g. color coding, annotation)
.xml - xml files, generally libraries, window and other settings. Some modules like ModelBuilder also use .xml files
to store settings independent of the main model.
.hof - results of transient analysis used by the transient results viewer
.hmr - results of transient analysis
.hut - transient analysis output log
.rpt - transient analysis detailed report file
Using the Custom Results File Path Option

When the Specify Custom Results File Path option (found under Tools > Options > Project Tab) is on for the project,
the result files will be stored in the custom path specified when the project is closed. When the project is open, all of the
applicable result files (if any) will be moved (not copied) to the temporary directory to be worked on. The result files
will then be moved back to the custom directory when the project is closed.
The advantages of this are that moving a file on disk is very quick, as opposed to copying a file, which can be very
slow. Also, if you have your project stored on a network drive and you specify a custom results path on your local disk,
then you will avoid network transfer times as well. The disadvantages are that, should the program crash or the project
somehow doesnt close properly, then the results files will not be moved back and will be lost.
If you then wish to share these results files with another user of the model, you can use the Copy Results To Project
Directory command (Tools > Database Utilities > Copy Results To Project Directory) to copy the results files to the
saved location of the model. The user receiving the files may then use the Update Results From Project Directory
command (Tools > Database Utilities > Update Results From Project Directory) to copy the results files from the
project directory to their custom results file path.
Drag-and-drop File Open
You can open model files by simply dragging them (from Windows Explorer, for example) into the application window
(stand alone version only). You can drag either the .wtg or the .sqlite associated with the model.
You can drag multiple files into the application at once. All files must be of a valid type (.wtg or .sqlite) for this to
work.
Exiting WaterGEMS V8i
To exit WaterGEMS V8i:

1. Click the application window's Close icon (the X button), or
2. From the File menu, choose Exit.
Note: If you have made changes to the project file without saving, the following dialog box will open. Click Yes to
save before exiting, No to exit without saving, or Cancel to stop the operation.
Image Properties
This dialog box opens when you are adding or editing a background-layer image other than a .dxf or .shp.
9
Image Filter Displays background images that you resize. Set this to
Point , Bilinear , or Trilinear . These are methods of
displaying your image on-screen. Use Point when the size
of the image in the display, for example,a 500 x 500 pixel
image at 100% is the same 500 x 500 pixels on-screen.
Use Bilinear or Trilinear when you display your image
on-screen using more or fewer pixels than your image
contains, for example a 500 x 500 pixel image stretched
to 800 x 800 pixels on-screen. Trilinear gives you
smoother transitions when you zoom in and out of the
image.
Transparency Set the transparency level of the background layer. You

can add transparency to any image type you use as a
background and it will ignore any transparency that exists
in the image before you use it as a background.
Resolution Select the clarity for images that are being used as
background images.
Unit Select the unit that should be used.
10
Use Compression If you check this option you can compress the image in
memory so that it takes up less RAM. When checked
there may be a slight color distortion in the image.
Note: The way the image is compressed depends on

your computers video card. Not all video cards
support this feature. If you check this option but your
computers video card does not support image
compression, the request for compression will be
ignored and the image will be loaded uncompressed.
Image Position Table Position the background layer with respect to your
drawing. X/Y Image displays the size of the image you
are using for a background and sets its position with
respect to the origin of your drawing. You cannot change
this data. X/Y Drawing displays where the corners of the
image your are using will be positioned relative to your
drawing. By default, no scaling is used. However, you can
scale the image you are using by setting different
locations for the corners of the image you are importing.
The locations you set are relative to the origin of your
WaterGEMS V8i drawing.
Image Properties
11
image.

background images.
12

{{Bentley HAMMER V8i}} drawing.
Be Communities Search Button
The Be Communities search button allows you to access wikis and forum posts that provide extensive information
about the related program feature and expands upon the online help.
The following dialogs and features offer Be Communities Search functionality:
ModelBuilder Connections Manager
Scenarios Manager
ArcGIS Integration
Default Design Constraints
RSS Feeds
The RSS Feeds dialog displays a continuously updated, customizable, and searchable selection of wiki entries and Be
Communities forum posts.
Search for keywords using the search bar along the top of the dialog.
Sort and filter the displayed content by category using the Filter button at the top of the dialog.
Select the product(s) that you want to see in the RSS feed using the RSS Settings button at the top right of the dialog.
Select the product feeds you are interested in and click the Apply button.
Software Updates via the Web and Bentley SELECT
13
Bentley SELECT is the comprehensive delivery and support subscription program that features product updates and
upgrades via Web downloads, around-the-clock technical support, exclusive licensing options, discounts on training
and consulting services, as well as technical information and support channels. Its easy to stay up-to-date with the
latest advances in our software. Software updates can be downloaded from our Web site, and your version of
WaterGEMS V8i can then be upgraded to the current version quickly and easily. Just click Check for SELECT Updates
on the toolbar to launch your preferred Web browser and open our Web site. You can also access our KnowledgeBase
for answers to your Frequently Asked Questions (FAQs).
Note: Your PC must be connected to the Internet to use the Check for SELECT Updates button.
DXF Properties
The DXF Properties dialog box is where you define a .dxf file as the background layer. In order to open the .dxf
properties, click New File In the Background Layers manager, then select a .dxf file.
Use the following controls to define the properties of the background layer:
Filename Lists the path and filename of the .dxf file to use as a
background layer.
Browse Click to open a dialog box to select the file to be used as a

background layer.
Label Identifies the background layer.
Unit Select the unit associated with the spatial data within the
shapefile, for example, if the X and Y coordinates of the
shapefile represent feet, select ft from the menu.
Transparency Specify the transparency level of the background layer,

where 0 has the least transparency and 100 has the most.
Line Color Sets the color of the layer elements. Click the Ellipsis (...)
button to open a Color palette containing more color
choices. Only when Default Color is not selected.
14
Default Color Use the default line color included in the .dxf file or select
a custom color in the Line Color field by unchecking the
box.
Symbol Choose the symbol that is displayed for each point

element in the .dxf.
Size Sets the size of the symbol for each point element in
the .dxf.
Show Flow Arrows (Stand-Alone)
In the Stand-Alone client flow arrows are automatically displayed after a model has been calculated (by default). You
can also toggle the display of flow arrows on/off using the Show Flow Arrows control in the Properties dialog when
Pipe is highlighted in the Element Symbology manager (see Annotating Your Model).
Application Window Layout
The WaterGEMS V8i application window contains toolbars that provide access to frequently used menu commands
and are organized by the type of functionality offered.
Standard Toolbar
The Standard toolbar contains controls for opening, closing, saving, and printing WaterGEMS V8i projects.
The Standard toolbar is arranged as follows:
To Use
Create a new WaterGEMS V8i project. When you select

this command, the Select File to Create dialog box opens,
allowing you to define a name and directory location for New
the new project.
Open an existing WaterGEMS V8i project. When this

command is initialized, the Select WaterGEMS V8i
Project to Open dialog box opens, allowing you to browse Open
to the project to be opened.
Closes the currently open project.
Close
15
To Use
Close all the projects that are opened.
Close All
Save the current project.
Save
Save all the projects that are opened.
Save All
Open the Print Preview window, displaying the current

view of the network as it will be printed. Choose Fit to
Page to print the entire network scaled to fit on a single Print Preview
page or Scaled to print the network at the scale defined by
the values set in the Drawing tab of the project Options
dialog (Tools > Options). If the model is printed to scale,
it may contain one or more pages (depending on how
large the model is relative to the page size specified in the
Page Settings dialog, which is accessed through the Print
Preview window).
Print the current view of the network. Choose Fit to Page

to print the entire network scaled to fit on a single page or
Scaled to print the network at the scale defined by the Print
values set in the Drawing tab of the project Options
dialog (Tools > Options). If the model is printed to scale,
it may contain one or more pages (depending on how
large the model is relative to the page size specified in the
Page Settings dialog, which is accessed through the Print
Preview window).
Edit Toolbar
The Edit toolbar contains controls for deleting, finding, undoing, and redoing actions in WaterGEMS V8i.
The Edit toolbar is arranged as follows:
16
To Use
Cancel your most recent action.
Undo
Redo the last canceled action.
Redo
Delete the currently selected element(s) from the network.
Delete
Removes the highlighting that can be applied using the

Network Navigator.
Clear Highlight
Find a specific element by choosing it from a menu

containing all elements in the current model.
Find Element
Analysis Toolbar
The Analysis toolbar contains controls for analyzing WaterGEMS V8i projects.
The Analysis toolbar is arranged as follows:
Opens the Post Calculation Processor, which allows you

to perform statistical analysis for an element or elements
on various results obtained during an extended period Post Calculation Processor
simulation calculation.
Opens the Transient Results Viewer dialog, which allows

you to view profile and time-series graph results from
transient simulations. Transient Results Viewer
Opens the Transient Time Step Options dialog, which

shows the time step suggested by HAMMER and the
adjustments to lengths or wavespeeds it requires. Transient Time Step Options
Opens the Transient Thematic Viewer, which allows you

to apply colored highlighting to the pipes and nodes in the
model according to their calculated values for a specified Transient Thematic Viewer
attribute.
17
Open the Totalizing Flow Meters dialog box, which

allows you to view, edit, and create flow meter
definitions. Totalizing Flow Meters
Open the Hydrant Flow Curves dialog box, which allows

you to view, edit, and create hydrant flow definitions.
Hydrant Flow Curves
Open the System Head Curves dialog box, where you can
view, edit, and create system head definitions.
System Head Curves
Open the Post Calculation Processor, where you can

perform statistical analysis for an element or elements on
various results obtained during an extended period Post Calculation Processor
simulation calculation.
Open the Energy Costs dialog box, where you can view,
edit, and create energy cost scenarios.
Energy Costs
Open the Darwin Calibrator dialog box, where you can

view, edit, and create calibration studies.
Darwin Calibrator
Open the Darwin Designer dialog box, where you can

view, edit, and create designer studies.
Darwin Designer
Open the Darwin Scheduler dialog box, where you can

view, edit, and create scheduler studies.
Darwin Scheduler
Open the Criticality dialog box, where you can view, edit,
and create criticality studies.
Criticality
Open the Pressure Zone dialog box, where you can view,
edit, and create pressure zone studies.
Pressure Zone
Scenarios Toolbar
The Scenarios toolbar contains controls for creating scenarios in WaterGEMS V8i projects.
The Scenarios toolbar is arranged as follows:
18
To Use
Change the current scenario.
Scenario List Box
Open the Scenario manager, where you can create, view,

and manage project scenarios.
Scenarios
Open the Alternative manager, where you can create,

view, and manage project alternatives.
Alternatives
Open the Calculation Options manager, where you can

create different profiles for different calculation settings.
Calculation Options
Compute Toolbar
The Compute toolbar contains controls for computing WaterGEMS V8i projects.
The Compute toolbar contains the following:
To Use
Run a diagnostic check on the network data to alert you to

possible problems that may be encountered during
calculation. This is the manual validation command, and Validate
it checks for input data errors. It differs in this respect
from the automatic validation that WaterGEMS V8i runs
when the compute command is initiated, which checks for
network connectivity errors as well as many other things
beyond what the manual validation checks.
Allows you to establish the initial conditions for the

transient simulation.
Compute Initial Conditions
Calculate the network. Before calculating, an automatic

validation routine is triggered, which checks the model
for network connectivity errors and performs other Compute
validation.
Open the Fire Flow Results Browser dialog box.
Fire Flow Results Browser
Open the Flushing Results Browser dialog box.
Flushing Results Browser
19
To Use
Open the Calculation Summary dialog box.
Calculation Summary
Open the Transient Calculation Summary dialog box.
Transient Calculation Summary
Open the User Notifications Manager, allowing you to

view warnings and errors uncovered by the validation
process. This button does not appear in the toolbar by User Notifications
default but can be added
View Toolbar
The View toolbar contains controls for viewing WaterGEMS V8i projects.
The View toolbar contains the following:
To Use
Open the Element Symbology manager, allowing you to

create, view, and manage the element symbol settings for
the project. Element Symbology
Open the Background Layers manager, allowing you to

create, view, and manage the background layers
associated with the project. Background Layers
Open the Network Navigator dialog box.
Network Navigator
Open the Selection Sets Manager, allowing you to create,

view, and modify the selection sets associated with the
project. Selection Sets
Opens the Query Manager.
Queries
Opens the Prototypes Manager.
Prototypes
20
To Use
Open the FlexTables manager, allowing you to create,

view, and manage the tabular reports for the project.
FlexTables
Open the Graph manager, allowing you to create, view,

and manage the graphs for the project.
Graphs
Open the Profile manager, allowing you to create, view,

and manage the profiles for the project.
Profiles
Open the Contour Manager where you can create, view,

and manage contours.
Contours
Open the Named Views manager where you can create,

view, and manage named views.
Named Views
Open the Aerial View manager where you can zoom to

different elements in the project.
Aerial View
Opens the Property Editor.
Properties
Opens the Property Grid Customizations manager.
Property Grid Customizations
Help Toolbar
The Help toolbar provides quick access to the some of the commands that are available in the Help menu.
The Help toolbar contains the following:
To Use
Open your Web browser to the SELECTservices page on

the Bentley Web site.
Check for SELECT Updates
21
To Use
Open the Bentley Institute page on the Bentley Web site.
Bentley Institute Training
Open your Web browser to the SELECTservices page on

the Bentley Web site.
Bentley SELECT Support
Opens your web browser to the Bentley.com Web sites

main page.
Bentley.com
Opens the WaterGEMS V8i online help.
Help
Text Styles
You can view, edit, and create Text Style settings in the MicroStation environment by clicking the MicroStation
Element menu and selecting the Text Styles command to open the Text Styles dialog.
Tools Toolbar
The Tools toolbar provides quick access to the same commands that are available in the Tools menu.
The Tools toolbar contains the following:
To Use
Open a Select dialog to select areas in the drawing.
Active Topology Selection
Open the ModelBuilder Connections Manager, where you

can create, edit, and manage ModelBuilder connections to
be used in the model-building/model-synchronizing ModelBuilder
process.
Open the TRex wizard where you can select the data
source type, set the elevation dataset, choose the model
and features. Trex
22
To Use
Open the SCADAConnect manager where you can add or

edit signals.
SCADAConnect
Open the Skelebrator manager to define how to

skeletonize your network.
Skelebrator Skeletonizer
Open the LoadBuilder manager where you can create and

manage Load Build templates.
Load Builder
Open the Wizard used to create a Thiessen polygon.
Thiessen Polygon
Open the Demand Control Center manager where you can

add new demands, delete existing demands, or modify
existing demands. Demand Control Center
Open the Unit Demand Control Center manager where

you can add new unit demands, delete existing unit
demands, or modify existing unit demands. Unit Demand Control Center
Opens the Scenario Comparison window, which enables

you to compare input values between any two scenarios to
identify differences quickly. Scenario Comparison
Associate external files, such as pictures or movie files,

with elements.
Hyperlinks
Open the User Data Extension dialog box, which allows

you to add and define custom data fields. For example,
you can add new fields such as the pipe installation date. User Data Extensions
Compact the database, which eliminates the empty data

records, thereby defragmenting the datastore and
improving the performance of the file. Compact Database
Synchronize the current model drawing with the project

database.
Synchronize Drawing
Ensures consistency between the database and the model

by recalculating and updating certain cached information.
Normally this operation is not required to be used. Update Database Cache
23
To Use
This command copies the model result files (if any) from
the project directory (the directory where the
project .sqlite file is saved) to the working temp location Update Results from Project Directory
for WaterGEMS V8i (%temp%\Bentley\ WaterGEMS
V8i). This allows you to make a copy of the results that
may exist in the model's save directory and replace the
current results being worked on with them.
This command copies the result files that are currently

being used by the model to the project directory (where
the project .sqlite is stored). Copy Results to Project Directory
Open a Batch Assign Isolation Valves window where you

can find the nearest pipe for each selected isolation and
assign the valve to that pipe. Assign Isolation Valves to Pipes
Opens the Batch Pipe Split dialog.
Batch Pipe Split
Opens the Batch Morph dialog.
Batch Morph
Open the External Tools dialog box.
Customize
Open the Options dialog box, which allows you to change

Global settings, Drawing, Units, Labeling, and
ProjectWise. Options
Zoom Toolbar
The Zoom toolbar provides access to the zooming and panning tools.
The Zoom toolbar contains the following:
To Use
Set the view so that the entire model is visible in the

drawing pane.
Zoom Extents
24
To Use
Activate the manual zoom tool, where you can specify a

portion of the drawing to enlarge.
Zoom Window
Magnify the current view in the drawing pane.

Zoom In
Reduce the current view in the drawing pane.

Zoom Out
Enable the realtime zoom tool, which allows you to zoom

in and out by moving the mouse while the left mouse
button is depressed. Zoom Realtime
Open up the Zoom Center dialog box where you can set X
and Y coordinates and the percentage of Zoom.
Zoom Center
Enable you to zoom to specific elements in the drawing.

You must select the elements to zoom to before you select
the tool. Zoom Selection
Return the zoom level to the most recent previous setting.

Zoom Previous
Reset the zoom level to the setting that was active before
a Zoom Previous command was executed. This button
also does not appear in the Zoom toolbar by default. Zoom Next
Activate the Pan tool, which allows you to move the

model within the drawing pane. When you select this
command, the cursor changes to a hand, indicating that Pan
you can click and hold the left mouse button and move
the mouse to move the drawing.
Update the main window view according to the latest

information contained in the WaterGEMS V8i datastore.
Refresh Drawing
Customizing WaterGEMS V8i Toolbars and Buttons

Toolbar buttons represent Bentley WaterGEMS V8i menu commands. Toolbars can be controlled in Bentley
WaterGEMS V8i using View > Toolbars. You can turn toolbars on and off, move the toolbar to a different location in
the work space, or you can add and remove buttons from any toolbar.
25
To turn toolbars on
Click View > Toolbars, then click in the space to the left of the toolbar you want to turn on.
To turn toolbars off
Click View >Toolbars, the click the check mark next to the toolbar you want to turn off.
To move a toolbar to a different location in the workspace
Move your mouse to the vertical dotted line on the left side of any toolbar, then drag the toolbar to the desired location.
If you move a toolbar away from the other toolbar, the toolbar becomes a floating dialog box.
To add or remove a button from a toolbar
1. Click the down arrow on the end of the toolbar you want to customize. A series of submenus appear, allowing you
to select or deselect any icon in that toolbar.
2. Click Add or Remove Buttons then move the mouse cursor to the right until all of the submenus appear, as shown
as follows:
3. Click the space to left of the toolbar button you want to add. A check mark is visible in the submenu and the button
opens in the toolbar.
or
Click the check mark next to the toolbar button you want to remove. The button will no longer appear in the toolbar.
26
Understanding the Workspace
WaterObjects Help for Model Users

Click the links below to learn about the WaterGEMS V8i workspace:
Stand-Alone
The Stand-Alone Editor is the workspace that contains the various managers, toolbars, and menus, along with the
drawing pane, that make up the WaterGEMS V8i interface. The WaterGEMS V8i interface uses dockable windows and
toolbars, so the position of the various interface elements can be manually adjusted to suit your preference.
The Drawing View

You change the drawing view of your model by using the pan tool or one of the zoom tools:
Panning
You can change the position of your model in the drawing pane by using the Pan tool.
To use the Pan tool:

1. Click the Pan button on the Tools toolbar.
2. The mouse cursor changes to the Pan icon.
3. Click anywhere in the drawing, hold down the mouse button and move the mouse to reposition the current view.
or
If your mouse is equipped with a mousewheel, you can pan by simply holding down the mousewheel and moving the
mouse to reposition the current view.
or
Select View > Pan, then click anywhere in the drawing, hold down the mouse button and move the mouse to reposition
the current view
Related Topics
Zooming (on page 28)
Using the Zoom Center Command
27
Zooming
You can enlarge or reduce your model in the drawing pane using one of the following zoom tools:
Zoom In and Out
The simple Zoom In and Zoom Out commands allow you to increase or decrease, respectively, the zoom level of the
current view by one step per mouse click.
To use Zoom In or Zoom Out, click the desired button on the Tools toolbar, or select View > Zoom > Zoom In or View
> Zoom > Zoom In.
If your mouse is equipped with a mousewheel, you zoom in or out by simply moving the mousewheel up or down
respectively.
Zoom Window
The Zoom Window command lets you zoom in on an area of your model defined by a window that you draw in the
drawing pane.
To use Zoom Window, select View > Zoom > Zoom Window button, then click and drag the mouse inside the drawing
pane to draw a rectangle. The area of your model inside the rectangle will appear enlarged.
Note: If you use the Zoom Window command frequently, you might find it more convenient to add them to the
Tools toolbar. See Customizing Bentley WaterGEMS V8i Toolbar and Buttons (on page 25) for more information.
Zoom Extents
The Zoom Extents command automatically sets the zoom level such that the entire model is displayed in the drawing
pane.
To use Zoom Extents, click the Zoom Extents button on the Tools toolbar. The entire model is displayed in the drawing
pane.
28
or
Select View > Zoom > Zoom Extents.
Zoom Realtime
The Zoom Realtime command lets you dynamically scale up and down the zoom level. The zoom level is defined by
the magnitude of mouse movement while the tool is active.
Zoom Previous and Zoom Next
Zoom Previous returns the zoom level to the most recent previous setting. To use Zoom Previous, click the Zoom
Previous button on the Tools toolbar.
or
Select View > Zoom > Zoom Previous.
Zoom Next returns the zoom level to the setting that was active before a Zoom Previous command was executed. To
use Zoom Previous, click View > Zoom > Zoom Next.
Note: If you use the Zoom Next command frequently, you might find it more convenient to add them to the Tools
toolbar. See Customizing Bentley WaterGEMS V8i Toolbar and Buttons (on page 25) for more information.
Related Topics
Panning (on page 27)
Using the Zoom Center Command
Zoom Dependent Visibility
Available through the Properties dialog box of each layer in the Element Symbology manager, the Zoom Dependent
Visibility feature can be used to cause elements, decorations, and annotations to only appear in the drawing pane when
the view is within the zoom range specified by the Minimum and Maximum Zoom values.
29
By default, Zoom Dependent Visibility is turned off. To turn on Zoom Dependent Visibility, highlight a layer in the
Element Symbology Manager. In the Properties window, change the Enabled value under Zoom Dependent Visibility
to True. The following settings will then be available:
Enabled Set to true to enable and set to false to disable Zoom

Dependent Visibility.
30
Zoom Out Limit (%) The minimum zoom level, as a percent of the default
zoom level used when creating the project, at which
objects on the layer will appear in the drawing. The
current zoom level is displayed in the lower right hand
corner of the interface, next to the coordinate display.
You can also set the current zoom level as the minimum
by right-clicking a layer in the Element Symbology
manager and selecting the Set Minimum Zoom command.
The zoom out limit is especially important in GIS style
symbology because the symbols and text can become
very large. (As you zoom out, the Zoom Level as a
percent decreases. Once it drops below the zoom out
limit, the objects will no longer appear.)
Zoom In Limit (%) The maximum zoom level, as a percent of the default
zoom level used when creating the project, at which
objects on the layer will appear in the drawing. The
current zoom level is displayed in the lower right hand
corner of the interface, next to the coordinate display.
You can also set the current zoom level as the maximum
by right-clicking a layer in the Element Symbology
manager and selecting the Set Maximum Zoom
command. The zoom in limit is especially important in
CAD style symbology because the symbols and text can
become very large. (As you zoom in, the Zoom Level as a
percent increases. Once it exceeds the zoom in limit, the
objects no longer appear.)
Apply to Element Set to true to apply the zoom minimums and maximums
to the symbols in the drawing.
Apply to Decorations Set to true to apply the zoom minimums and maximums
to flow arrows, check valves, and constituent sources in
the drawing.
Apply to Annotations Set to true to apply the zoom minimums and maximums
to labels in the drawing.
The numerical value for zoom out limit should be smaller than zoom in limit or else the element will not be visible at
all.
The current zoom level is displayed at the bottom right of the drawing.
Drawing Style
Elements can be displayed in one of two styles in the Stand-Alone version; GIS style or CAD style.
Using GIS style, the size of element symbols in the drawing pane will remain the same (relative to the screen)
regardless of zoom level. Using CAD style, element symbols will appear larger or smaller (relative to the drawing)
depending on zoom level.
31
There is a default Drawing Style that is set on the Global tab of the Options dialog. The drawing style chosen there will
be used by all elements by default. Changing the default drawing style will only affect new projects, not existing ones.
You can change the drawing style used by all of the elements in the project, or you can set each element individually to
use either drawing style.
To change a single element's drawing style:
1. Double-click the element in the Element Symbology manager dialog to open the Properties manager.
2. In the Properties manager, change the value in the Display Style field to the desired setting.
To change the drawing style of all elements:
Click the Drawing Style button in the Element Symbology manager and select the desired drawing style from the
submenu that appears.
Using Aerial View

The Aerial View is a small navigation window that provides a graphical overview of your entire drawing. You can
toggle the Aerial View window on or off by selecting View > Aerial View to open the Aerial View window.
A Navigation Rectangle is displayed in the Aerial View window. This Navigation Rectangle provides a you-are-here
indicator showing you current zoom location respective of the overall drawing. As you pan and zoom around the
drawing, the Navigation Rectangle will automatically update to reflect your current location.
You can also use the Aerial View window to navigate around your drawing. To pan, click the Navigation Rectangle to
drag it to a new location. To zoom, click anywhere in the window to specify the first corner of the Navigation
Rectangle, and click again to specify the second corner.
In the AutoCAD environment, see the AutoCAD online help for a detailed explanation.
In Stand-Alone environment, with Aerial View window enabled (by selecting the View > Aerial View), click and drag
to draw a rectangular view box in the aerial view. The area inside this view box is displayed in the main drawing
window. Alternately, any zooming or panning action performed directly in the main window updates the size and
location of the view box in the Aerial View window.
The Aerial View window contains the following buttons:
Zoom ExtentsDisplay the entire drawing in the Aerial View window.
Zoom InDecrease the area displayed in the Aerial View window.
Zoom OutIncrease the area displayed in the Aerial View window.
32
HelpOpens the online help.

To resize the view box directly from the Aerial View window, click to define the new rectangular view box. To change
the location of the view box, hover the mouse cursor over the current view rectangle and click to drag the view box
frame to a new location.
Using Background Layers

Use background layers to display pictures behind your network. For example, you might want to display a picture of a
neighborhood behind your network, so you can relate elements in your network to structures and roads depicted in the
picture. You can add, delete, edit and rename background layers in the Background Layers Manager.
You can add multiple pictures to your project for use as background layers, and turn off the ones you don't want to
show and turn on those you do. Additionally, you can create groups of pictures in folders, so you can hide or show an
entire folder or group of pictures at once.
To add or delete background layers, open the Background Layers manager: click View > Background Layers (Ctrl+2).
You can use shapefiles, AutoCAD DXF files, and raster (also called bitmap) pictures as background images for your
model. These raster image formats are supported: bmp, jpg, jpeg, jpe, jfif, gif, tif, tiff, png, and sid.
Click one of the following links to learn more about using background layers:
Background Layer Manager
Working with Background Layer Folders
Adding Background Layers
Deleting Background Layers
Editing Background Layers
Renaming Background Layers
Turning Background Layers On and Off
Image Properties Dialog Box
Shapefile Properties Dialog Box
DXF Properties Dialog Box
Image Properties
33
image.

background images.
34

WaterGEMS V8i drawing.
Shapefile Properties
Use the Shapefile Properties dialog box to define a shapefile background layer. In order to access the Shapefile
Properties dialog box, click New File in the Background Layers manager, then select a .shp file.
Filename Lists the path and filename of the shapefile to use as a

background layer.
Browse Opens a browse dialog box, to select the file to be used as

a background layer.
35
Unit Select the unit of measurement associated with the spatial

data from the menu.

where 0 has the least and 100 has the most transparency.
choices.
Line Width Sets the thickness of the outline of the layer elements.
Fill Color Select the fill color.
Fill Figure Check to fill.
DXF Properties
The DXF Properties dialog box is where you define a .dxf file as the background layer. In order to open the .dxf
properties, click New File In the Background Layers manager, then select a .dxf file.
Filename Lists the path and filename of the .dxf file to use as a
background layer.
Browse Click to open a dialog box to select the file to be used as a

background layer.
Unit Select the unit associated with the spatial data within the
shapefile, for example, if the X and Y coordinates of the
shapefile represent feet, select ft from the menu.
36

where 0 has the least transparency and 100 has the most.
choices. Only when Default Color is not selected.
Default Color Use the default line color included in the .dxf file or select
a custom color in the Line Color field by unchecking the
box.
Symbol Choose the symbol that is displayed for each point

element in the .dxf.
Size Sets the size of the symbol for each point element in
the .dxf.
Show Flow Arrows (Stand-Alone)

In the Stand-Alone client flow arrows are automatically displayed after a model has been calculated (by default). You
can also toggle the display of flow arrows on/off using the Show Flow Arrows control in the Properties dialog when
Pipe is highlighted in the Element Symbology manager (see Annotating Your Model (on page 705)).
ArcGIS Mode
ArcGIS mode lets you create and model your network directly in ArcMap. Each mode provides access to differing
functionalitycertain capabilities that are available within ArcGIS mode may not be available when working in the
Bentley WaterGEMS V8i Stand-alone Editor. All the functionality available in the Stand-alone Editor are, however,
available in ArcGIS mode.
MicroStation Environment
The MicroStation environment includes:
Getting Started in the MicroStation environment

A Bentley MicroStation WaterGEMS V8iproject consists of:
Drawing File (.DGN)The MicroStation drawing file contains the elements that define the model, in addition to
the planimetric base drawing information that serves as the model background.
Model File(.wtg)The model file contains model data specific to WaterGEMS V8i, including project option
settings, color-coding and annotation settings, etc. Note that the MicroStation .dgn that is associated with a
particular model may not necessarily have the same filename as the models .wtg file.
Database File (.sqlite)The model database file that contains all of the input and output data for the model. Note
that the MicroStation .dgn that is associated with a particular model may not have the same filename as the
models .sqlite file.
When you start WaterGEMS V8i for MicroStation, you will see the dialog below. You must identify a new or existing
MicroStation dgn drawing file to be associated with the model before you can open a WaterGEMS V8i model.
37
Either browse to an existing dgn file or create a new file using the new button on the top toolbar. Once you have
selected a file, you can pick the Open button.
Once a drawing is open, you can use the WaterGEMS V8i Project drop down menu to create a new WaterGEMS V8i
project, attach an existing project, or import a project.
There are a number of options for creating a model in the MicroStation client:
Create a model from scratchYou can create a model in MicroStation. You'll first need to create a new
MicroStation .dgn (refer to your MicroStation documentation to learn how to create a new .dgn). Start WaterGEMS
V8i for MicroStation. In the first dialog, pick the New button and assign a name and path to the DGN file. Once the
dgn is open, use the New command in the WaterGEMS V8iProject menu (Project > New). This will create a new
WaterGEMS V8i project file and attach it to the Bentley MicroStation .dgn file. Once the file is created you can
start creating WaterGEMS V8i elements that exist in both the WaterGEMS V8i database and in the .dgn drawing.
See Working with Elements and Working with Elements Using MicroStation Commands for more details.
Open a previously created WaterGEMS V8i projectYou can open a previously created WaterGEMS V8i model
and attach it to a .dgn file. To do this, start WaterGEMS V8i for MicroStation. Open or create a new
MicroStation .dgn file (refer to your MicroStation documentation to learn how to create a new .dgn). Use the Project
menu on the WaterGEMS V8i toolbar and click on the Project > "Attach Existing" command, then select an
existing WaterGEMS V8i.wtg file. The model will now be attached to the .dgn file and you can edit, delete, and
modify the WaterGEMS V8i elements in the model. All MicroStation commands can be used on WaterGEMS V8i
elements.
Import a model that was created in another modeling applicationThere are four types of files that can be imported
into WaterGEMS V8i:
WaterGEMS / WaterCAD / HAMMER Databasethis can either be a HAMMER V8i or V8, WaterGEMS V8i or
V3, or WaterCAD V8i or V7 database. The model will be processed and imported into the active MicroStation .dgn
drawing. See Exporting a HAMMER v7 Model for more details.
EPANETYou can import EPANET input (.inp) files. The file will be processed and the proper elements will be
created and added to the MicroStation drawing. See Importing and Exporting EPANET Files for more details.
SubmodelYou can import a WaterGEMS V8i subenvironment into the MicroStation drawing file. See Importing
and Exporting Submodel Files for more details.
If you want to trace the model on top of a dgn or other background file, you would load the background into the dgn
first by using either File/Reference or File/Raster Manager Then you start laying out elements over top of the
background.
38
MicroStation Mode Graphical Layout

In the MicroStation environment, our products provide a set of extended options and functionality beyond those
available in stand-alone environment. This additional functionality provides enhanced control over general application
settings and options and extends the command set, giving you control over the display of model elements within
MicroStation.
It is important to be aware that there are two lists of menu items when running WaterGEMS V8i in MicroStation:
1. MicroStation menu (File Edit Element Settings ...) which contains MicroStation commands. The MicroStation menu
contains commands which affect the drawing.
2. WaterGEMS V8i menu (Project Edit Analysis ...) which contains WaterGEMS V8i commands. The WaterGEMS
V8i menu contains commands which affect the hydraulic analysis.
It is important to be aware of which menu you are using.
Key differences between MicroStation and stand-alone environment include:
Full element symbol editing functionality is available through the use of custom cells. All elements and graphical
decorations (flow arrows, control indicators, etc.) are contained within a WaterGEMS V8i.cel file.To do this open
the .cel file that's in the WTRG install directory in MSTN (at the first, Open dialog), and then using the File>models
you can select each of the WTRG symbols and change them using normal MSTN commands. Then when you create
a new dgn and start laying out the WTRG elements, the new symbols will be used.
The more powerful Selection tools are in the MicroStation select menu.
Element symbols like junction are circles that are not filled. The user must pick the edge of the circle, not inside the
circle to pick a junction.
The MicroStation background color is found in Workspace>Preferences>View Options. It can also be changed in
Settings>Color Tab.
Zooming and panning are controlled by the MicroStation zooming and panning tools.
Depending on how MicroStation was set up, a single right click will simply clear the last command, while holding
down the right mouse button will bring up the context sensitive menu. There are commands in that menu (e.g.
rotate) that are not available in WaterGEMS V8i stand alone.
You can control the appearance and destination of all model elements using the Element Levels command under the
View menu. For example, you can assign a specific level for all outlets, as well as assign the label and annotation text
style to be applied. Element attributes are either defined by the MicroStation Level Manager, using by-level in the
attributes toolbox, or by the active attributes. You can change the element attributes using the change element attributes
tool, located in the change attributes toolbox, located on the MicroStation Main menu.
WaterGEMS V8i toolbars are turned off by default when you start. They are found under View>Toolbars and they can
be turned on. By default they will be floating toolbars but they can be docked wherever the user chooses.
Note: Any MicroStation tool that deletes the target element (such as Trim and IntelliTrim) will also remove the
connection of that element to WaterGEMS V8i. After the WaterGEMS V8i connection is removed, the element is
no longer a valid wtg link element and will not show properties on the property grid. The element does not have
properties because it is not part of the WTRG model. It's as if the user just used MSTN tools to layout a rectangle
in a WTRG dgn. It's just a dgn drawing element but has nothing to do with the water model.
MicroStation Project Files
39
When using WaterGEMS V8i in the MicroStation environment, there are three files that fundamentally define a
WaterGEMS V8i model project:
Drawing File (.DGN)The MicroStation drawing file contains the elements that define the model, in addition to
Model File(.wtg)The model file contains model data specific to WaterGEMS V8i, including project option
settings, color-coding and annotation settings, etc. Note that the MicroStation .dgn that is associated with a
particular model may not have the same filename as the models .wtg file.
Database File (.sqlite)The model database file that contains all of the input and output data for the model. Note
that the MicroStation .dgn that is associated with a particular model may not have the same filename as the
models .sqlite file.
To send the model to another user, all three files are required.
It is important to understand that archiving the drawing file is not sufficient to reproduce the model. You must also
preserve the associated .wtg and .sqlite files.
Saving Your Project in MicroStation

The WaterGEMS V8i project data is synchronized with the current MicroStation .dgn. WaterGEMS V8i project saves
are triggered when the .dgn is saved. This is done with the MicroStation File>Save command, which saves
the .dgn, .sqlite and .wtg files. If you want to have more control over when the WaterGEMS V8i project is saved, turn
off MicroStation's AutoSave feature; then you will be prompted for the .dgn.
There are two File>Save As commands in MicroStation. SaveAs in MSTN is for the dgn, and allows the user to, for
example, change the dgn filename that they're working with .wtg model filenames in this case stay the same. The
Project's SaveAs allows the user to change the filename of the .wtg and .sqlite files, but it doesn't change the dgn's
filename. Keep in mind that the dgn and model filenames don't have any direct correlation. They can be named the
same, but they don't have to be.
Bentley WaterGEMS V8i Element Properties

Bentley WaterGEMS V8i element properties includes:
Element Properties
When working in the MicroStation environment, this feature will display a dialog box containing fields for the
currently selected elements associated properties. To modify an attribute, click each associated grid cell. To open the
property grid, pick View>Properties from the WaterGEMS V8i menu.
You can also review or modify MicroStation drawing information about an element(s), such as its type, attributes, and
geometry, by using the Element Information dialog. To access the Element Information dialog, click the Element
Information button or click the Element menu and select the Information command. This is where the user can change
the appearance for individual elements. However, in general, if WaterGEMS V8i color coding conflicts with
MicroStation element symbology, the WaterGEMS V8i color will show.
To control display of elements in the selected levels, use the Level Display dialog box. To access the Level Display
dialog, click the Settings menu and select the Level > Display command.
To move WaterGEMS V8i elements to levels other than the default (Active) level, select the elements and use the
Change Element Attribute command.
If you want to freeze elements in levels, select Global Freeze from the View Display menu in the Level Display dialog.
40
You can create new Levels in the Level Manager. To access the Level Manager, click the Settings menu and select the
Level > Manager command.
To control the display of levels, use level filters. Within MicroStation, you can also create, edit, and save layer filters to
DWG files in the Level Manager. To access the Level Manager, click the Settings menu and select the Level >
Manager command. Layer filters are loaded when a DWG file is opened, and changes are written back when the file is
saved. To create and edit Level Filters,
Element Levels Dialog

This dialog allows you to assign newly created elements and their associated annotations to specific MicroStation
levels.
To assign a level, use the pulldown menu next to an element type (under the Element Level column heading) to choose
the desired level for that element. You can choose a seperate level for each element and for each elements associated
annotation.
You cannot create new levels from this dialog; to create new levels use the MicroStation Level Manager. To access the
Level Manager, click the Settings menu and select the Level > Manager command.
Text Styles
You can view, edit, and create Text Style settings in the MicroStation environment by clicking the MicroStation
Element menu and selecting the Text Styles command to open the Text Styles dialog.
View Associations (MicroStation Only)

To open the View Associations dialog, click View > View Associations.
MicroStation has support for opening multiple View windows on the current design drawing. By default, each
MicroStation View reflects the current Scenario and the current Symbology Definition. View Associations allows you
to control the Scenario and Symbology Definition to display in each MicroStation View.
41
The View Associations window allows you to see (and change) the Symbology Definition and Scenario associated with
each MicroStation View.
Located along the top of the window are two toolbars buttons for controlling the view association mode:
The first toolbar button controls the Symbology Definition mode, and the second controls the Scenario mode.
View Associations provides two modes: Synchronized mode and Independent mode.
Synchronized mode: In Synchronized mode, all Views reflect the active Scenario and active Symbology-Definition. If
you change the active Scenario, all views will update to reflect that change; similar for a change to the active
Symbology Definition. A small padlock symbol ( ) will appear on the icon to indicate if Synchronized mode is active.
Independent mode: Independent mode allows you to independently control which Scenario and Symbology definition
are shows in each view. You can show one Scenarion\Symbology Definition on one view, and different Scenarios
\Symbology Definition combingation in the other views.
Note: The default setting for View Associations (for Scenarios and Symbology-Definitions) is "Synchronized"
mode. Scenarios and Symbology definition modes can each be controlled separately.
For convenience, these same mode toolbar buttons are available at the top of the Scenario management Window and
the Element Symbology management window. Changes to current Scenario and current Symbology Definition will be
applied to the active MicroStation View (for synchronized mode, changes you make will be reflected in all Views).
See also:
Annotating Your Model (on page 705)
Symbology Definitions Manager (on page 707)
Scenarios Manager (on page 362)
Working with Elements

Working with elements includes:
Edit Elements
Elements can be edited in one of two ways in the MicroStation environment:
Properties Editor Dialog: To access the Properties Editor dialog, click the WaterGEMS V8i View menu and select the
Properties command. For more information about the Properties Editor dialog, see Property Editor (on page 189).
FlexTables: To access the FlexTables dialog, click the WaterGEMS V8i View menu and select the FlexTables
command. For more information about the FlexTables dialog, see Viewing and Editing Data in FlexTables (on page
721).
Deleting Elements
In the MicroStation environment, you can delete elements by clicking on them using the Delete Element tool, or by
highlighting the element to be deleted and clicking your keyboards Delete key.
42
Note: Any MicroStation tool that deletes the target element (such as Trim and IntelliTrim) will also remove the
connection of that element to WaterGEMS V8i. After the WaterGEMS V8i connection is removed, the element is
no longer a valid wtg link and will not show properties on the property grid.
Modifying Elements
In the MicroStation environment, these commands are selected from the shift-right-click shortcut menu (hold down the
Ctrl key while right-clicking). They are used for scaling and rotating model entities.
Context Menu
Certain commands can be activated by using the right-click context menu. To access the context menu, right-click and
hold down the mouse button until the menu appears.
Working with Elements Using MicroStation Commands

Working with elements using MicroStation commands includes:
Bentley WaterGEMS V8i Custom MicroStation Entities

The primary MicroStation-based Bentley WaterGEMS V8i element entities are all implemented using native
MicroStation elements (the drawing symbols are standard MSTN objects).These elements have feature linkages to
define them as WaterGEMS V8i objects.
This means that you can perform standard MicroStation commands (see MicroStation Commands) as you normally
would, and the model database will be updated automatically to reflect these changes.
It also means that the model will enforce the integrity of the network topological state, which means that nodes and
pipes will remain connected even if individual elements are moved. Therefore, if you delete a nodal element such as a
junction, its connecting pipes will also be deleted since their connecting nodes topologically define model pipes.
Using MDL technology ensures the database will be adjusted and maintained during Undo and Redo transactions.
See The MicroStation Environment Graphical Layout. (on page 39)
MicroStation Commands
When running in the MicroStation environment, WaterGEMS V8i makes use of all the advantages that MicroStation
has, such as plotting capabilities and snap features. Additionally, MicroStation commands can be used as you would
with any design project. For example, our products elements and annotation can be manipulated using common
MicroStation commands. To get at the MicroStation command line (called the "Key-In Browser, the user can pick
Help>Key-In Browser or hit the Enter key.
Moving Elements
When using the MicroStation environment, the MicroStation commands Move, Scale, Rotate, Mirror, and Array (after
right clicking on the label ) can be used to move elements.
43
To move a node, execute the MicroStation command by either typing it at the command prompt or selecting it. Follow
the MicroStation prompts, and the node and its associated label will move together. The connecting pipes will shrink or
stretch depending on the new location of the node.
Moving Element Labels

When using the MicroStation environment, the MicroStation commands Move, Scale, Rotate, Mirror, and Array can be
used to move element text labels.
To move an element text label separately from the element, click the element label you wish to move. The grips will
appear for the label. Execute the MicroStation command either by typing it at the command prompt, by selecting it
from the tool palette, or by selecting it from the right-click menu. Follow the MicroStation prompt, and the label will be
moved without the element.
Snap Menu
When using the MicroStation environment, you can enable the Snaps button bar by clicking the Settings menu and
selecting the Snaps > Button Bar command. See the MicroStation documentation for more information about using
snaps.
Background Files
Adding MicroStation Background images is different than in stand alone. You need to go to
File>References>Tools>Attach. Background files to be attached with this command include .dgn, .dwg and .dxf files.
Raster files should be attached using File>Raster Manager. GIS files (e.g. shapefiles) may need to be converted to the
appropriate CAD or raster formats using GeoGraphics to be used as background. See MicroStation for details about the
steps involved in creating these backgrounds.
Import WaterGEMS
When running WaterGEMS in MicroStation mode, this command imports a selected WaterGEMS data (.csd) file for
use in the current drawing. The new project file will now correspond to the drawing name, such as,
CurrentDrawingName.csd.
A WaterGEMS Project can only be imported to a new, empty MicroStation design model.
Annotation Properties
Use the Annotation Properties dialog box to define annotation settings for each element type.
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.
44
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
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.
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.
Multiple models
45
You can have two or more WaterGEMS V8i models open in MicroStation. However, you need to open them in
MicroStation, not in wtg. In MicroStation choose File > Open and select the .dgn file.
Native Format Contours

WaterGEMS V8i can export contours as native-format Microstation contours. This feature behaves differently
depending on whether or not the original model is 2 or 3 dimensional. Since the native contours are 3-dimensional
elements they dont display properly in a 2-d model and reference attachments are created and added to the model.
In a 2-d source model the contours are created in their own 3-d model, which is referenced to the default model. In
order to manipulate the contours you'll need to activate the respective model, then make any modifications, then switch
back. On the same token, in order to delete the contours you need to delete the model that they're actually a part of.
In a 3-d source model the contours are added directly to the model, and all manipulations can be done directly in the
main drawing.
Note: This feature is only available to users of MicroStation SS3 and higher.
Working in AutoCAD Mode
Caution! If you previously installed Bentley ProjectWise and turned on AutoCAD integration, you must add the
following key to your system registry using the Windows Registry Editor. Before you edit the registry, make a backup
copy.
HKEY_LOCAL_MACHINE\SOFTWARE\Bentley\ProjectWise iDesktop Integration\XX.XX\Configuration
\AutoCAD
String value name: DoNotChangeCommands
Value: 'On'
To access the Registry Editor, click Start > Run, then type regedit. Using the Registry Editor incorrectly can cause
serious, system-wide problems that may require you to re-install Windows to correct them. Always make a backup
copy of the system registry before modifying it.
The AutoCAD functionality has been implemented in a way that is the same as the base product. Once you become
familiar with the stand-alone mode, you will not have any difficulty using the product in AutoCAD mode.
Some of the advantages of working in AutoCAD mode include:
Layout network links and structures in fully-scaled mode in the same design and drafting environment that you use
to develop your engineering plans. You will have access to any other third party applications that you currently use,
along with any custom LISP, ARX, or VBA applications that you have developed.
Use native AutoCAD insertion snaps to precisely position WaterGEMS V8i elements with respect to other entities
in the AutoCAD drawing.
Use native AutoCAD commands such as ERASE, MOVE, and ROTATE on WaterGEMS V8i model entities with
automatic update and synchronization with the model database.
Control destination layers for model elements and associated label text and annotation, giving you control over
styles, line types, and visibility of model elements.
Click one of the following links to learn how to use AutoCAD mode:
46
The AutoCAD Workspace

In the AutoCAD environment, you will have access to the full range of functionality available in the AutoCAD design
and drafting environment. The standard environment is extended and enhanced by an AutoCAD ObjectARX
WaterGEMS V8i client layer that lets you create, view, and edit the native WaterGEMS V8i network model while in
AutoCAD.
AutoCAD Integration with WaterGEMS V8i

When you install WaterGEMS V8i after you install AutoCAD, integration between the two is automatically configured.
If you install AutoCAD after you install WaterGEMS V8i, you must manually integrate the two by selecting Start > All
Programs > Bentley > WaterGEMS V8i > Integrate WaterGEMS V8i with ArcGIS-AutoCAD-MicroStation. The
integration utility runs automatically. You can then run WaterGEMS V8i in the AutoCAD environment.
The Integrate WaterGEMS V8i with AutoCAD-ArcGIS command can also be used to fix problems with the AutoCAD
configuration file. For example, if you have CivilStorm installed on the same system as Bentley WaterGEMS V8i and
you uninstall or reinstall CivilStorm, the AutoCAD configuration file becomes unusable. To fix this problem, you can
delete the configuration file then run the Integrate WaterGEMS V8i with AutoCAD-ArcGIS command.
Getting Started within AutoCAD

There are a number of options for creating a model in the AutoCAD client:
Create a model from scratchYou can create a model in AutoCAD. Upon opening AutoCAD a Drawing1.dwg file
is created and opened. Likewise an untitled new WaterGEMS V8i project is also created and opened if WaterGEMS
V8i has been loaded. WaterGEMS V8i has been loaded if the WaterGEMS V8i menus and docking windows are
visible. WaterGEMS V8i can be loaded in two ways: automatically by using the WaterGEMS V8i for AutoCAD
shortcut, or by starting AutoCAD and then using the command: WaterGEMS V8i. Once loaded, you can
immediately begin laying out your network and creating your model using the WaterGEMS V8i menus and the
WaterGEMS V8i file menu (See Menus). Upon saving and titling your AutoCAD file for the first time, your
WaterGEMS V8i project files will also acquire the same name and file location.
Open a previously created WaterGEMS V8i projectYou can open a previously created WaterGEMS V8i model.
If the model was created in the Stand Alone version, you must import your WaterGEMS V8i project while a .dwg
file is open. From the WaterGEMS V8i menu select Project -> Import -> WaterGEMS V8i Database. Alternatively
you can use the command: _wtgImportProject. You will have the choice to import your WaterGEMS V8i database
file (.sqlite) or your WaterGEMS V8i project file (.wtg).
Import a model that was created in another modeling applicationYou can import a model that was created in
EPANET. See Importing and Exporting Data for further details.
Menus
In the AutoCAD environment, in addition to AutoCADs menus, the following WaterGEMS V8i menus are available:
Project
Edit
Analysis
Components
View
47
Tools
Report
Help
The WaterGEMS V8i menu commands work the same way in AutoCAD and the Stand-Alone Editor. For complete
descriptions of WaterGEMS V8i menu commands, see Menus (on page 807).
Many commands are available from the right-click context menu. To access the menu, first highlight an element in the
drawing pane, then right-click it to open the menu.
Drawing Setup
When working in the AutoCAD environment, you may work with our products in many different AutoCAD scales and
settings. However, WaterGEMS V8i elements can only be created and edited in model space.
Symbol Visibility
In the AutoCAD environment, you can control display of element labels using the check box in the Drawing Options
dialog box.
Note: In AutoCAD, it is possible to delete element label text using the ERASE command. You should not use
ERASE to control visibility of labels. If you desire to control the visibility of a selected group of element labels,
you should move them to another layer that can be frozen or turned off.
AutoCAD Project Files

When using WaterGEMS V8i in the AutoCAD environment, there are three files that fundamentally define a
WaterGEMS V8i model project:
Drawing File (.dwg)The AutoCAD drawing file contains the custom entities that define the model, in addition to
Model FileThe native WaterGEMS V8i model database file that contains all the element properties, along with
other important model data. WaterGEMS V8i .etc files can be loaded and run using the Stand-Alone Editor. These
files may be copied and sent to other WaterGEMS V8i users who are interested in running your project. This is the
most important file for the WaterGEMS V8i model.
wtg Exchange Database (.wtg.sqlite)The intermediate format for wtg project files. When you import a wtg file
into WaterGEMS V8i, you first export it from wtg into this format, then import the .wtg.sqlite file into WaterGEMS
V8i. Note that this works the same in the Stand-Alone Editor and in AutoCAD.
The three files have the same base name. It is important to understand that archiving the drawing file is not sufficient to
reproduce the model. You must also preserve the associated .etc and wtg.sqlite file.
Since the .etc file can be run and modified separately from the .dwg file using the Stand-Alone Editor, it is quite
possible for the two files to get out of sync. Should you ever modify the model in the Stand-Alone Editor and then later
load the AutoCAD .dwg file, the WaterGEMS V8i program compares file dates, and automatically use the built-in
AutoCAD synchronization routine.
Drawing Synchronization
Whenever you open a WaterGEMS -based drawing file in AutoCAD, the WaterGEMS model server will start. The first
thing that the application will do is load the associated WaterGEMS model (stsw) file. If the time stamps of the drawing
48
and model file are different, WaterGEMS will automatically perform a synchronization. This protects against
corruption that might otherwise occur from separately editing the WaterGEMS model file in stand-alone mode, or
editing proxy elements at an AutoCAD station where the WaterGEMS application is not loaded.
The synchronization check will occur in two stages:
First, WaterGEMS will compare the drawing model elements with those in the server model. Any differences will
be listed. WaterGEMS enforces network topological consistency between the server and the drawing state. If model
elements have been deleted or added in the .stsw file during a WaterGEMS session, or if proxy elements have been
deleted, WaterGEMS will force the drawing to be consistent with the native database by restoring or removing any
missing or excess drawing custom entities.
After network topology has been synchronized, WaterGEMS will compare other model and drawing states such as
location, labels, and flow directions.
You can run the Synchronization check at any time using the following command:
STMCSYNCHRONIZECSDWSYNCSERVER
Or by selecting Tools > Database Utilities > Synchronize Drawing.
Saving the Drawing as Drawing*.dwg

AutoCAD uses Drawing*.dwg as its default drawing name. Saving your drawing as the default AutoCAD drawing
name (for instance Drawing1.dwg) should be avoided, as it makes overwriting model data very likely. When you first
start AutoCAD, the new empty drawing is titled Drawing*.dwg, regardless of whether one exists in the default
directory. Since our modeling products create model databases associated with the AutoCAD drawing, the use of
Drawing*.dwg as the saved name puts you at risk of causing synchronization problems between the AutoCAD drawing
and the modeling files.
Note: If this situation inadvertently occurs (save on quit for example), restart AutoCAD, use the Open command
to open the Drawing*.dwg file from its saved location, and use the Save As command to save the drawing and
model data to a different name.
Working with Elements Using AutoCAD Commands

This section describes how to work with elements using AutoCAD commands, including:
WaterGEMS V8i Custom AutoCAD Entities

The primary AutoCAD-based WaterGEMS V8i element entitiespipes, junctions, pumps, etc.are all implemented
using ObjectARX custom objects. Thus, they are vested with a specialized model awareness that ensures that any
editing actions you perform will result in an appropriate update of the model database.
This means that you can perform standard AutoCAD commands (see Working with Elements Using AutoCAD
Commands) as you normally would, and the model database will be updated automatically to reflect these changes.
It also means that the model will enforce the integrity of the network topological state. Therefore, if you delete a nodal
element such as a junction, its connecting pipes will also be deleted since their connecting nodes topologically define
model pipes.
Using ObjectARX technology ensures the database will be adjusted and maintained during Undo and Redo
transactions.
49
When running in the AutoCAD environment, Bentley Systems products make use of all the advantages that AutoCAD
has, such as plotting capabilities and snap features. Additionally, AutoCAD commands can be used as you would with
any design project. For example, our products elements and annotation can be manipulated using common AutoCAD
commands.
Explode Elements
In the AutoCAD environment, running the AutoCAD Explode command will transform all custom entities into
equivalent AutoCAD native entities. When a custom entity is exploded, all associated database information is lost. Be
certain to save the exploded drawing under a separate filename.
Use Explode to render a drawing for finalizing exhibits and publishing maps of the model network. You can also
deliver exploded drawings to clients or other individuals who do not own a Bentley Systems Product license, since a
fully exploded drawing will not be comprised of any ObjectARX proxy objects.
Moving Elements
When using the AutoCAD environment, the AutoCAD commands Move, Scale, Rotate, Mirror, and Array can be used
to move elements.
To move a node, execute the AutoCAD command by either typing it at the command prompt or selecting it. Follow the
AutoCAD prompts, and the node and its associated label will move together. The connecting pipes will shrink or
stretch depending on the new location of the node.
Moving Element Labels

When using the AutoCAD environment, the AutoCAD commands Move, Scale, Rotate, Mirror, and Array can be used
to move element text labels.
To move an element text label separately from the element, click the element label you wish to move. The grips will
appear for the label. Execute the AutoCAD command either by typing it at the command prompt, by selecting it from
the tool palette, or by selecting it from the right-click menu. Follow the AutoCAD prompt, and the label will be moved
without the element.
Snap Menu
When using the AutoCAD environment, the Snap menu is a standard AutoCAD menu that provides options for picking
an exact location of an object. See the Autodesk AutoCAD documentation for more information.
Polygon Element Visibility

By default, polygon elements are sent to the back of the draw order when they are drawn. If the draw order is modified,
polygon elements can interfere with the visibility of other elements. This can be remedied using the AutoCAD Draw
Order toolbar.
To access the AutoCAD Draw Order toolbar, right-click on the AutoCAD toolbar and click the Draw Order entry in the
list of available menus.
By default, polygon elements are filled. You can make them unfilled (just borders visible) using the AutoCAD FILL
command. After turning fill environment OFF, you must REGEN to redraw the polygons.
50
Undo/Redo
The menu-based undo and redo commands operate exclusively on WaterGEMS V8i elements by invoking the
commands directly on the model server. The main advantage of using the specialized command is that you will have
unlimited undo and redo levels. This is an important difference, since in layout or editing it is quite useful to be able to
safely undo and redo an arbitrary number of transactions.
Whenever you use a native AutoCAD undo, the server model will be notified when any WaterGEMS V8i entities are
affected by the operation. WaterGEMS V8i will then synchronize the model to the drawing state. Wherever possible,
the model will seek to map the undo/redo onto the model servers managed command history. If the drawings state is
not consistent with any pending undo or redo transactions held by the server, WaterGEMS V8i will delete the
command history. In this case, the model will synchronize the drawing and server models.
Note: If you use the native AutoCAD undo, you are limited to a single redo level. The WaterGEMS V8i undo/redo
is faster than the native AutoCAD undo/redo. If you are rolling back WaterGEMS V8i model edits, it is
recommended that you use the menu-based WaterGEMS V8i undo/redo.
Note: If you undo using the AutoCAD undo/redo and you restore WaterGEMS V8i elements that have been
previously deleted, morphed, or split, some model state attributes such as diameters or elevations may be lost,
even though the locational and topological state is fully consistent. This will only happen in situations where the
WaterGEMS V8i command history has been deleted. In such cases, you will be warned to check your data
carefully.
Contour Labeling
You can apply contour labels after the contour plot has been exported to the AutoCAD drawing. The labeling
commands are accessed from the Tools menu. The following options are available:
EndAllows you to apply labels to one end, both ends, or any number of selected insertion points. After selecting
this labeling option, AutoCAD will prompt you to Select Contour to label. After selecting the contour to label,
AutoCAD prompts for an Insertion point. Click in the drawing view to place labels at specified points along the
contour. When prompted for an Insertion point, clicking the Enter key once will prompt you to select point nearest
the contour endpoint. Doing so will apply a label to the end of the contour closest to the area where you clicked.
Clicking the Enter key twice when prompted for an Insertion point will apply labels to both ends of the contour.
InteriorThis option applies labels to the interior of a contour line. You will be prompted to select the contour to be
labeled, then to select the points along the contour line where you want the label to be placed. Any number of labels
can be placed inside the contour in this way. Clicking the label grip and dragging will move the label along the
contour line.
Group EndChoosing this option opens the Elevation Increment dialog box. The value entered in this dialog box
determines which of the contours selected will be labeled. If you enter 2, only contours representing a value that is a
multiple of 2 will be labeled, and so on. After clicking OK in this dialog box, you will be prompted to select the
Start point for a line. Contours intersected by the line drawn thusly will have a label applied to both ends, as
modified by the Elevation Increment that was selected.
Group InteriorChoosing this option opens the Elevation Increment dialog box. The value entered in this dialog
box determines which of the contours selected will be labeled. If you enter 2, only contours representing a value that
is a multiple of 2 will be labeled, and so on. After clicking OK in this dialog box, you will be prompted to select the
Start point for a line.
Change SettingsAllows you to change the Style, Display Precision, and Font Height of the contour labels.
Delete LabelPrompts to select the contour from which labels will be deleted, then prompts to select the labels to
be removed.
51
Delete All LabelsPrompts to select which contours the labels will be removed from, then removes all labels for
the specified contours.
Note: Contours are only views unless they are exported to to native format, and only native format contours can
be edited.
Working in ArcGIS
WaterGEMS V8i provides three environments in which to work: WaterGEMS V8i Stand-Alone Mode, AutoCAD
Integrated Mode, and ArcMap Integrated Mode. Each mode provides access to differing functionalitycertain
capabilities that are available within WaterGEMS V8i Stand-Alone mode may not be available when working in
ArcMap Integrated mode, and vice-versa. In addition, you can use ArcCatalog to perform actions on any WaterGEMS
V8i database. Some of the advantages of working in GIS mode include:
Full functionality from within the GIS itself, without the need for data import, export, or transformation
The ability to view and edit multiple scenarios in the same geodatabase
Minimizes data replication
GIS custom querying capabilities
Lets you build models from scratch using practically any existing data source
Utilize the powerful reporting and presentation capabilities of GIS
A firm grasp of GIS basics will give you a clearer understanding of how Bentley WaterGEMS V8i interacts with GIS
software. Click one the following links to learn more:
ArcGIS Integration
WaterGEMS features full integration with Esris ArcGIS software, including ArcView, ArcEdit, and ArcInfo. The
following is a description of the functionality available with each of these packages:
ArcViewArcView provides the following capabilities:
Data Access
Mapping
Customization
Spatial Query
Simple Feature Editing
ArcView can edit shapefiles and personal geodatabases that contain simple features such as points, lines, polygons,
and static annotation. Rules and relationships can not be edited with ArcView.
ArcEditArcEdit provides all of the capabilities available with ArcView in addition to the following:
Coverage and geodatabase editing
ArcEdit can edit shapefiles, coverages, personal geodatabases, and multi-user geodatabases.
ArcInfoArcInfo provides all of the capabilities available with ArcEdit in addition to the following:
Advanced geoprocessing
Data conversion
ArcInfo Workstation
ArcInfo can edit shapefiles, coverages, personal geodatabases, and multi-user geodatabases.
52
ArcGIS Integration with WaterGEMS V8i

When you install WaterGEMS V8i after you install ArcGIS, integration between the two is automatically configured
when you install WaterGEMS V8i.
If you install ArcGIS after you install WaterGEMS V8i, you must manually integrate the two by selecting Run > All
Programs > Bentley > WaterGEMS V8i > Integrate WaterGEMS V8i with AutoCAD-ArcGIS. The integration utility
runs automatically. You can then run WaterGEMS V8i in ArcGIS mode.
Registering and Unregistering WaterGEMS V8i with ArcGIS

Under certain circumstances, you may wish to unregister WaterGEMS V8i from ArcGIS. These circumstances can
include the following:
To avoid using a license of WaterGEMS V8i when you are just using ArcMap for other reasons.
If WaterGEMS V8i and another 3rd party application are in conflict with one another.
To Unregister with ArcGIS:
Run ArcGISUnregistrationTool.exe to remove the integration. If you do this, you will be required to run
ArcGISRegistrationTool.exe before using WaterGEMS V8i.
Both of these applications are located in the main product directory.
To Re-Register with ArcGIS:
Run ArcGISRegistrationTool.exe to restore the integration.
This application is located in the main product directory.
ArcGIS Applications
ArcView, ArcEdit, and ArcInfo share a common set of applications, each suited to a different aspect of GIS data
management and map presentation. These applications include ArcCatalog and ArcMap.
ArcCatalogArcCatalog is used to manage spatial data, database design, and to view and record metadata.
ArcMapArcMap is used for mapping, editing, and map analysis. ArcMap can also be used to view, edit, and
calculate your WaterGEMS V8i model.
Using ArcCatalog with a WaterGEMS V8i Database

You can use ArcCatalog to manage spatial data, database design, and to view and record metadata associated with your
WaterGEMS V8i databases.
ArcCatalog Geodatabase Components

Many of the components that can make up a geodatabase can be directly correlated to familiar WaterGEMS V8i
conventions. The following diagram illustrates some of these comparisons.
53
The Bentley WaterGEMS V8i ArcMap Client

The Bentley WaterGEMS V8i ArcMap client refers to the environment in which Bentley WaterGEMS V8i is run. As
the ArcMap client, Bentley WaterGEMS V8i runs within ESRIs ArcMap interface, allowing the full functionality of
both programs to be utilized simultaneously.
Getting Started with the ArcMap Client

An ArcMap WaterGEMS project consists of:
A WaterGEMS .mdb filethis file contains all modeling data, and includes everything needed to perform a
calculation.
A WaterGEMS project filethis file contains data such as annotation and color-coding definitions.
A geodatabase associationa project must be linked to a new or existing geodatabase.
Note: You must be in an edit session (Click the ArcMap Editor button and select the Start Editing command) to
access the various WaterGEMS editors (dialogs accessed with an ellipsis (...) button) through the Property
Editor, Alternatives Editor, or FlexTables, even if you simply wish to view input data and do not intend to make
any changes.
There are a number of options for creating a model in the ArcMap client:
Create a model from scratchYou can create a model in ArcMap. Youll first need to create a new project and
attach it to a new or existing geodatabase. See Managing Projects In ArcMap (on page 55) and Attach
Geodatabase Dialog for further details. You can then lay out your network using the WaterGEMS toolbar. See
Laying out a Model in the ArcMap Client .
Open a previously created WaterGEMS projectYou can open a previously created WaterGEMS model. If the
model was created in the Stand Alone version, you must attach a new or existing geodatabase to the project. See
Managing Projects In ArcMap (on page 55) and Attach Geodatabase Dialog for further details.
Import a model that was created in another modeling applicationYou can import a model that was created in
SewerCAD or EPA SWMM. See Importing Data From Other Models for further details.
54
Note: You cannot use a WaterGEMS .mdb file as a geodatabase. Make sure that you do not attempt to use the
same file name for both the WaterGEMS database (stsw.mdb) and the geodatabase .mdb.
Managing Projects In ArcMap

The WaterGEMS ArcMap client utilizes a Project Manager to allow you to disconnect and reconnect a model from the
underlying geodatabase, to view and edit multiple projects, and to display multiple projects on the same map.
The Project Manager lists all of the projects that have been opened during the ArcMap session. The following controls
are available:
AddClicking the Add button opens a submenu containing the following commands:
Add New ProjectOpens a Save As dialog, allowing you to specify a project name and directory location. After
clicking the Save button, the Attach Geodatabase dialog opens, allowing you to specify a new or existing
geodatabase to be connected to the project.
Add Existing ProjectOpens an Open dialog, allowing you to browse to the WaterGEMS project to be added. If
the WaterGEMS project is not associated with a geodatabase, the Attach Geodatabase dialog opens, allowing you to
specify a new or existing geodatabase to be connected to the project.
Open ProjectOpens the project that is currently highlighted in the Project Manager list pane. You can only edit
projects that are currently open. This command is available only when the currently highlighted project is closed.
Save ProjectSaves the project that is currently highlighted in the Project Manager list pane. This command is
available only when changes have been made to the currently highlighted project.
Close ProjectCloses the project that is currently highlighted in the Project Manager list pane. Closed projects
cannot be edited, but the elements within the project will still be displayed in the map. This command is available
only when the currently highlighted project is open.
Remove ProjectRemoves the project that is currently highlighted in the Project Manager list pane. This command
permanently breaks the connection to the geodatabase associated with the project.
Make CurrentMakes the project that is currently highlighted in the Project Manager list pane the current project.
Edits made in the map are applied to the current project. This command is available only when the currently
highlighted project is not marked current.
To add a new project:
1. From the Project Manager, click the Add button and select the Add New Project command. Or, from the
WaterGEMS menu, click the Project menu and select the Add New Project command.
2. In the Save As dialog that appears, specify a name and directory location for the new project, then click the Save
button.
3. In the Attach Geodatabase dialog that appears, click the Attach Geodatabase button. Browse to an existing
geodatabase to import the new project into, or create a new geodatabase by entering a name for the geodatabase and
specifying a directory. Click the Save button.
4. Enter a dataset name.
5. You can assign a spatial reference to the project by clicking the Change button, then specifying spatial reference
data in the Spatial Reference Properties dialog that appears.
6. In the Attach Geodatabase dialog, click the OK button to create the new project.
To add an existing project:
1. From the Project Manager, click the Add button and select the Add Existing Project command. Or, from the
WaterGEMS menu, click the Project menu and select the Add Existing Project command.
2. In the Open dialog that appears, browse to the location of the project, highlight it, then click the Open button.
55
3. If the project is not associated with a geodatabase, the Attach Geodatabase dialog opens, allowing you to specify a
new or existing geodatabase to be connected to the project. Continue to Step 4. If the project has already been
associated with a geodatabase, the Attach Geodatabase will not open, and the project will be added.
4. In the Attach Geodatabase dialog, click the Attach Geodatabase button. Browse to an existing geodatabase to import
the new project into, or create a new geodatabase by entering a name for the geodatabase and specifying a directory.
Click the Save button.
Attach Geodatabase Dialog

The Attach Geodatabase dialog allows you to associate a WaterGEMS V8i project with a new or existing geodatabase,
and also provides access to the ArcMap Spatial Reference Properties dialog, allowing you to define the spatial
reference for the geodatabase.
The following controls are available:
Geodatabase FieldThis field displays the path and file name of the geodatabase that was selected to be associated
with the project.
Geodatabase ButtonThis button opens an Import To or Create New Geodatabase dialog, where you specify an
existing geodatabase or enter a name and directory for a new one.
Dataset NameAllows you to enter a name for the dataset.
Spatial Reference PaneDisplays the spatial reference currently assigned to the geodatabase.
Spatial Data Coordinates UnitChoose the unit system that are used by the spatial data coordinates.
Change ButtonOpens the Spatial Reference Properties dialog, allowing you to change the spatial reference for the
geodatabase.
Laying out a Model in the ArcMap Client

The WaterGEMS V8i toolbar contains a set of tools similar to the Stand-Alone version. See Layout Toolbar for
descriptions of the various element layout tools.
You must be in an edit session (Click the ArcMap Editor button and select the Start Editing command) to lay out
elements or to enter element data in ArcMap. You must then Save the Edits (Click the ArcMap Editor button and select
the Save Edits command) when you are done editing. The tools in the toolbar will be inactive when you are not in an
edit session.
Using GeoTables
A GeoTable is a flexible table definition provided by the software. The software creates feature classes with a very
simple schema. The schema consists solely of the Geometry, the unique ID and feature type. The software provides a
dynamic join of this data to our trademarked GeoTable. The join is then managed so that it will be automatically
updated on a change to the GeoTable definition for each element type.
GeoTables allow for a dynamic view on the data. The underlying data will represent the data for the current scenario,
the current timestep and the unit definition of the GeoTable. By using these GeoTables, the software provides ultimate
flexibility for using the viewing and rendering tools provided by the ArcMap environment.
Note that the GeoTable settings are not project specific, but are stored on your local machine - any changes you make
will carry across all projects. This means that if you have ArcMap display settings based on attributes contained in
customized GeoTables, you will have to copy the AttributeFlexTables.xml file (located in the C:\Documents and
Settings\All Users\Application Data\Bentley\ WaterGEMS V8i\8 folder) for these display settings to work on another
computer.
56
Using GeoTables, you can:

Apply ArcMap symbology definitions to map elements based on WaterGEMS V8i data
Use the ArcMap Select By Attributes command to select map elements based on WaterGEMS V8i data
Generate ArcMap reports and graphs that include WaterGEMS V8i data
To Edit a GeoTable:
1. In the FlexTable Manager list pane, expand the GeoTables node if necessary. Double-click the GeoTable for the
desired element.
2. By default, only the ID, Label, and Notes data is included in the GeoTable. To add attributes, click the Edit button.
3. In the Table setup dialog that appears, move attributes from the Available Columns list to the Selected columns list
to include them in the GeoTable. This can be accomplished by double-clicking an attribute in the list, or by
highlighting attributes and using the arrow buttons (a single arrow button moves the highlighted attribute to the
other list; a double arrow moves all of them).
4. When all of the desired attributes have been moved to the selected columns, click OK.
WaterGEMS V8i Renderer

The WaterGEMS V8i Renderer can be activated/deactivated by choosing the WaterGEMS V8i > View > Apply
WaterGEMS V8i Renderer menu item.
When the WaterGEMS V8i Renderer is activated, inactive topology (that is, WaterGEMS V8i elements whose Is
Active? property is set to false) will display differently and flow arrows will become visible in the map (if applicable).
The inactive topology will either turn to the inactive color, or will become invisible, depending on your settings in the
options dialog. Flow arrows will appear on the pipes if the model has results and the Show Flow Arrows menu item is
activated. See Show Flow Arrows (ArcGIS) for more details.
When working with WaterGEMS V8iprojects with a large number of elements, there can be a performance impact
when the WaterGEMS V8i Renderer is activated.
Show Flow Arrows (ArcGIS)

The Show Flow Arrows menu item can be activated/deactivated by choosing the WaterGEMS V8i > View > Show
Flow Arrows menu item.
When Show Flow Arrows is activated, it allows the WaterGEMS V8i Renderer to draw flow arrows on pipe elements
to indicate the direction of flow in a project with results.
The Show Flow Arrows menu item only causes flow arrows to be drawn if the WaterGEMS V8i Renderer is activated.
When working with WaterGEMS V8i projects with a large number of elements, there can be a performance impact
when the Show Flow Arrows menu item is activated.
Note: This option is for the ArcGIS client only.
Layer Symbology
This dialog allows you to initialize the range. The Layer Symbology dialog is accessed by clicking WaterGEMS V8i >
Tools > Layer Symbology.
By default, elements that fall outside of the defined range will not be displayed. Choose the "Include Undefined?"
option to display elements that fall outside the defined range.
57
Multiple Client Access to WaterGEMS V8i Projects

Since the WaterGEMS V8i datastore is an open database format, multiple application clients can open, view, and edit a
WaterGEMS V8i project simultaneously. This means that a single project can be open in WaterGEMS V8i Stand-
Alone, ArcMap, and ArcCatalog all at the same time. Each client is just another view on the same data, contained
within the same files.
Synchronizing the GEMS Datastore and the Geodatabase

WaterGEMS V8i will automatically update the GEMS datastore to reflect changes made to a project in ArcCatalog or
ArcMap. To synchronize the datastore and the geodatabase manually, click the File\SynchronizeGEMS Project.
In ArcMap, certain operations can be performed outside of an edit session. For instance, the Calculate command can be
applied to perform a global edit within an ArcMap table. When this happens, WaterGEMS V8i cannot see that
changes have been made, so a manual synchronization must be initiated as outlined above.
Google Earth Export

Google Earth export allows a WaterGEMS V8i user to display WaterGEMS V8i spatial data and information (input/
results) in a platform that is growing more and more popular with computer users around the world for viewing general
spatial data on the earth.
WaterGEMS V8i supports a limited export of model features and results to Google Earth through the Microstation V8i
and ArcGIS 9.3 platforms. The benefits of this functionality include:
Share data and information with non WaterGEMS V8i users in a portable open format,
Leverage the visual presentation of Google Earth to create compelling visual presentations,
Present data along side other Google Earth data such as satellite imagery and 3D buildings.
Steps for using the export feature in each platform are described below.
In general, the process involves creation of a Google Earth format file (called a KML - Keyhole Markup Language -
file). This file can be opened in Google Earth. Google Earth however is not a "platform" as ArcGIS is because it is not
possible to edit or run the model in Google Earth. It is simply for display.
Once the KML file has been generated in WaterGEMS V8i it can be viewed in Google Earth by opening Google Earth
(version 3 or later) and selecting File > Open and selecting the KML file that was created.
The layers you open in Google Earth will appear as "Temporary Places" in the Places manager. These can be checked
or unchecked to turn the layers on or off.
Google Earth Export from the MicroStation Platform

For the purpose of describing the export process these steps will assume that the model you wish to export has been
defined (laid out) in terms of a well-known spatial reference (coordinate system). The model if opened in the
WaterGEMS V8i stand alone interface is in scaled drawing mode (Tools --> Options --> Drawing Tab --> Drawing
Mode: Scaled).
Preparing to Export to Google Earth from Microstation
58
In order to describe how to export WaterGEMS V8i data to Google Earth we will cover a set of questions to determine
which steps need to be performed. Each question will result in either performing some steps or moving on to the next
question. Each question is relating to your WaterGEMS V8i model:
Q1: Do you already have a *.dgn (Microstation drawing file)? If yes go to Q2, else follow steps 1 to 6:
1. Open WaterGEMS V8i for Microstation V8i.
2. Locate the model folder and create a new dgn file (new file icon at the top right of the File Open dialog) with a
name of your choice. e.g., if the model is called "MyModel.wtg" a dgn file called "MyModel.dgn" might be
appropriate.
3. Select the newly created *.dgn file and click Open.
4. From the WaterGEMS V8i menu, select Project --> Attach Existing.
5. Select the *.wtg model file and click Open.
6. After the model has been imported save the *.dgn. in Microstation, File --> Save.
Q2: Do you have a spatial reference defined in the dgn? If yes go to Q3, else follow steps 1 and 2 below:
Note: If your model is not modelled in a known coordinate system or you don't know the coordinate system, but
the model is to scale you may be able to determine an approximate fit to Google Earth features using Place Mark
Monuments. For more information on how to use Place Mark Monuments as an alternative to a Geographic
Coordinate System please consult the Microstation help.
1. In Microstation choose Tools --> Geographic --> Select Geographic Coordinate System.
2. In the dialog that opens, using the toolbar, you may select a Geographic Coordinate System from a library or from
an existing *.dgn. Select the projected coordinate system that applies to your model. For further information on
Geographic Coordinate Systems please consult the Microstation documentation.
Note: You may be prompted by Microstation saying that your DGN storage units are different from the
coordinate system you selected. Assuming your model is already correctly to scale, you should choose not to
change the units inside Microstation. Consult the Microstation help should you need more information.
Q3: Have you configured the Google Earth Export settings? If yes go to step Q4, else follow steps 1 and 2 below:
1. In Microstation choose Tools --> Geographic --> Google Earth Settings. Ensure that the Google Earth Version is set
to version 3.
2. If you have Google Earth installed on your machine you may find it convenient for the export to open the exported
Google Earth file directly. If so, ensure that the "Open File After Export" setting is checked. If you do not have
Google Earth installed uncheck this option. Please consult the Microstation documentation for the function of other
settings. In most cases the defaults should suffice.
Q4: Have you set up your model as you wish it to be displayed in Google Earth? If yes go to "Exporting to Google
Earth from Microstation", else follow the step below:
Use the WaterGEMS V8i Element Symbology to define the color coding and annotation that you wish to display in
Google Earth.
Exporting to Google Earth from Microstation
1. Once you are ready to export to Google Earth the process is very simple. In Microstation choose File --> Export -->
Google Earth.
2. Select a name for your Google Earth file and click Save. If you have Google Earth installed and chose to open the
Google Earth file after export (see step 10) then the exported file will open inside Google Earth and you can view
the result. The exported file can be used inside Google Earth independently of the original WaterGEMS V8i or
Microstation model.
59
Google Earth Export from ArcGIS

For the purpose of describing the export process these steps will assume that the model you wish to export has been
defined (laid out) in terms of a well-known spatial reference (coordinate system). The model if opened in the
WaterGEMS V8i stand alone interface is in scaled drawing mode (Tools --> Options --> Drawing Tab --> Drawing
Mode: Scaled).
Preparing to Export to Google Earth from ArcGIS
In order to describe how to export WaterGEMS V8i data to Google Earth we will cover a set of questions to determine
which steps need to be performed. Each question will result in either performing some steps or moving on to the next
question. Each question is relating to your WaterGEMS V8i model.
Q1: Do you already have a *.mxd (ArcMap map file)? If yes go to Q2, else follow steps 1 to 10:
1. Open ArcMAP 9.3.
2. Start with a new empty map.
3. From the WaterGEMS V8i toolbar, choose WaterGEMS V8i --> Project --> Add Existing Project.
4. Locate and select the model *.wtg and click Open.
5. In the Attach Geodatabase dialog select the blue folder at top right and create a new Geodatabase with the name of
your choice. e.g., if the model database is called "MyModel.wtg.sqlite" a geodatabase file called
"MyModelGeo.sqlite" might be appropriate. Click Save.
6. Select the appropriate spatial reference (projected coordinate system) by clicking the Change --> Select... (or
Import... from an existing geodataset.
7. Ensure that the X/Y Domain settings are valid for your model.
8. Make sure the correct Spatial Data Coordinates Unit is selected, then click OK. For further assistance on setting
spatial references and related settings please consult the ArcMap documentation.
9. Once the model add process is complete save the map file (*.mxd).
10. Go to Q3.
Q2 Do you have a spatial reference defined in the geodatabase? If yes go to Q3, else follow steps 1 to 9 below:
Note: For assistance on setting spatial references and related settings please consult the ArcMap documentation.
1. To add a spatial reference to your model, close ArcMap if already open.

2. Open ArcCatalog.
3. Browse for the geodatabase of interest.
4. Expand the dataset node (cylinder) to show the feature dataset (3 rectangles).
5. Right-click on the feature dataset and choose Properties.
6. Click the XY Coordinate System tab.
7. Either Select... or Import... the appropriate projected coordinate system.
8. Close ArcCatalog.
9. Open ArcMap and re-open the *.mxd.
Q3: Have you set up your model as you wish it to be displayed in Google Earth? If yes go to the Exporting to a KML
File from ArcGIS section below, else follow steps 1 to 8 below:
1. Prior to exporting to Google Earth you should configure the layers that you wish to export. Many of the layer
properties supported in ArcMap presentation can be used with Google Earth export. Please consult the ArcGIS
documentation for detailed instructions on layer properties. Some basic examples are provided.
2. Right click on a layer, for example the Pipes layer, and choose Properties.
3. Select the Fields tab.
60
4. Change the Primary Display Field to Label (If this field is not available, you need to make sure the WaterGEMS
V8i project is open. See details below).
5. Click on the HTML Popup tab.
6. Check "Show content for this layer using the HTML Popup tool."
7. Click "Verify" to see the fields. (These can be customized by editing your WaterGEMS V8i GeoTables). This table
will be viewable inside Google Earth after exporting.
8. Repeat steps 1 through 6 above for each layer you wish to export.
Exporting to a KML File from ArcGIS
1. In ArcMap, Window --> ArcToolbox.
2. ArcToolbox --> Conversion Tools --> To KML --> Layer to KML.
3. In the dialog that opens, select the layer you wish to export to Google Earth, e.g., Pipe.
4. Specify the Google Earth file name, e.g., Pipe.kmz.
5. Pick a layer output scale that makes sense for your layer. (See the ArcGIS help topic on the effect of this value).
Assuming you have no zoom dependent scaling or are not exporting any symbology, a value of 1 should work fine.
6. Click OK to commence the export. (This may take some time.)
7. If you have Google Earth installed you may now open the exported *.kmz file and view it in Google Earth.
8. Repeat steps 2 to 7 for each layer you wish to export.
Note: You can export all layers at once using the Map to KML tool.
Using a Google Earth View as a Background Layer to Draw a Model

Google Earth images generally do not possess the accuracy of engineering drawings. However, in some cases, a user
can create a background image (as a jpg or bmp file) and draw a model on that image. In general this model will not be
to scale and the user must then enter pipe lengths using user defined lengths.
There is an approach that can be used to draw a roughly scaled model in the stand alone platform without the need to
employ user define lengths which can be fairly time consuming. The steps are given below:
1. Open the Google Earth image and zoom to the extents that will be used for the model. Make certain that the view is
vertical straight down (not tilted). Using Tools > Ruler, draw a straight line with a known length (in an
inconspicuous part of the image). Usually a 1000 ft is a good length as shown below:
61
2. Save the image using File > Save > Save Image and assign the image a file name.
3. Open WaterGEMS V8i and create a new project.
4. Import the file as a background using View > Background > New > New File. Browse to the image file and pick
Open.
5. You will see the default image properties for this drawing. Write down the values in the first two columns of the
lower pane and Select OK.
62
6. The background file will open in the model with the scale line showing. Zoom to that scaled line. Draw a pipe as
close the exact length as the scale line as possible. Look at the Length (scaled) property of that line. (In this example
it is 391.61 ft.) This means that the background needs to be scaled by a factor of 1000/391.61 = 2.553.
7. Close the background image by selecting View > Background > Delete and Yes. Delete the pipe and any end nodes.
8. Reopen the background image using View > Background > New > New File. This time do not accept the default
scale. Instead multiply the values in the two rightmost (image) columns by the scale factor determined in step 6 to
obtain the values in the two leftmost columns (drawing). For example, the scale factor was (2.553) to the Y value
for the top left corner becomes 822 x 2.553 = 2099. Fill in all the image values.
63
9. The image will appear at the correct (approximate) scale. This can be checked by drawing a pipe on top of the scale
line in the background image. The Length (scaled) of the pipe should be nearly the same as the length of the scale
line. Delete than line and any nodes at the end points.
10. The model is now roughly scaled. Remember that the lengths determined this way are not survey accuracy and are
as accurate as the care involved in measuring lengths. They may be off by a few percent which may be acceptable
for some applications.
Rollbacks
WaterGEMS V8i automatically saves a backup copy of the GEMS project database whenever a project is opened. It
will update this backup every time you save the project. In Stand-Alone mode, some session states are not saved in the
64
GEMS database. Examples include color coding setup and label locations. These data are saved separately from the
GEMS project database. Therefore, if a user terminates a session before saving, then all edits made subsequent to the
last save will be discarded. The restoration of the automatic project backup is termed a rollback.
However, in shared sessions such as when a user is simultaneously editing a GEMS project file with ArcMap,
ArcCatalog, or Access and WaterGEMS V8i Stand-Alone, it is not practical to discard project database changes
because each application holds a database lock. WaterGEMS V8i automatically adapts to these situations and will not
rollback when the Stand-Alone session is ended without a prior save. When this happens, WaterGEMS V8i will
generate a message stating that there are multiple locks on the GEMS project file, and that the other application must be
closed before the rollback can occur.
If you want the rollback to be performed, close ArcMap/ArcCatalog and then click Yes in the Multiple Locks dialog
box. WaterGEMS V8i will then ignore all changes, and revert to the original saved data.
If you elect not to perform the rollback, WaterGEMS V8i automatically synchronizes to reflect the current project
database state, the very next time it is opened and no project data is lost. To close WaterGEMS V8i without performing
a rollback, simply click No in the Multiple Locks dialog box. WaterGEMS V8i will then exit without saving changes.
Note that the changes made outside of WaterGEMS V8i will still be applied to the geodatabase, and WaterGEMS V8i
will synchronize the model with the geodatabase when the project is again opened inside WaterGEMS V8i. Therefore,
even though the changes were not saved inside WaterGEMS V8i, they will still be applied to the GEMS datastore the
next time the project is opened.
Project data is never discarded by WaterGEMS V8i without first giving you an opportunity to save.
Adding New WaterGEMS V8i Nodes To An Existing Model In ArcMAP

If you already have an .mxd file for the model:
1. Click Open.
2. Browse to the .mxd file in the Open dialog and then click Open.
3. In ArcMAP, click Add Data.
4. In the Add Data dialog that opens, browse to your model's .sqlite file.
5. Double click and select the feature datasets, then click Add to add them to the map.
6. To start adding elements to the model, click Editor and select the Start Editing command from the menu.
7. Click the Sketch Tool in the Editor toolbar, move the mouse cursor to the location of the new element in the
drawing pane, and click. The new element will open.
8. Using ArcMap's attribute tables, you can now enter data for the newly created element.
9. When you are finished laying out elements and editing their associated data, click Editor and select Stop Editing
from the menu. A dialog will open with the message "Do you want to save your edits?". Click Yes to commit the
edits to the database, No to discard all of the edits performed during the current editing session, and Cancel to
continue editing.
Note: When creating new elements, make sure that the Create New Feature option is selected in the Task
pulldown menu, and that the correct layer is selected in the Target pulldown menu.
Adding New Bentley WaterGEMS V8i Pipes To An Existing Model In ArcMAP

If you already have an .mxd file for the model, click the Open button, browse to it in the Open dialog, then click Open.
In ArcMAP, click the Add Data button.
65
Creating Models
In the Add Data dialog that opens, browse to your models .sqlite file. Double click it and select the feature datasets,
then click the Add button to add them to the map.
To start adding elements to the model, click the Editor button and select the Start Editing command from the submenu
that opens.
Click the Sketch Tool button in the Editor toolbar.
Click the Start Node for the new pipe, then double-click the Stop Node to place the pipe.
When you are finished laying out elements and editing their associated data, click the Editor button and select Stop
Editing from the submenu that opens. A dialog will open with the message Do you want to save your edits?. Click
the Yes button to commit the edits to the database, No to discard all of the edits performed during the current editing
session, and Cancel to continue editing.
Note: When creating new elements, make sure that the Create New Feature option is selected in the Task
pulldown menu, and that the correct layer is selected in the Target pulldown menu.
Creating Backups of Your ArcGIS WaterGEMS V8i Project

Because ArcGIS lacks a Save As command and because changing the name of your WaterGEMS V8i project files will
break the connection between the geodatabase and the model files, creating backups or copies of your project requires
the following procedure:
1. Make a copy of the wtg, wtg.sqlite, mdb (geodatabase), and dwh (if present).
2. Open the wtg file in a text editor, look for the "DrawingOptions" tag, and change the "ConnectionString" attribute to
point to the new copy of the geodatabase. (e.g. ConnectionString=".\GeoDB.sqlite").
3. Open the geodatabase in MS Access, look for the table named "WaterGEMSProjectMap", and edit the value in the
"ProjectPath" column to point to the new copy of the wtg file. (e.g. ".\Model.wtg").
Creating Models
Click the links below to learn about creating models:
Starting a Project
When you first start WaterGEMS V8i, the Welcome dialog box opens.
The Welcome dialog box contains the following controls:
Quick Start Lessons Opens the online help to the Quick Start Lessons
Overview topic.
Create New Project Creates a new WaterGEMS V8i project. When you click
this button, an untitled WaterGEMS V8i project is
created.
66
Creating Models
Open Existing Project Opens an existing project. When you click this button, a
Windows browse dialog box opens allowing you to
browse to the project to be opened. If you have
ProjectWise installed and integrated with WaterGEMS
V8i, you are prompted to log into a ProjectWise
datasource if you are not already logged in.
Show This Dialog at Start When selected, the Welcome dialog box opens whenever
you start WaterGEMS V8i. Turn off this box if you do
not want the Welcome dialog box to open whenever you
start WaterGEMS V8i.
To Access the Welcome Dialog During Program Operation

Click the Help menu and select the Welcome Dialog command.
To Disable the Automatic Display of the Welcome Dialog Upon Startup
In the Welcome dialog, turn off the box labeled Show This Dialog at Start.
To Enable the Automatic Display of the Welcome Dialog Upon Startup
In the Welcome dialog, turn on thebox labeled Show This Dialog at Start.
WaterGEMS V8i Projects

All data for a model are stored in WaterGEMS V8i as a project. WaterGEMS V8i project files have the file name
extension .wtg. You can assign a title, date, notes and other identifying information about each project using the Project
Properties dialog box. You can have up to five WaterGEMS V8i projects open at one time.
To Start a New Project
To start a new project, choose File > New or press <Ctrl+N>. An untitled project is opened in the drawing pane.
To Open an Existing Project
To open an existing project, choose File > Open or press <Ctrl+O>. A dialog box opens allowing you to browse for the
project you want to open.
To Switch Between Multiple Projects
To switch between multiple open projects, select the appropriate tab at the top of the drawing pane. The file name of
the project is displayed on the tab.
Database Format Conversion

This version of the software includes a change in the database format used to store modeling data. Microsoft
Access .sqlite files will be automatically converted to the new .sqlite format when they are opened. Existing .sqlite files
will be left untouched after the conversion. New files will be only created in this new format.
Upon program startup the following prompt is displayed:
67
Creating Models
The new .sqlite database format brings the following benefits:

Smaller database file-size (50% reduction in average).
Greatly increased file-size limit (2 TBs).
Better overall performance.
No conflicts with Microsoft Office.
Keep in mind that:
Older versions of this software are not able to read .sqlite files.
After conversion, .sqlite files will not be accessed/needed for the usage of this software. It is still a good practice to
keep existing .sqlites as data back-ups/history tracking.
.sqlite files will be added automatically to existing and new ProjectWise sets.
Setting Project Properties

The Project Properties dialog box allows you to enter project-specific information to help identify the project. Project
properties are stored with the project.
The dialog box contains the following text fields and controls:
Title Enter a title for the project.
File Name Displays the file name for the current project. If you have
not saved the project yet, the file name is listed as
Untitled x .wtg., where x is a number between 1 and 5
chosen by the program based on the number of untitled
projects that are currently open.
Engineer Enter the name of the project engineer.
Company Enter the name of your company.
Date Click this field to display a calendar, which is used to set

a date for the project.
Notes Enter additional information about the project.
To set project properties

1. Choose File > Project Properties and the Project Properties dialog box opens.
2. Enter the information in the Project Properties dialog box and click OK.
68
Creating Models
Setting Options
You can change global settings for WaterGEMS V8i in the Options dialog box. Choose Tools > Options. The Options
dialog box contains different tabs where you can change settings.
Click one of the following links to learn more about the Options dialog box:
Options Dialog Box - Global Tab

The Global tab changes general program settings for the WaterGEMS V8i stand-alone editor, including whether or not
to display the status pane, as well as window color and layout settings.
69
Creating Models
The Global tab contains the following controls:
General Settings
Backup Levels Indicates the number of backup copies that are retained
when a project is saved. The default value is 1.
Note: The higher this number, the more .BAK files

(backup files) are created, thereby using more hard
disk space on your computer.
Show Recently Used Files When selected, activates the recently opened files display
at the bottom of the File menu. This check box is turned
on by default. The number of recently used files that are
displayed depends on the number specified here.
70
Creating Models
Compact Database After When this box is checked the WaterGEMS V8i database
is automatically compacted when you choose File > Open
after the file has been opened the number of times
speficied here.
Show Status Pane When turned on, activates the Status Pane display at the
bottom of the WaterGEMS V8i stand-alone editor. This
check box is turned on by default.
Show Welcome Page on Startup When turned on, activates the Welcome dialog that opens
when you first start WaterGEMS V8i. This check box is
turned on by default.
Zoom Extents On Open When turned on, a Zoom Extents is performed

automatically in the drawing pane.
Use accelerated redraw Some video cards use "triple buffering", which we do not
support at this time. If you see anomalies in the drawing
(such as trails being left behind from the selection
rectangle), then you can shut this option off to attempt to
fix the problem. However, when this option is off, you
could see some performance degradation in the drawing.
Prompts Opens the Stored Prompt Responses dialog, which allows

you to change the behavior of the default prompts
(messages that appear allowing you to confirm or cancel
certain operations).
Window Color
Background Color Displays the color that is currently assigned to the

drawing pane background. You can change the color by
clicking the ellipsis (...) to open the Color dialog box.
Foreground Color Displays the color that is currently assigned to elements

and labels in the drawing pane. You can change the color
by clicking the ellipsis (...) to open the Color dialog box.
Read Only Background Color Displays the color that is currently assigned to read-only
data field backgrounds. You can change the color by
clicking the ellipsis (...) to open the Color dialog box.
Read Only Foreground Color Displays the color that is currently assigned to read-only
data field text. You can change the color by clicking the
ellipsis (...) to open the Color dialog box.
Selection Color Displays the color that is currently applied to highlighted

elements in the drawing pane. You can change the color
by clicking the ellipsis (...) to open the Color dialog box.
Layout
71
Creating Models
Display Inactive Topology When turned on, activates the display of inactive elements
in the drawing pane in the color defined in Inactive
Topology Line Color. When turned off, inactive elements
will not be visible in the drawing pane. This check box is
turned on by default.
Inactive Topology Line Color Displays the color currently assigned to inactive elements.
You can change the color by clicking the ellipsis (...) to
open the Color dialog box.
Auto Refresh Activates Auto Refresh. When Auto Refresh is turned on,
the drawing pane automatically updates whenever
changes are made to the WaterGEMS V8i datastore. This
check box is turned off by default.
Sticky Tool Palette When turned on, activates the Sticky Tools feature. When
Sticky Tools is turned on, the drawing pane cursor does
not reset to the Select tool after you create a node or finish
a pipe run in your model, allowing you to continue
dropping new elements into the drawing without re-
selecting the tool. When Sticky Tools is turned off, the
drawing pane cursor resets to the Select tool after you
create a node. This check box is selected by default.
Select Polygons By Edge When this box is checked, polygon elements (catchments)
can only be selected in the drawing pane by clicking on
their bordering line, in other words you cannot select
polygons by clicking their interior when this option is
turned on.
Selection Handle Size In Pixels Specifies, in pixels, the size of the handles that appear on
selected elements. Enter a number from 1 to 10.
Selection Line Width Multiplier Increases or decreases the line width of currently selected
link elements by the factor indicated. For example, a
multiplier of 2 would result in the width of a selected link
being doubled.
Default Drawing Style Allows you to select GIS or CAD drawing styles. Under
GIS style, the size of element symbols in the drawing
pane will remain the same regardless of zoom level.
Under CAD style, element symbols will appear larger or
smaller depending on zoom level.
Stored Prompt Responses Dialog Box
This dialog allows you to change the behavior of command prompts back to their default settings. Som,e commands
trigger a command prompt that can be suppressed by using the Do Not Prompt Again check box. You can turn the
prompt back on by accessing this dialog and unchecking the box for that prompt type.
72
Creating Models
Options Dialog Box - Project Tab

This tab contains miscellaneous settings. You can set pipe length calculation, spatial reference, label display, and
results file options in this tab.
73
Creating Models
The Project tab contains the following controls:
Geospatial Options
Spatial Reference Used for integration with Projectwise. Can leave the field
blank if there is no spatial information.
Element Identifier Options
Element Identifier Format Specifies the format in which reference fields are used.
Reference fields are fields that link to another element or
support object (pump definitions, patterns, controls,
zones, etc.).
Result Files
74
Creating Models
Specify Custom Results File Path? When checked, allows you to edit the results file path and
format by enabling the other controls in this section.
Root Path Allows you to specify the root path where results files are
stored. You can type the path manually or choose the path
from a Browse dialog by clicking the ellipsis (...) button.
Path Format Allows you to specify the complete path that you wish to
use for storing your result files for the current project.
You can type the path manually and/or use predefined
attributes from the menu accessed with the [>] button.
One of the predefined choices is the Root Path. It is
recommended that you start building your Path Format
with this Root Path choice. Then optionally extend this
path with the other predefined choices.
Path Displays a dynamically updated view of the custom result

file path based on the settings in the Root Path and Path
Format fields
Pipe Length
Round Pipe Length to Nearest The program will round to the nearest unit specified in
this field when calculating scaled pipe length
Calculate Pipe Lengths Using Node Elevations (3D When checked, includes differences in Z (elevation)
Length) between pipe ends when calculating pipe length.
Options Dialog Box - Drawing Tab

This tab contains drawing layout and display settings. You can set the scale that you want to use as the finished drawing
scale for the plan view output. Drawing scale is based upon engineering judgment and the destination sheet sizes to be
used in the final presentation.
75
Creating Models
The Drawing tab contains the following controls:
Drawing Scale
Drawing Mode Selects either Scaled or Schematic mode for models in the
drawing pane.
Horizontal Scale Factor 1 in. =: Controls the scale of the plan view.
Annotation Multipliers
Symbol Size Mulitplier Increases or decreases the size of your symbols by the
factor indicated. For example, a multiplier of 2 would
result in the symbol size being doubled. The program
selects a default symbol height that corresponds to 4.0 ft.
(approximately 1.2 m) in actual-world units, regardless of
scale.
76
Creating Models
Text Height Multiplier Increases or decreases the default size of the text
associated with element labeling by the factor indicated.
The program automatically selects a default text height
that displays at approximately 2.5 mm (0.1 in) high at the
user-defined drawing scale. A scale of 1.0 mm = 0.5 m,
for example, results in a text height of approximately 1.25
m. Likewise, a 1 in. = 40 ft. scale equates to a text height
of around 4.0 ft.
Text Options
Align Text with Pipes Turns text alignment on and off. When it is turned on,
labels are aligned to their associated pipes. When it is
turned off, labels are displayed horizontally near the
center of the associated pipe.
Color Element Annotations When this box is checked, color coding settings are
applied to the element annotation.
Options Dialog Box - Units Tab

The Units tab modifies the unit settings for the current project.
77
Creating Models
The Units tab contains the following controls:
Save As Saves the current unit settings as a separate .xml file. This
file allows you to reuse your Units settings in another
project. When the button is clicked, a Windows Save As
dialog box opens, allowing you to enter a name and
specify the directory location of the .xml file.
Load Loads a previously created Units project .xml file, thereby

transferring the unit and format settings that were defined
in the previous project. When the button is clicked, a
Windows Load dialog box opens, allowing you to browse
to the location of the desired .xml file.
Reset Defaults - SI Resets the unit and formatting settings to the original
factory defaults for the System International (Metric)
system.
78
Creating Models
Reset Defaults - US Resets the unit and formatting settings to the original
factory defaults for the Imperial (U.S.) system.
Default Unit System for New Project Specifies the unit system that is used globally across the
project. Note that you can locally change any number of
attributes to the unit system other than the ones specified
here.
Units Table The units table contains the following columns: Label
Displays the parameter measured by the unit. Unit
Displays the type of measurement. To change the unit of
an attribute type, click the choice list and click the unit
you want. This option also allows you to use both U.S.
customary and SI units in the same worksheet. Display
Precision Sets the rounding of numbers and number of
digits displayed after the decimal point. Enter a number
from 0 to 15 to indicate the number of digits after the
decimal point. Format Menu Selects the display format
used by the current field. Choices include: Scientific
Converts the entered value to a string of the form "-
d.ddd...E+ddd" or "-d.ddd...e+ddd", where each 'd'
indicates a digit (0-9). The string starts with a minus sign
if the number is negative. Fixed Point Abides by the
display precision setting and automatically enters zeros
after the decimal place to do so. With a display precision
of 3, an entered value of 3.5 displays as 3.500. General
Truncates any zeros after the decimal point, regardless of
the display precision value. With a display precision of 3,
the value that would appear as 5.200 in Fixed Point
format displays as 5.2 when using General format. The
number is also rounded. So, an entered value of 5.35
displays as 5.4, regardless of the display precision.
Number Converts the entered value to a string of the
form "-d,ddd,ddd.ddd...", where each 'd' indicates a digit
(0-9). The string starts with a minus sign if the number is
negative. Thousand separators are inserted between each
group of three digits to the left of the decimal point.
Note: The conversion for pressure to ft. (or m) H20 uses the specific gravity of water at 4C (39F), or a specific
gravity of 1. Hence, if the fluid being used in the simulation uses a specific gravity other than 1, the sum of the
pressure in ft. (or m) H20 and the node elevation will not be exactly equal to the calculated hydraulic grade line
(HGL).
Options Dialog Box - Labeling Tab

The Element Labeling tab is used to specify the automatic numbering format of new elements as they are added to the
network. You can save your settings to an .xml file for later use.
79
Creating Models
The Element Labeling tab contains the following controls:
Save As Saves your element labeling settings to an element label

project file, which is an. xml file.
Load Opens an existing element label project file.
Reset Assigns the correct Next value for all elements based on
the elements currently in the drawing and the user-defined
values set in the Increment, Prefix, Digits, and Suffix
fields of the Labeling table.
80
Creating Models
Labeling Table The labeling table contains the following columns:

Element Shows the type of element to which the label
applies. On Turns automatic element labeling on and
off for the associated element type. Next Type the
integer you want to use as the starting value for the ID
number portion of the label. WaterGEMS V8i generates
labels beginning with this number and chooses the first
available unique label. Increment Type the integer that
is added to the ID number after each element is created to
yield the number for the next element. Prefix Type the
letters or numbers that appear in front of the ID number
for the elements in your network. Digits Type the
minimum number of digits that the ID number has. For
instance, 1, 10, and 100 with a digit setting of two would
be 01, 10, and 100. Suffix Type the letters or numbers
that appear after the ID number for the elements in your
network. Preview Displays what the label looks like
based on the information you have entered in the previous
fields.
Options Dialog Box - ProjectWise Tab

The ProjectWise tab contains options for using WaterGEMS V8i with ProjectWise.
This tab contains the following controls:
Default Datasource Displays the current ProjectWise datasource. If you have

not yet logged into a datasource, this field will display
<login>. To change the datasource, click the Ellipses (...)
to open the Change Datasource dialog box. If you click
Cancel after you have changed the default datasource, the
new default datasource is retained.
81
Creating Models
Update server on Save When this is turned on, any time you save your
WaterGEMS V8i project locally using the File > Save
menu command, the files on your ProjectWise server will
also be updated and all changes to the files will
immediately become visible to other ProjectWise users.
This option is turned off by default.
Note: This option, when turned on, can significantly

affect performance, especially for large, complex
projects.
Note: These settings affect ProjectWise users only.
For more information about ProjectWise, see the Working with ProjectWise (on page 82) topic.
Options Dialog Box - Engine Tab

This tab contains engine settings. You can set the number of parallel fire flow calculations in this tab.
The Engine tab contains the following control:
Parallel Fire Flow Calculations The number of threads listed will be based on the
machine's available threads.
Virtual (e.g. hyperthreading) threads will be included in
the counts. Note that in some cases choosing a higher
number may not be faster (in the case of hyperthreading),
so it is best to do timings to see what works best.
Working with ProjectWise

Bentley ProjectWise provides managed access to WaterGEMS V8i content within a workgroup, across a distributed
organization, or among collaborating professionals. Among other things, this means that only one person is allowed to
edit the file at a time, and document history is tracked. When a WaterGEMS V8i project is stored using ProjectWise,
project files can be accessed quickly, checked out for use, and checked back in directly from within WaterGEMS V8i.
With ProjectWise Explorer, it is possible to read the file's audit trail to determine who edited the file and when that
occurred.
If ProjectWise Explorer is installed on your computer, WaterGEMS V8i automatically installs all the components
necessary for you to use ProjectWise to store and share your WaterGEMS V8i projects. A WaterGEMS V8i project
consists of a *.wtg file, a *.wtg.sqlite file, and in the case of a standalone model a *.dwh file.
To learn more about ProjectWise, refer to the ProjectWise online help.
Follow these guidelines when using WaterGEMS V8i with ProjectWise:
ProjectWise integration must be enabled before WaterGEMS V8i can directly interact with ProjectWise. Refer to
the "Setting up ProjectWise Integration" section for more details.
Once ProjectWise integration is enabled, use the normal Open/Save commands to access the ProjectWise
datasources. A Datasource refers to a collection of folders and documents set up by the ProjectWise Administrator.
The File > Open operation, for example, will first show the ProjectWise file browser, where you can open a project
82
Creating Models
that is already saved into ProjectWise. File > SaveAs can be used to save any project into ProjectWise, whether it
exists in ProjectWise or locally on your system's disk.
The first time the ProjectWise prompt is opened in your current WaterGEMS V8i session, you are prompted to log
into a ProjectWise datasource. The datasource you log into remains the current datasource until you change it via
the ProjectWise tab of the Global Options in WaterGEMS V8i Tools. The user needs to know the name of the
Datasource, a user name and a password.
If a project is opened from ProjectWise, then all subsequent open/save operations will prompt to open/save the file
to ProjectWise first. At the ProjectWise prompt you can click the Cancel button to get a Windows file browse
prompt if you want to pick a file on your local system or network. This applies to cases like import/export, as well
as any other file selection operation such as picking a file for ModelBuilder to use, or referencing a file with
Hyperlinks. If the current project is not opened from ProjectWise however, you will only be allowed to choose files
on your local system or network.
Use the WaterGEMS V8i File > New command to create a new project. The project is not stored in ProjectWise
until you perform a File > Save As operation.
Use the WaterGEMS V8i File > Save command to save a copy of the current project to your local computer.
When you Close a project already stored in ProjectWise using File > Close, you are prompted to select one of the
following options: Check InUpdates the project files in ProjectWise with your latest changes and unlocks the
project so other ProjectWise users can edit it. UnlockUnlocks the project files so other ProjectWise users can edit
it but does not update the project in ProjectWise. Note that this will abandon any changes you have made since the
last Check-in command. Leave OutLeaves the project checked out so others cannot edit it and retains any
changes you have made since the last server update to the files on your local computer. Select this option if you
want to exit Bentley WaterGEMS V8i but continue working on the project later. The project files may be
synchronized when the files are checked in later.
In the WaterGEMS V8i Options dialog box, there is a ProjectWise tab with a Update server on Save check box.
This option, when turned on, can significantly affect performance, especially for large, complex projects. When this
is checked, any time you save your WaterGEMS V8i project locally using the File > Save menu command, the files
on your ProjectWise server will also be updated and all changes to the files will immediately become visible to
other ProjectWise users. This option is turned off by default, which means the ProjectWise server version of the
project will not be updated until the files are checked in.
Use the File > Update Server Copy command to update the files on your ProjectWise server with all changes made
to the files, which will immediately become visible to other ProjectWise users. Note that this command saves the
project and any edits that have been made before it updates the ProjectWise files.
In the SS2 release of WaterGEMS V8i, calculation result files are not managed inside ProjectWise. A local copy of
results is maintained on the user's computer, but to ensure accurate results the user should recalculate desired
scenarios for projects when the user first opens them from ProjectWise.
WaterGEMS V8i projects associated with ProjectWise appear in the Most Recently Used Files list (at the bottom of
the File menu) in the following format: pw://PointServer:_TestDatasource/Documents/TestFolder/Test1
Performing ProjectWise Operations from within WaterGEMS V8i
You can quickly tell whether or not the current WaterGEMS V8i project is in ProjectWise or not by looking at the title
bar and the status bar of the WaterGEMS V8i window. If the current project is in ProjectWise, "pw://" will appear in
front of the file name in the title bar, and a ProjectWise icon will appear on the far right side of the status bar, as shown
here:
If you have enabled ProjectWise integration, you can perform the following ProjectWise operations from within
WaterGEMS V8i:
1. In WaterGEMS V8i, select File > Save As.
83
Creating Models
2. If you haven't already logged into ProjectWise, you are prompted to do so. Select a ProjectWise datasource, type
your ProjectWise user name and password, then click Log in.
3. In the ProjectWise Save Document dialog box, enter the following information: Click Change next to the Folder
field, then select a folder in the current ProjectWise datasource in which to store your project. Type the name of
your WaterGEMS V8i project in the Name field. It is best to keep the ProjectWise name the same as or as close to
the WaterGEMS V8i project name as possible. Keep the default entries for the rest of the fields in the dialog box.
Click OK. There will be two new files in ProjectWise; a *.wtg and a *.wtg.sqlite.
To open a WaterGEMS V8i project from a ProjectWise datasource from within WaterGEMS V8i:
1. Select File > Open.
3. In the ProjectWise Select Document dialog box, perform these steps: From the Folder drop-down menu, select a
folder that contains WaterGEMS V8i projects. In the Document list box, select a WaterGEMS V8i project. Keep the
default entries for the rest of the fields in the dialog box. Click Open.
To open a WaterGEMS V8i project from ProjectWise, it is also possible to double click on the project in ProjectWise.
To copy an open WaterGEMS V8i project from one ProjectWise datasource to another:
1. Select File > Open to open a project stored in ProjectWise.
2. Go to Tools > Options, and on the ProjectWise tab click to change the default datasource.
3. In the ProjectWise Log in dialog box, select a different ProjectWise datasource, then click Log in.
4. Select File > Save As.
5. In the ProjectWise Save Document dialog box, change information about the project as required, then click OK.
To make a local copy of a WaterGEMS V8i project stored in a ProjectWise datasource:
1. Select File > Open.
3. Select File > Save As.
4. At the ProjectWise save prompt click Cancel.
5. Save the WaterGEMS V8i project to a folder on your local computer.
To change the default ProjectWise datasource:
1. Start WaterGEMS V8i.
2. Select Tools > Options> ProjectWise tab.
3. Change the Default Datasource to the one you want to log into.
To use background layer files with ProjectWise:
Using File > Save As-If there are background files assigned to the model, the user is prompted with two options:
copy the background layer files to the project folder for use by the project, or remove the background references and
manually reassign them once the project is in ProjectWise to other existing ProjectWise documents.
Using File > Open-Using this method, background layer files are not locked in ProjectWise for the current user to
edit. The files are intended to be shared with other users at the same time.
To add a background layer file reference to a project that exists in ProjectWise:
Using File > Save As-When you use File > Save As on a project that is already in ProjectWise and there are
background layer files, you are prompted with two options: you can copy all the files to the local project folder for use
84
Creating Models
by the project, or you can remove the background references and manually reassign them after you have saved the
project locally.
Note: When you remove a background layer file reference from a project that exists in ProjectWise, the reference
to the file is removed but the file itself is not deleted from ProjectWise.
Setting Up ProjectWise Integration

Before you may interact with ProjectWise from inside the WaterGEMS V8i application, you must integrate it to work
with ProjectWise. This step varies depending on the platform under which you wish to integrate. Until you set up this
ProjectWise integration the file prompts in the application will not allow interaction with ProjectWise datasources.
For the Standalone platform, you must edit the ProjectWiseIntegrationLocalOptions.xml file using a text editor. The
file is located in the All User documents directory:
In Windows XP: C:\Documents and Settings\All Users\Application Data\Bentley\<ProductName>\8
In Windows Vista/Windows 7/Windows 8: C:\ProgramData\Bentley\<ProductName>\8
Find the line that sets the PWDIR variable:
PWDIR=""
and change it so that it refers to the directory where a supported version of the ProjectWise Explorer is installed, such
as:
PWDIR="C:\Program Files\Bentley\ProjectWise\"
For the MicroStation platform, you must enable the ProjectWise iDesktop integration for Microstation when installing
the ProjectWise Explorer client software. You can also Change the ProjectWise Explorer installation to enable this
from the Windows Control Panel.
The ArcGIS platform will automatically detect an installed ProjectWise Explorer, but to interact with ProjectWise in
ArcGIS you must use the explicit ProjectWise menu commands.
About ProjectWise Geospatial

ProjectWise Geospatial gives spatial context to Municipal Products Group product projects in their original form. An
interactive map-based interface allows users to navigate and retrieve content based upon location. The environment
includes integrated map management, dynamic coordinate system support, and spatial indexing tools.
ProjectWise Geospatial supports the creation of named spatial reference systems (SRSs) for 2D or 3D cartesian
coordinate systems, automatic transformations between SRSs, creation of Open GIS format geometries, definition of
spatial locations, association of documents and folders with spatial locations, and the definition of spatial criteria for
document searching.
A spatial location is the combination of a geometry for a project plus a designated SRS. It provides a universal
mechanism for graphically relating ProjectWise documents and folders.
The ProjectWise administrator can assign background maps to folders, against which the contained documents or
projects will be registered and displayed. For documents such as Municipal Products Group product projects,
ProjectWise Geospatial can automatically retrieve the embedded spatial location. For documents that are nonspatial, the
document can simply inherit the location of the folder into which it is inserted, or users can explicitly assign a location,
either by typing in coordinates, or by drawing them.
85
Creating Models
Each document is indexed to a universal coordinate system or SRS, however, the originating coordinate system of each
document is also preserved. This enables search of documents across the boundary of different geographic, coordinate,
or engineering coordinate systems.
Custom geospatial views can be defined to display documents with symbology mapped to arbitrary document
properties such as author, time, and workflow state.
For a complete description of how to work with ProjectWise Geospatial, for example how to add background maps and
coordinate systems, see the ProjectWise Geospatial Explorer Guide and the ProjectWise Geospatial Administrator
Guide.
Maintaining Project Geometry
A spatial location is comprised of an OpenGIS-format geometry plus a Spatial Reference System (SRS). For Municipal
Products Group product projects, the product attempts to automatically calculate and maintained this geometry, as the
user interacts with the model. Most transformations such as additions, moves, and deletes result in the bounding box or
drawing extents being automatically updated.
Whenever the project is saved and the ProjectWise server is updated, the stored spatial location on the server, which is
used for registration against any background map, will be updated also. (Note the timing of this update will be affected
by the "Update Server When Saving" option on the Tools-Options-ProjectWise tab.)
Most of the time the bounding box stored in the project will be correct. However, for performance reasons, there are
some rare situations (e.g., moving the entire model) where the geometry can become out of date with respect to the
model. To guarantee the highest accuracy, the user can always manually update the geometry by using "Compact
Database" or "Update Database Cache" as necessary, before saving to ProjectWise.
Setting the Project Spatial Reference System
The Spatial Reference System (SRS) for a project is viewed and assigned on the Tools-Options-Project tab in the
Geospatial group.
The SRS is a standard textual name for a coordinate system or a projection, designated by various national and
international standards bodies. The SRS is assumed to define the origin for the coordinates of all modeling elements in
the project. It is the user's responsibility to set the correct SRS for the project, and then use the correct coordinates for
the contained modeling elements. This will result in the extents of the modeling features being correct with respect to
the spatial reference system chosen. The SRS is stored at the project database level. Therefore, a single SRS is
maintained across all geometry alternatives. The product does not manipulate or transform geometries or SRS's - it
simply stores them.
The primary use of the project's SRS is to create correct spatial locations when a managing a project in the ProjectWise
Integration Server's spatial management system.
The SRS name comes from the internal list of spatial reference systems that ProjectWise Spatial maintains on the
ProjectWise server and is also known as the "key name." To determine the SRS key name, the administrator should
browse the coordinate system dictionary in the ProjectWise administrator tool (under the Coordinate Systems node of
the datasource), and add the desired coordinate system to the datasource. For example, the key name for an SRS for
latitude/longitude is LL84, and the key name for the Maryland State Plane NAD 83 Feet SRS is MD83F.
ProjectWise Spatial uses the SRS to re-project the project's spatial location to the coordinate system of any spatial view
or background map assigned by the administrator.
If the project's SRS is left blank, then ProjectWise will simply not be updated with a spatial location for that project.
86
Creating Models
If the project's SRS is not recognized, an error message will be shown, and ProjectWise will simply not be updated with
a spatial location for that project.
Interaction with ProjectWise Explorer
Geospatial Administrators can control whether users can edit spatial locations through the ProjectWise Explorer. This is
governed by the checkbox labeled "This user is a Geospatial Administrator" on the Geospatial tab of the User
properties in the ProjectWise Administrator.
Users should decide to edit spatial locations either through the ProjectWise Explorer, or through the Municipal
application, but not both at the same time. The application will update and overwrite the spatial location (coordinate
system and geometry) in ProjectWise as a project is saved, if the user has added a spatial reference system to the
project. This mechanism is simple and flexible for users - allowing them to choose when and where spatial locations
will be updated.
Note: If the spatial reference system referenced by the project does not exist in the ProjectWise datasource, the
user will receive a warning and the spatial location will not be saved. The user may then add the spatial
reference system to the datasource, through the Geospatial Administrator, before re-saving.
ProjectWise Cross-Discipline Coordination Services Support

ProjectWise Cross-discipline Coordination Services (henceforth referred to as PWXDCS) refers to a shared library of
code and tools used to facilitate the communication of model engineering data between 2 (or more) separate
applications. For example, suppose building construction software wants to communicate relevant information about
the model with software being used to design the parking lot for the building. PWXDCS allows this communication
through a separate store of information called a consensus repository. This consensus repository has a schema called the
consensus schema. The consensus schema only contains those fields/attributes that are common/relevant to software
using it to sync data (in this example, the common fields/attributes between the building software and the parking lot
software).
This is the basic workflow:
Water/Storm/Sewer Products publish their changes to an application repository. An application schema is adhered so
that only relevant properties are published.
87
Creating Models
A consensus repository exists in some shared location (perhaps on a server of some sort) and may be in a completely
different (consensus) schema. If the schema is incompatible with the schema of the applications using it, transformation
services need to be written to transform data between the two schemas.
Bentley Water/Storm/Sewer products only write our data out to the application repository, so the part of the process
handled by those products looks like this:
Workflow Walkthrough
Initial creation of a consensus repository:
1. Open a model you want to sync out.
2. Click File menu, select Repository Management -> Create Repository.
3. Select the name and location of the consensus repository.
4. Progress dialogs appear.
5. After the process is complete, the repository file (*.dgn) should be on the disk where you indicated.
Sync out changes to existing consensus repository:
1. Open the model you want to sync out.
2. Click File menu, select Repository Management -> Update Repository.
3. Pick the consensus repository you want to update.
4. Progress dialogs appear.
5. A dialog appears displaying what has changed since the last time you synced out.
6. Accept/reject the changes you want/don't want.
7. The consensus repository is updated.
Differences Dialog Box
The Differences dialog appears when you update a repository. It shows the differences between the previous head
revision and the new about-to-be-created revision. The user can select which changes they want to accept (keep) and
which they would like to reject (ignore).
88
Creating Models
Going from left-to-right across the top toolbar of the upper section of the dialog, the buttons are as follows:
Home: Restores the grid view back to its original state after following any relationships.
Back: Goes back a step after following any relationships.
Filter: Filters on an elements of the chosen types.
Show Added: Toggles the showing of newly added elements in the grid view.
Show Deleted: Toggles the showing of the newly deleted elements in the grid view.
Show Modified: Toggles the showing of the newly modified elements in the grid view.
Show Unchanged: Toggles the showing of the elements that haven't changed since the latest repository revision.
Show Accepted: Toggles the showing of elements whose changes have all been accepted.
Show Rejected: Toggles the showing of elements whose changes have all been rejected.
Show Partial: Toggles the showing of elements whose changes are a mixture of accepted, rejected, and undecided.
Show Undecided: Toggles the showing of elements whose changes are all undecided.
The grid view lists the elements (filtered as described above):
Check Box: Selects/deselects the element as part of the set of elements affected by the bottom toolbar (described
below).
89
Creating Models
Type: The element type.

Label: The element's label.
Status: The status (added, deleted, modified, etc.) of the element.
Change: The current state of the decision to include the changes or not (accepted, rejected, etc.).
Going from left-to-right across the bottom toolbar of the upper section of the dialog, the buttons are as follows:
Select All: Checks all of the check boxes for the elements listed in the grid view above it.
Clear All: Unchecks all of the check boxes for the elements listed in the grid view above it.
Accept: Sets the change state of all of the checked elements in the grid view above it to accepted.
Reject: Sets the change state of all of the checked elements in the grid view above it to rejected.
Undecide: Sets the change state of all of the checked elements in the grid view above it to undecided.
Selected Objects: Gives the count of elements in the grid view above it that are checked.
In the lower section of the dialog, the Properties tab shows the properties of the currently selected elements in the grid
view of the upper section of the dialog.
Going from left-to-right across the top toolbar of the lower section of the dialog, the buttons are as follows:
Show Added: Toggles the showing of newly added properties in the grid view.
Show Deleted: Toggles the showing of the newly deleted properties in the grid view.
Show Modified: Toggles the showing of the newly modified properties in the grid view.
Show Unchanged: Toggles the showing of the properties that haven't changed since the latest repository revision.
Show Accepted: Toggles the showing of properties that have been accepted.
Show Rejected: Toggles the showing of properties that have been rejected.
Show Undecided: Toggles the showing of properties that are still undecided.
The grid view lists the elements (filtered as described above):
Check Box: Selects/deselects the property as part of the set of properties affected by the bottom toolbar (described
below).
Property: The name of the property.
New Value: The new (changed) value of the property.
Old Value: The previous value of the property.
Status: The status (added, deleted, modified, etc.) of the property.
Change: The current state of the decision to include the change or not (accepted, rejected, etc.).
Going from left-to-right across the bottom toolbar of the lower section, the buttons are as follows:
Select All: Checks all of the check boxes for the properties listed in the grid view above it.
Clear All: Unchecks all of the check boxes for the properties listed in the grid view above it.
Accept: Sets the change state of all of the checked properties in the grid view above it to accepted.
Reject: Sets the change state of all of the checked properties in the grid view above it to rejected.
Undecide: Sets the change state of all of the checked properties in the grid view above it to undecided.
Selected Properties: Gives the count of properties in the grid view above it that are checked.
At the bottom of the dialog are the following buttons:
1. Update: commits the decisions on the changes you've made in this dialog to the repository.
2. Cancel: Cancels out of the dialog and the entire update operation. The repository is left as it was unchanged.
90
Creating Models
Elements and Element Attributes
Pipes
Pipes are link elements that connect junction nodes, pumps, valves, tanks, and reservoirs. Each pipe element must
terminate in two end node elements.
Note: When laying out a pipe, you can add bends by holding the Ctrl key and clicking.
Applying a Zone to a Pipe

You can group elements together by any desired criteria through the use of zones. A Zone can contain any number of
elements and can include a combination of any or all element types. For more information on zones and their use, see
the Zones topic.
To Apply a Previously Created Zone to a Pipe:
1. Click the pipe in the Drawing View.
2. In the Properties window, click the menu in the Zone field and choose the zone from the drop-down list.
Choosing a Pipe Material
Pipes can be assigned a material type chosen from an engineering library. Each material type is associated with various
pipe properties, such as roughness coefficient and roughness height. When a material is selected, these properties are
automatically assigned to the pipe.
To Select a Material for a Pipe From the Standard Material Library:
1. Select the pipe in the Drawing View.
2. In the Properties window, click the ellipsis (...) in the Material field.
3. The Engineering Libraries dialog box opens.
4. Choose Material Libraries > MaterialLibraries.xml.
5. Select the material and click Select.
Adding a Minor Loss Collection to a Pipe
Pressure pipes can have an unlimited number of minor loss elements associated with them. WaterGEMS V8i provides
an easy-to-use table for editing these minor loss collections in the Minor Loss Collection dialog box.
To add a minor loss collection to a pressure pipe:
1. Click a pressure pipe in your model to display the Property Editor, or right-click a pressure pipe and select
Properties from the shortcut menu.
2. In the Physical: Minor Losses section of the Property Editor, set the Specify Local Minor Loss? value to False.
3. Click the Ellipses (...) button next to the Minor Losses field.
4. In the Minor Loses dialog box, each row in the table represents a single minor loss type and its associated headloss
coefficient. For each row in the table, perform the following steps: Type the number of minor losses of the same
type to be added to the composite minor loss for the pipe in the Quantity column, then press the Tab key to move to
the Minor Loss Coefficent column. Click the arrow button to select a previously defined Minor Loss, or click the
Ellipses (...) button to display the Minor Loss Coefficients to define a new Minor Loss.
5. When you are finished adding minor losses to the table, click Close. The composite minor loss coefficient for the
minor loss collection appears in the Property Editor.
91
Creating Models
6. Perform the following optional steps: To delete a row from the table, select the row label then click Delete. To view
a report on the minor loss collection, click Report.
Minor Losses Dialog Box

The Minor Loss Collection dialog box contains buttons and a minor loss table. The dialog box contains the following
controls:
New This button creates a new row in the

table.
Delete This button deletes the currently

highlighted row from the table. You
can hold down the Ctrl key while
clicking on items in the list to select
multiple entries at once.
Report Opens a print preview window

containing a report that details the
input data for this dialog box.
The table contains the following columns:
Column Description
Quantity The number of minor losses of the same type to be added

to the composite minor loss for the pipe.
92
Creating Models
Minor Loss Coefficient The type of minor loss element. Clicking the arrow button
allows you to select from a list of previously defined
minor loss coefficients. Clicking the Ellipses button next
to this field displays the Minor Loss Coefficients manager
where you can define new minor loss coefficients.
K Each The calculated headloss coefficient for a single minor loss

element of the specified type.
K Total The total calculated headloss coefficient for all of the

minor loss elements of the specified type.
Minor Loss Coefficients Dialog Box

The Minor Loss Coefficients dialog box allows you to create, edit, and manage minor loss coefficient definitions.
The following management controls are located above the minor loss coefficient list pane:
Creates a new Minor Loss Coefficient.
New
Creates a copy of the currently highlighted minor loss

coefficient.
Duplicate
93
Creating Models
Deletes the minor loss coefficient that is currently

highlighted in the list pane.
Delete
Renames the minor loss coefficient that is currently

Rename
Opens a report of the data associated with the minor loss

coefficient that is currently highlighted in the list pane.
Report
Browses the Engineering Library, synchronizes to or from

the library, imports from the library or exports to the
Synchronization Options library.
The tab section is used to define the settings for the minor loss that is currently highlighted in the minor loss list pane.
Minor Loss Tab This tab consists of input data fields that allow you to
define the minor loss.
Minor Loss Type General type of fitting or loss element. This field is used
to limit the number of minor loss elements available in
choice lists. For example, the minor loss choice list on the
valve dialog box only includes minor losses of the valve
type. You cannot add or delete types.
Minor Loss Coefficient Headloss coefficient for the minor loss. This unitless
number represents the ratio of the headloss across the
minor loss element to the velocity head of the flow
through the element.
Library Tab This tab displays information about the minor loss that is
currently highlighted in the minor loss list pane. If the
minor loss is derived from an engineering library, the
synchronization details can be found here. If the minor
loss was created manually for this project, the
synchronization details will display the message Orphan
(local), indicating that the minor loss was not derived
from a library entry.
Notes Tab This tab contains a text field that is used to type
descriptive notes that will be associated with the minor
loss that is currently highlighted in the minor loss list
pane.
Wave Speed Calculator

The wave speed calculator allows you to determine the wave speed for a pipe or set of pipes.
94
Creating Models
The dialog consists of the following controls:
Bulk Modulus of Elasticity The bulk modulus of elasticity of the liquid. Click the
ellipsis button to choose a liquid from the Liquid
Engineering Library. Choosing a liquid from the library
will populate both this field and the Specific Gravity field
with the values for the chosen liquid.
Specific Gravity The specific gravity of the liquid. Click the ellipsis button
to choose a liquid from the Liquid Engineering Library.
Choosing a liquid from the library will populate both this
field and the Bulk Modulus of Elasticity field with the
values for the chosen liquid.
Youngs Modulus The Youngs modulus of the elasticity of the pipe

material. Click the ellipsis button to choose a material
from the Material Engineering Library. Choosing a
material from the library will populate both this field and
the Poissons Ratio field with the values for the chosen
material.
Poissons Ratio The Poissons ratio of the pipe material. Click the ellipsis
button to choose a material from the Material Engineering
Library. Choosing a material from the library will
populate both this field and the Youngs Modulus field
with the values for the chosen material.
Wall Thickness The thickness of the pipe wall.
95
Creating Models
Pipeline Support Select the method of pipeline support.
All When this button is selected, the calculated Wave Speed

value will be applied to all pipes in the model.
Selection When this button is selected, the calculated Wave Speed

value will be applied to all of the pipes that are currently
selected in the model.
Selection Set When this button is selected, the calculated Wave Speed
value will be applied to all of the pipes contained within
the specified selection set.
Junctions
Junctions are non-storage nodes where water can leave the network to satisfy consumer demands or enter the network
as an inflow. Junctions are also where chemical constituents can enter the network. Pipes are link elements that connect
junction nodes, pumps, valves, tanks, and reservoirs. Each pipe element must terminate in two end node elements.
Assigning Demands to a Junction
Junctions can have an unlimited number of demands associated with them. Demands are assigned to junctions using the
Demands table to define Demand Collections. Demand Collections consists of a Base Flow and a Demand Pattern. If
the demand doesnt vary over time, the Pattern is set to Fixed.
To Assign a Demand to a Junction
1. Select the Junction in the Drawing View.
2. In the Properties window, click the ellipsis (...) button in the Demand Collection field under the Demands heading.
3. In the Demands dialog that opens, enter the base demand in the Flow column.
4. Click the arrow button to assign a previously created Pattern, click the ellipsis button to create a new Pattern in the
Patterns dialog, or leave the value at Fixed (Fixed means the demand doesnt vary over time).
Applying a Zone to a Junction
Zones (on page 214).
To Apply a Previously Created Zone to a Junction
1. Select the junction in the Drawing View.
2. In the Properties window, click the menu in the Zone field and select the zone you want.
Demand Collection Dialog Box

The Demand collection dialog box allows you to assign single or composite demands and demand patterns to the
elements in the model.
96
Creating Models
Unit Demand Collection Dialog Box

The Unit Demand Collection dialog box allows you to assign single or composite unit demands to the elements in the
model.
To assign one or more unit demands:
1. Specify the Unit Demand count.
2. Select a previously created Unit Demand from the list or click the ellipsis button to open the Unit Demands Dialog
Box, allowing you to create a new one.
3. Select a previously created Demand Pattern from the list or click the ellipsis button to open the Pattern Manager,
allowing you to create a new one.
Export
Junctions with Demands
Junctions with demands have two behaviors during a transient analaysis:
(a) If the pressure P is positive, then it acts like an orifice discharging to atmosphere wherein the outflow/demand is Q
=
Qi. summed over all the connected branches, i. The pressure varies quadratically with the discharge from the initial
conditions - so that the diameter of the orifice is not explicitly required by the transient solver;
(b) on the other hand when the pressure drops below zero, there is no net inflow or outflow (Q = 0), while if the
pressure declines to the vapor pressure of the liquid, the rate of change of the vapor volume, Xi, in each branch is
described by the relation dXi / dt = - Qi.
Junctions without Demands
The continuity equation for the junction of two or more pipes states that the net inflow Q =
97
Creating Models
Qi is zero when the pressure P exceeds the liquid's vapor pressure. On the other hand, at vapor pressure, the volume in
each branch Xi grows in time according to the ordinary differential equation dXi / dt = - Qi.
Dead End Junctions
During a transient analysis, a junction with no demand and only one pipe connected to it is treated as a dead-end
junction by the transient solver.
Dead ends are important during a transient analysis because large positive pressure waves tend to 'reflect' off a dead end
as negative pressure waves of the same magnitude. If the initial static pressure is too low, this can cause cavitation.
When the pressure reaches the vapor pressure of the liquid, the equation dX1 / dt = - Q1 serves to provide the rate of
change of the volume of the cavity.
Hydrants
Hydrants are non-storage nodes where water can leave the network to satisfy consumer demands or enter the network
as an inflow. Hydrants are also where chemical constituents can enter the network.
Applying a Zone to a Hydrant
To Apply a Previously Created Zone to a Hydrant
1. Select the hydrant in the Drawing View.
Hydrant Flow Curves
Hydrant curves allow you to find the flow the distribution system can deliver at the specified residual pressure, helping
you identify the system's capacity to deliver water that node in the network. See following topics for more information
about Hydrant Flow Curves:
Hydrant Flow Curve Manager

The Hydrant Flow Curve Manager consists of the following controls:
New Creates a new hydrant flow curve definition.
Delete Deletes the selected hydrant flow curve definition.
Rename Renames the label for the current hydrant flow curve
definition.
Edit Opens the hydrant flow curve definition editor for the
currently selected definition.
Refresh Recomputes the results of the currently selected hydrant

flow curve definition.
Help Opens the online help for the hydrant flow curve
manager.
98
Creating Models
Hydrant Flow Curve Editor

Hydrant curves allow you to find the flow the distribution system can deliver at the specified residual pressure, helping
you identify the system's capacity to deliver water that node in the network. Hydrant curves are useful when you are
trying to balance the flows entering a part of the network, the flows being demanded by that part of the network, and
the flows being stored by that part of the network.
The Hydrant Flow Curve Editor dialog displays the flow vs pressure table, which is computed by the program; the table
is in part based on the Nominal Hydrant Flow and Number of Intervals values you define, which are used for
formatting of the curve.
99
Creating Models
Nominal Hydrant Flow: This value should be the expected nominal flow for the hydrant (i.e., the expected flow or
desired flow when the hydrant is in use). The value for nominal flow is used together with the number of intervals
value to determine a reasonable flow step to use when calculating the hydrant curve. A higher nominal flow value
results in a larger flow step and better performance of the calculation. Note that if you choose a nominal hydrant
flow that is too small and not representative of the hydrant then the high flow results on the resultant curve may not
be correct since the calculation will not calculate more than 1000 points on the curve, for performance reasons.
Number of Intervals: This value is used with the nominal flow value to determine the flow step to be used with the
hydrant calculation. For example, a nominal hydrant flow of 1000gpm and number of intervals set to 10 will result
in a flow step of 1000/10 = 100gpm. This results in points on the hydrant curve being calculated from 0 flow to the
zero pressure point in steps of 100gpm. Note that if you have a number of intervals value that is too high then high
flow results on the resultant curve may not be correct since the calculation will not calculate more than 1000 points
on the curve, for performance reasons.
Time: Choosing the time of the hydrant curve can affect the results of the curve. Choose the time at which you wish
to run your hydrant curve and the corresponding pattern multipliers will be used for that time. This behaves the
same way as an EPS snapshot calculation. You may also select multiple times in order to generate multiple hydrant
curves for comparison
To define a Hydrant Flow Curve
Choose the junction or hydrant element that will be used for the hydrant flow curve from the Hydrant/Junction pull-
down menu or click the ellipsis button to select the element from the drawing pane.
Enter values for Nominal Hydrant Flow and Number of Intervals in the corresponding fields.
Choose a time step from the Time list pane.
Click the Compute button to calculate the hydrant flow curve.
100
Creating Models
Hydrant Lateral Loss

Hydrant lateral losses are calculated by the pressure engine the same as any pipe (the lateral pipe is actually loaded into
the model), using the supplied lateral diameter, minor loss coefficient and length. Additionally, the engine assumes the
following values:
Darcy Weisbach e: 0.0009
Hazen Williams C: 130.0
Mannings n: 0.012
Tanks
Tanks are a type of Storage Node. A Storage Node is a special type of node where a free water surface exists, and the
hydraulic head is the elevation of the water surface above some datum (usually sea level). The water surface elevation
of a tank will change as water flows into or out of it during an extended period simulation.
Water Level/Elevation
The user can choose either Elevation or Level as the Operating Range Type. The water level in a tank can be described
based on either the hydraulic grade line elevation (Elevation) or the water level above the base elevation (Level).
Applying a Zone to a Tank
You can optionally group elements together by any desired criteria through the use of zones. A Zone can contain any
number of elements and can include a combination of any or all element types. For more information on zones and their
use, see Zones (on page 214).
To Apply a Previously Created Zone to a Tank
1. Select the tank in the Drawing View.
Active Topology
By default a tank is active in a model. A tank can be made inactive (not used in calculations) by changing the Is active?
property to False. If a tank is made inactive, any connective pipes should also be made inactive as otherwise this will
give an error.
Defining the Cross Section of a Variable Area Tank
By default, tanks are treated as having a circular shape with a constant cross section described by its diameter. If the
tank has a constant cross section that is not circular, the user can select Non-circular and specify the cross sectional
area. If the user selects Variable Area, it is necessary to provide a depth to volume table.
In a variable area tank, the cross-sectional geometry varies between the minimum and maximum operating elevations.
A depth-to-volume ratio table is used to define the cross sectional geometry of the tank.
101
Creating Models
To Define the Cross Section of a Variable Area Tank

1. Select the tank in the Drawing View.
2. In the Properties window, click the Section menu and select the Variable Area section type.
3. Click the ellipsis button (...) in the Cross-Section Curve field.
4. In the Cross-Section Curve dialog that appears, enter a series of points describing the storage characteristics of the
tank. For example, at 0.1 of the total depth (depth ratio = 0.1) the tank stores 0.028 of the total active volume
(volume ratio = 0.028). At 0.2 of the total depth the tank stores 0. 014 of the total active volume (0.2, 0.014), and so
on.
Setting High and Low Level Alarms
You can specify upper and lower tank levels at which user notification messages will be generated during calculation.
To set a High Level Alarm
1. Double-click a tank element to open the associated Properties editor.
2. In the Operating Range section, change the Use High Alarm? value to True.
3. In the Elevation (High Alarm) field, enter the high alarm elevation value. A high alarm user notification message
will be generated for each time step during which the tank elevation exceeds this value.
To set a Low Level Alarm
1. Double-click a tank element to open the associated Properties editor.
2. In the Operating Range section, change the Use Low Alarm? value to True.
3. In the Elevation (Low Alarm) field, enter the low alarm elevation value. A low alarm user notification message will
be generated for each time step during which the tank elevation goes below this value.
Inlet Type
102
Creating Models
In general, tank inlet and outlet piping are treated as being connected to the tank at the bottom and have only a single
altitude valve that shuts the tank off from the rest of the system when the tank reaches its maximum level or elevation.
However, some tanks are filled from the top or have altitude valves (sometimes called a "Float Valve") that gradually
throttle before they shut. This can be controlled by setting the Has Separate Inlet? Property to True. The user must pick
which of the pipes connected to the tank is the inlet pipe which is controlled or top fill. (If there is a valve vault at the
tank with a altitude valve on the fill line and a check valve on the outlet, these should be treated as two pipes from the
tank even if there is a single pipe from the tank to the vault.)
If the tank is a top filled tank (which may refer to a side inflow tank above the bottom but below the top), the user
should set Tank Fills From Top? To true and set the invert level (relative to the base) of the inflow pipe at its highest
point. Water will not flow into the tank through that pipe unless the hydraulic grade is above that elevation.
If the inlet valve throttles the flow as it nears full, the user should set "Inlet Valve Throttles?" to True. The user must
then enter the discharge coefficient for the valve when it is fully open, the level at which the valve begins to close and
the level at which it is fully closed. These levels must be below the top level and any pumps controlled by the valve
should not be set to operate at levels above the fully closed level. The closure characteristics are determined by the
Valve Type which the user selects from a drop down menu.
When the tank is described as having a separate inlet, additional results properties are calculated beyond the usual
values of tank levels (elevations) and flow. The user can also obtain the relative closure of the inlet valve, the calculated
discharge coefficient, the head loss across the valve, and the inlet and outlet hydraulic grade of the valve and finally the
inlet valve status.
Water Quality (Tanks)
If the user is performing a water quality analysis, it is necessary to specify the initial value for Age, Concentration or
Trace depending on the type of run. If the tank is a source for some water quality constituent concentration, the user
should set "Is Constituent Source?" to True and specify the constituent source type. See the Constituent Alternatives
(on page 378) help topic.
If this analysis is a constituent analysis, the user may specify the bulk reaction rate in the tank by setting "Specify local
bulk rate?" to True and setting the "Bulk reaction rate (Local)" value.
Tank Mixing Models
Real water distribution tanks cannot be exactly described as plug flow or completely mixed but these are reasonable
approximations to fluid behavior in tanks. WaterGEMS V8i supports four types of tank mixing models which the user
selects in the drop down menu of Tank Mixing Models.
The Complete Mixing model assumes that all water that enters a tank is instantaneously and completely mixed with the
water already in the tank. It applies well to a large number of facilities that operate in filland-draw fashion with the
exception of tall standpipes.
The Two-Compartment Mixing model divides the available storage volume in a tank into two compartments, both of
which are assumed completely mixed. The inlet/outlet pipes of the tank are assumed to be located in the first
compartment. New water that enters the tank mixes with the water in the first compartment. If this compartment is full,
then it sends its overflow to the second ompartment where it completely mixes with the water already stored there.
When water leaves the tank, it exits from the first compartment, which if full, receives an equivalent amount of water
from the second compartment to make up the difference. The first compartment is capable of simulating short-
circuiting between inflow and outflow while the second compartment can represent dead zones. The user must supply a
single parameter, which is the fraction of the total tank volume devoted to the first compartment. This value canbe
determined during calibration if this model is selected.
The FIFO Plug Flow model assumes that there is no mixing of water at all during its residence time in a tank. Water
parcels move through the tank in a segregated fashion where the first parcel to enter is also the first to leave. Physically
speaking, this model is most appropriate for baffled tanks that operate with simultaneous inflow and outflow such as
ideal clear wells at water treatment plants. There are no additional parameters needed to describe this mixing model.
103
Creating Models
The LIFO Plug Flow model also assumes that there is no mixing between parcels of water that enter a tank. However in
contrast to FIFO Plug Flow, the water parcels stack up one on top of another, where water enters and leaves the tank on
the bottom. This type of model might apply to a tall, narrow standpipe with an inlet/outlet pipe at the bottom and a low
momentum inflow. It requires no additional parameters be provided.
Reservoirs
Reservoirs are a type of storage node. A Storage Node is a special type of node where a free water surface exists, and
the hydraulic head is the elevation of the water surface above sea level. The water surface elevation of a reservoir does
not change as water flows into or out of it during an extended period simulation.
Applying a Zone to a Reservoir
elements, and can include a combination of any or all element types. For more information on zones and their use, see
To Apply a Previously Created Zone to a Reservoir
1. Select the reservoir in the Drawing View.
Applying an HGL Pattern to a Reservoir
You can apply a pattern to reservoir elements to describe changes in hydraulic grade line (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.
To Apply a Previously Created HGL Pattern to a Reservoir
1. Select the reservoir in the Drawing View.
2. In the Properties window, click the menu in the HGL Pattern field and select the desired pattern. To create a new
pattern, select Edit Pattern... from the list to open the Patterns dialog.
For more information about Patterns, see Patterns (on page 464).
Customer Meter Elements

Customer meter elements provide a way for users to maintain customer water demand data within WaterGEMS/CAD
which provides the user access to features such as element symbology and the ability to visualize customer location and
assignment of demand to node elements.
There are several main steps in using customer meter elements.
Creating element
Entering demands for the element
Assigning customer metering element to hydraulic model element
Customer meter elements are not directly used in hydraulic calculations but are used to load demands to elements that
are used in hydraulic calculations.
Creating Customer Meter Elements
Customer meter elements can be created by:
104
Creating Models
1. Selecting the customer meter icon from the layout toolbar and placing the customer meter in the correct position in
the drawing.
2. Importing the customer element from an external data source using ModelBuilder (see ModelBuilder help). The
data source should contain a label, the x-y coordinate and some demand data for the new element.
The customer meter element symbol is shown below. The association of the element with a node or pipe is shown as a
dashed line.
Entering Demands for Customer Meter Elements

Demand data for customer meters can be entered
1. Manually by entering values in the element property grid, the customer meter element flex table or Demand
Alternative under the Customer Meter tab.
2. Using ModelBuilder. This could be done while the elements are being created or as a separate import.
The demand data can consist of demand, unit demand, pattern (demand) and pattern (unit demand). The Demand
Control Center is not used for Customer Meter elements because there can only be a single demand and unit demand
for a customer meter.
The Property Grid for a Customer Meter element is shown below:
105
Creating Models
Assigning Demands to Modeling Elements

The demands from the customer meter element must be assigned to a hydraulic modeling element in order to be used in
hydraulic calculations. This can be done by:
1. Manually by picking the property "Associated Element" in the property grid or flex table for the customer meter
element, then choosing "Select Associated Element" from the drop down and picking the hydraulic element to
associate with the customer meter element.
2. Using ModelBuilder if the assignment of the customer meter element to a model element is available in the data
source.
3. Using LoadBuilder to assign customer meter elements to hydraulic model elements using one of LoadBuilder's
allocation methods under Customer load data such as nearest node or nearest pipe (see LoadBuilder help). In using
LoadBuilder, the "Model Node Layer" will usually be Junction\All Elements but it can be any selection set of node
elements that have Demand (Base) as a property. The "Customer Data" is usually Customer\All Elements although
it can be any selection set of Customer Meter elements. If the customers are being assigned based on nearest pipe
method, in addition to specifying the Model Node Layer and Customer Data, the user must also specify the Model
Pipe Data which identifies which pipes are to be considered. This enables the user to use a selection set which can
ignore large transmission mains with no customers.
There are no pressure, HGL or water quality results for customer meter elements as they are maintained with the
associated hydraulic element.
Displaying Customer Meter Assignments
Once the customer meter elements have been assigned to hydraulic model elements, these assignments can be viewed
as lines connecting the elements. The display of these lines can be controlled in Element Symbology > Customer meter
> Show attached Line Decorations set to either True of False.
106
Creating Models
Customer Element Behavior

During a simulation, the appropriate pattern and global multipliers are applied to the demand entered or calculated
using unit demands and this value is passed on to the associated node to be used in the hydraulic simulation. Demand
data for inactive customers are ignored.
Customer Meter Element Results
There are no hydraulic results for customer meter elements. The user should find results in the node to which the
customer element is associated. The pressures may differ from actual pressure slightly due to differences in elevation
between the junction node and the customer meter node and head losses in service lines.
Viewing Customer Meter Demands/Unit Demands from Hydraulic Element
Customer meter demands can also be viewed from the element (usually junction) to which the demand is assigned. Pick
Customer Demand Collection or Customer Unit Demand Collection in the node property grid and the demand
collection will open.
Customer Meter Element Notifications
Customer meter elements must be associated with active nodes at the time of a run. If the associated node is inactive,
the run fails and the user receives a user notification "Reference to inactive or deleted associated element." The user can
also execute a predefined query, "Customer associated with inactive element." Customer meter elements with no
association will also be detected in an "Orphaned nodes" query.
The demand pattern assigned to a customer meter must exist and be valid. If a pattern assigned to a customer meter is
later deleted and the user attempts to run the model, the run will fail and the user receives the notification "Reference to
a deleted demand pattern."
The unit demand referenced by a customer meter element must exist. If one is assigned to an element and is later
deleted, the run fails and the user receives the user notification, 'Reference to a deleted unit demand."
If the user does not associate a customer meter element with a hydraulic node, the run will complete with a warning
message, "At least one customer node without an associated element." The user can find the customer meter without an
association by looking in flex tables or executing the query for "Orphaned Customer Meters."
Customer Meter Element Predefined Queries
A user can determine the characteristics of Customer Meter element using one of the predefined queries that address
this element. In addition to the standard queries such as "All Customer Meters" and "Elements with GIS-ID", there are
some special queries for Customer Meter Elements. They include:
"Orphaned Customer Meters" which displays which customers are not connected to the network.
"Find Associated Customer Meters" which displays the customer elements associated with the hydraulic model
elements in the current selection.
"Find Elements Associated with Customer Meters" which displays the hydraulic model elements associated with the
customer meter elements in the current selection.
"Customer Meters Associated with Inactive Elements" which displays customer meter elements which have been
associated with elements that have "Is active" equals "False".
Customer Meter Zones
The zone for a particular customer meter element is automatically derived from the zone that the meter's associated
element is assigned to.
To change the zone of a customer meter you must change the zone of the associated element.
Finding customer meter elements isolated by segments or pressure zone
107
Creating Models
To find customer meters that are isolated by closing a segment, see the fourth tab (Affected Customer meters) at the
bottom of the right pane when Segmentation Results tab is selected at the top of the manager.
The user needs to use these results with caution because actual customers are located along pipes but their demands are
assigned to nodes. Depending on the location of valves, some customers may be assigned to a node that is separated
from a shutdown by a closed valve.
When using the Pressure Zone Manager, the user can find customer meters in a given pressure zone by picking the
fourth tab (Affected Customer Meters) in the bottom right pane when the Segmentation results tab is selected at the top.
Customer meters assigned to a given junction can be found by picking the ellipse button next to Customer Meter
Demands or Customer Meter Unit Demands in the property grid.
There are also two predefined queries associated with customer meters. Under queries > Network Trace, the user can
select Find Associated Customer Meters and receive a list of customer meters assigned to a selected node or Find
Elements Associated with Customer Meters and receive a list of the nodes associated with the selected customer meter
elements.
External Customer Meter Data Setup

This dialog allows the user to setup a connection to the external data source.
The data source dropdown contains all the available data source types.
The browse button allows the user to specify the file they would like to connect to. The file type in the open dialog is
determined by the file type that is selected in the Data Source drop down.
Once the file is selected using browse, the file path is shown. The Table dropdown is populated based on the external
data source.
In the Settings tab, select the Key Field - the user needs to select the field in the data source that contains label data
(this is what is used to match the data in the model). Check the box next to the items you want to use.
Click the Preview tab to see the data as it will be imported.
Click OK to import the data.
External Customer Meter Data
This dialog displays the table containing the external customer meter data.
Click the Copy button to copy the contents of the table to the Windows clipboard.
Click the Edit button to return to the External Customer Meter Data Setup dialog.
Click the Refresh button to update the table according to changes made in the linked datasource.
Highlight an element row in the table and click the Zoom To button to zoom the drawing pane view to the highlighted
element.
Pumps
Pumps are node elements that add head to the system as water passes through.
Applying a Zone to a Pump
the Zones topic.
108
Creating Models
To Apply a Previously Created Zone to a Pump:

1. Select the pump in the Drawing View.
Defining Pump Settings
You define the settings for each pump in your model in the Pump Definitions dialog box. You can define a collection of
pump settings for each pump.
To define pump settings:
1. Click a pump in your model to display the Property Editor, or right-click a pump and select Properties from the
shortcut menu.
2. In the Physical section of the Property Editor, click the Ellipses (...) button next to the Pump Definitions field. The
Pump Definitions dialog box opens.
3. In the Pump Definitions dialog box, each item in the list represents a separate pump definition. Click the New
button to add a new definition to the list.
4. For each definition in the list, perform these steps: Type a unique label for the pump definition. Define a new pump
definition by entering Head, Efficiency, and Motor data.
5. Click OK to close the Pump Definitions dialog box and save your data in the Property Editor.
Pump Definitions Dialog Box

This dialog box is used to create pump definitions. There are two sections: the pump definition pane on the left and the
tab section on the right. The pump definition pane is used to create, edit, and delete pump definitions.
The following controls are available in the pump definitions dialog box:
New Creates a new entry in the pump

definition Pane.
Duplicate Creates a copy of the currently

highlighted pump definition.
Delete Deletes the currently highlighted

entry in the pump definition Pane.
You can hold down the Ctrl key while
Rename Renames the currently highlighted

entry in the pump definition Pane.
Report Generates a pre-formatted report that

contains the input data associated
with the currently highlighted entry in
the pump definition Pane.
109
Creating Models
Synchronization Options Clicking this button opens a submenu

containing the following commands:
Browse Engineering Library Opens
the Engineering Library manager
dialog, allowing you to browse the
Pump Definition Libraries.
Synchronize From Library Updates
a set of pump definition entries
previously imported from a Pump
Definition Engineering Library. The
updates reflect changes that have been
made to the library since it was
imported. Synchronize To Library
Updates an existing Pump Definition
Engineering Library using current
pump definition entries that were
initially imported but have since been
modified. Import From Library
Imports pump definition entries from
an existing Pump Definition
Engineering Library. Export To
Library Exports the current pump
definition entries to an existing Pump
Definition Engineering Library.
The tab section includes the following controls:
110
Creating Models
Head Tab This tab consists of input data fields that allow you to
define the pump head curve. The specific fields vary
depending on which type of pump is selected in the Pump
Definition type field.
Pump Definition Type A pump is an element that adds head to the system as
water passes through it. This software can currently be
used to model six different pump types: Constant Power
When selecting a Constant Power pump, the following
attribute must be defined: Pump Power Represents the
water horsepower, or horsepower that is actually
transferred from the pump to the water. Depending on the
pump's efficiency, the actual power consumed (brake
horsepower) may vary. Design Point (One-Point) When
selecting a Design Point pump, the following flow vs.
head points must be defined: Shutoff Point at which the
pump will have zero discharge. It is typically the
maximum head point on a pump curve. This value is
automatically calculated for Design Point pumps. Design
Point at which the pump was originally intended to
operate. It is typically the best efficiency point (BEP) of
the pump. At discharges above or below this point, the
pump is not operating under optimum conditions. Max
Operating Highest discharge for which the pump is
actually intended to run. At discharges above this point,
the pump may behave unpredictably, or its performance
may decline rapidly. This value is automatically
calculated for Design Point pumps. Standard (Three-
Point) When selecting a Standard Three-Point pump,
the following flow vs. head points must be defined:
Shutoff Point at which the pump will have zero
discharge. It is typically the maximum head point on a
pump curve. Design Point at which the pump was
originally intended to operate. It is typically the best
efficiency point (BEP) of the pump. At discharges above
or below this point, the pump is not operating under
optimum conditions. Max Operating Highest discharge
for which the pump is actually intended to run. At
discharges above this point, the pump may behave
unpredictably, or its performance may decline rapidly.
111
Creating Models
Pump Definition Type (contd) Standard Extended When selecting a Standard

Extended pump, the following flow vs. head points must
be defined: Shutoff Point at which the pump will have
zero discharge. It is typically the maximum head point on
a pump curve. Design Point at which the pump was
originally intended to operate. It is typically the best
efficiency point (BEP) of the pump. At discharges above
or below this point, the pump is not operating under
optimum conditions. Max Operating Highest discharge
for which the pump is actually intended to run. At
discharges above this point, the pump may behave
unpredictably, or its performance may decline rapidly.
Max Extended Absolute maximum discharge at which
the pump can operate, adding zero head to the system.
This value may be computed by the program, or entered
as a custom extended point. This value is automatically
calculated for Standard Extended pumps. Custom
Extended When selecting a Custom Extended pump,
the following attributes must be defined: Shutoff Point
at which the pump will have zero discharge. It is typically
the maximum head point on a pump curve. Design
Point at which the pump was originally intended to
operate. It is typically the best efficiency point (BEP) of
the pump. At discharges above or below this point, the
pump is not operating under optimum conditions. Max
Operating Highest discharge for which the pump is
actually intended to run. At discharges above this point,
the pump may behave unpredictably, or its performance
may decline rapidly. Max Extended Absolute
maximum discharge at which the pump can operate,
adding zero head to the system. This value may be
computed by the program, or entered as a custom
extended point. Multiple Point When selecting a
Multiple Point pump, an unlimited number of Flow vs.
Head points may be defined.
Efficiency Tab This tab allows you to specify efficiency settings for the
pump that is being edited.
112
Creating Models
Pump Efficiency Allows you to specify the pump efficiency type for the
pump that is being edited. The following efficiency types
are available: Constant Efficiency This efficiency type
maintains the efficiency determined by the input value
regardless of changes in discharge. When the Constant
Efficiency type is selected, the input field is as follows:
Pump Efficiency The Pump Efficiency value is
representative of the ability of the pump to transfer the
mechanical energy generated by the motor to Water
Power. Best Efficiency Point This efficiency type
generates a parabolic efficiency curve using the input
value as the best efficiency point. When the Best
Efficiency Point type is selected, the input fields are as
follows: BEP Flow The flow delivered when the pump
is operating at its Best Efficiency point. BEP Efficiency
The efficiency of the pump when it is operating at its
Best Efficiency Point. Define BEP Max Flow When
this box is checked the User Defined BEP Max Flow field
is enabled, allowing you to enter a maximum flow for the
Best Efficiency Point. The user defined BEP Max Flow
value will be the highest flow value on the parabolic
efficiency curve. User Defined BEP Max Flow Allows
you to enter a maximum flow value for the Best
Efficiency Point. The user defined BEP Max Flow value
will be the highest flow value on the parabolic efficiency
curve. Multiple Efficiency Points This efficiency type
generates an efficiency curve based upon two or more
user-defined efficiency points. These points are linearly
interpolated to form the curve. When the Multiple
Efficiency Points type is selected, the input field is as
follows: Efficiency Points Table This table allows you
to enter the pump's efficiency at various discharge rates.
Motor Tab This tab allows you to define the pump's motor efficiency
settings. It contains the following controls:
Motor Efficiency The Motor Efficiency value is representative of the ability

of the motor to transform electrical energy to rotary
mechanical energy.
Is Variable Speed Drive? This check box allows you to specify whether or not the
pump is a Variable Speed Pump. Toggling this check box
On allows you to input points on the Efficiency Points
table.
113
Creating Models
Efficiency Points Table This table allows you to enter efficiency points for
variable speed pumps. This table is activated by toggling
the "Variable Speed Drive" check box On. See Efficiency
Points Table for more information.
Transient Tab This tab allows you to define the pump's WaterGEMS
V8i -specific transient settings. It contains the following
controls:
Inertia (Pump and Motor) Inertia is proportional to the amount of stored rotational
energy available to keep the pump rotating (and
transferring energy to the fluid), even after the power is
switched off. You can obtain this parameter from
manufacturer's catalogs, or from pump curves, or by using
the Pump and Motor Inertia Calculator. To access the
calculator, click the ellipsis button.
Speed (Full) Speed denotes the number of rotations of the pump

impeller per unit time, generally in revolutions per minute
or rpm. This is typically shown prominently on pump
curves and stamped on the name plate on the pump itself.
Specific Speed Specific speed provides four-quadrant characteristic

curves to represent typical pumps for each of the most
common types, including but not limited to: 1280, 4850,
or 7500 (U.S. customary units) and 25, 94, or 145 (SI
metric units).
Reverse Spin Allowed? Indicates whether the pump is equipped with a ratchet or
other device to prevent the pump impeller from spinning
in reverse.
Library Tab This tab displays information about the pump that is
currently highlighted in the Pump Curves Definition
Pane. If the pump is derived from an engineering library,
the synchronization details can be found here. If the pump
was created manually for this project, the synchronization
details will display the message Orphan (local), indicating
that the pump was not derived from a library entry.
descriptive notes that will be associated with the pump
that is currently highlighted in the Pump Curves
Definition Pane.
To create a pump definition
114
Creating Models
1. Select Components > Pump Definitions.

2. Click New to create a new pump definition.
3. For each pump definition, perform these steps:
4. Select the type of pump definition in the Pump Definition Type menu.Type values for Pump Power, Shutoff, Design
point, Max Operating, and/or Max Extended as required. The available table columns or fields change depending on
which definition type you choose. For Multiple Point pumps, click the New button above the curve table to add a
new row to the table, or press the Tab key to move to the next column in the table. Click the Delete button above the
curve table to delete the currently highlighted row from the table.
5. Define efficiency and motor settings in the Efficiency and Motor tabs.
6. You can save your new pump definition in WaterGEMS V8i Engineering Libraries for future use. To do this,
perform these steps:
7. Click the Synchronization Options button, then select Export to Library. The Engineering Libraries dialog box
opens. Use the plus and minus signs to expand and collapse the list of available libraries, then select the library into
which you want to export your new unit sanitary load.
8. Click Close to close the Engineering Libraries dialog box.
9. Perform the following optional steps:
10. To delete a pump definition, select the curve label then click Delete.
11. To rename a pump definition, select the label of the pump definition you want to rename, click Rename, then type
the new name.
12. To view a report on a pump definition, select the label for the pump definition, then click Report.
13. Click Close to close the dialog box.
Efficiency Points Table
A variable speed drive introduces some inefficiency into the pumping system. The user needs to supply a curve relating
variable speed drive efficiency to pump speed. This data should be obtained from the variable speed drive manufacturer
but is often difficult to find. Variable frequency drives (VFD) are the most common type of variable speed drive used.
The graph below shows the efficiency vs. speed curves for a typical VFD: Square D (Schneider Electric) model
ATV61:
115
Creating Models
Pump Curve Dialog Box

This dialog is used to define the points that make up the pump curve that is associated with the Pump Curve Library
entry that is currently highlighted in the Engineering Library Manager explorer pane.
The Pump Curve dialog is only available for Multiple Point pump type. The pump is defined by entering points in the
Flow vs. Head table. Click the New button to add a new row and click the Delete button to delete the currently
highlighted row.
116
Creating Models
For more information about Engineering Libraries, see Engineering Libraries (on page 215).
Flow-Efficiency Curve Dialog Box

This dialog is used to define the points that make up the flow-efficiency curve that is associated with the Pump Curve
Library entry that is currently highlighted in the Engineering Library Manager explorer pane.
The Flow-Efficiency Curve dialog is only available for the Multiple Efficiency Points efficiency curve type. The curve
is defined by entering points in the Flow vs. Efficiency table. Click the New button to add a new row and click the
Delete button to delete the currently highlighted row.
117
Creating Models
Speed-Efficiency Curve Dialog Box

This dialog is used to define the points that make up the speed-efficiency curve that is associated with the Pump Curve
Library entry that is currently highlighted in the Engineering Library Manager explorer pane
The Speed-Efficiency Curve dialog is only available for Variable Speed Drive pumps (Is Variable Speed Drive? is set
to True). The curve is defined by entering points in the Speed vs. Efficiency table. Click the New button to add a new
row and click the Delete button to delete the currently highlighted row.
Pump and Motor Inertia Calculator

If the motor and pump inertia values are not available, you can use this calculator to determine an estimate by entering
values for the following attributes:
Brake Horsepower at the BEP: The brake horsepower in kilowatts at the pumps BEP (best efficiency point).
Rotational Speed: The rotational speed of the pump in rpm.
When you click the OK button, the calculated inertia value will be automatically populated in the Inertia (Pump and
Motor) field on the WaterGEMS V8i tab of the Pump Definition dialog.
The calculator uses the following empirical relation developed by Thorley
118
Creating Models
where: P is the brake horsepower in kilowatts at the BEP
N is the rotational speed in rpm
If uncertainty in this parameter is a concern, several simulations should be run to assess the sensitivity of the results to
changes in inertia.
Pump Fundamentals
A pump is a type of rotating equipment designed to add energy to a fluid. For a given flow rate, pumps add a specific
amount of energy, or total dynamic head (TDH), to the fluids energy head at the pumps suction flange.
WaterGEMS V8i automatically imports pump information from WaterCAD or WaterGEMS using WaterObjects
technology. You may need to enter additional data to model dynamic effects. WaterGEMS V8i can represent virtually
any pump using one of these five hydraulic elements:
Shut Down After Time Delayfour-quadrant pump curve built in: A pump between two pipe segments which shuts
down after a user-specified time delay. Useful to simulate a power failure.
Constant Speed - No Pump Curvesno pump curve: A simplified constant-speed pump element between two pipe
segments.
Constant Speed - Pump Curve: constant-speed pump between two pipes, which supports user-defined pump curves.
Variable Speed/Torquefour-quadrant pump curve built in: A variable-speed (or torque) pump between two pipes.
Also known as a variable-frequency drive or VFD.
Pump Start - Variable Speed/Torque four-quadrant pump curve built in: A variable-speed (or torque) pump
between two pipes. Also known as a variable-frequency drive or VFD. This variable speed pump type always
displays the nominal head and flow values, allowing the user to change them.
Only the last two allow you to change the speed of the pump during a simulation. The information needed to describe a
pumps hydraulic characteristics depends on the type selected, but the following are common parameters:
Duty or Design PointPoint at which the pump was designed to operate, defined as its Nominal Flow and Nominal
Head (1, 1 in the Pump Curve table). It is typically at or near the best efficiency point (BEP). For flows above or
below this point, the pump may not be operating under optimum hydraulic conditions. Other points on the pump
curve are entered as a ratio of the nominal head and flow (e.g., 0.1 to 1.2 times these values). If a pump curve is not
available, see First-Quadrant and Four-Quadrant Representations (on page 122).
Shutoff and RunoutShutoff is the maximum head a pump can develop at zero flow. Runout is an operating point
at the other extreme of the pump curve, where the pump is discharging at a high rate but is no longer able to add any
energy (i.e., head) to the flow. WaterGEMS V8i will not automatically shut down a pump if it reaches shutoff head
or runout flow; therefore, this information is not required for a WaterGEMS V8i run.
119
Creating Models
ElevationThe pump elevation is required to calculate suction or discharge pressures and to display the pump at
the correct location on profile plots.
EfficiencyEfficiency is defined as the ratio of the hydraulic energy transferred to the water divided by the total
electrical energy delivered to the motor. This parameter is only required for pumps whose speed changes during a
simulation. It is used to determine the accelerating or decelerating torque, where required.
SpeedRotational speed in revolutions per minute (rpm) of the impeller. This is commonly the same as the motors
rotational speed, unless a transmission is installed. It is fixed for constant-speed pumps but can vary for variable-
frequency drives. This parameter is only required for pumps whose speed changes during a simulation.
InertiaPump inertia is the resistance of the pump assembly to acceleration or deceleration. WaterGEMS V8i uses
inertia and efficiency to track the rate at which a pump spins up or down when power is added or removed,
respectively. It is a constant for a particular pump and motor combination. For more information, see Pump Inertia
(on page 120).
Specific SpeedA pumps specific speed is a function of its rotational speed, Nominal Flow, and Nominal Head.
For more information, see Specific Speed (on page 121).
Pump Inertia
If a pumps speed will be controlled (i.e., ramped up or down, started or shut down during the simulation period) you
need to enter the pumps rotational inertia. Inertia is the product of the rotating weight with the square of its radius of
gyration. Pumps with more rotating mass have more inertia and take longer to stop spinning after power fails or the
pump is shut off. The trend has been towards lighter pumps with less inertia.
Pumps with higher inertias can help to control transients because they continue to move water through the pump for a
longer time as they slowly decelerate. You can sometimes add a flywheel to increase the total inertia and reduce the
rate at which flow slows down after a power failure or emergency shut down: this is more effective for short systems
than for long systems.
The value of inertia you enter in Bentley WaterGEMS V8i must be the sum of all components of the particular pump
which continue to rotate and are directly connected to the impeller, as follows:
Motor inertiatypically available from motor manufacturers directly, since this parameter is used to design the
motor. The pump vendor can also provide this information.
Pump impeller inertiatypically available from the pump manufacturers sales or engineering group, since inertia
is used to design the pump.
Shaft inertiathe shafts inertia is sometimes provided as a combined figure with the impeller. If not, it can either
be calculated directly or ignored. Entering a lower figure for the total inertia yields conservative results because
flow in the model changes faster than in the real system; therefore, transients will likely be overestimated.
Flywheel inertiasome pumps are equipped with a flywheel to add inertia and slow the rate of change of their
rotational speed (and the corresponding change in fluid flow) when power is added or removed suddenly.
Transmission inertiasome pumps are equipped with a transmission, which allows operators to control the amount
of torque transmitted from the motor to the pump impeller. Depending on the type of transmission, it may have a
significant inertia from the friction plates and the mechanism used to connect or separate them.
While this may seem like a long list, it is often enough to enter only the pump and motor inertia and neglect the other
factors. For design purposes, this tends to yield conservative results, because the simulated pump will stop more rapidly
than the real pump would. Surge-protection designed to control the somewhat larger simulated transients should be
adequate.
If the motor and pump inertia are not available, they can be estimated separately and then summed (if they remain
coupled after a power failure) using an empirical relation developed by Thorley:
120
Creating Models
where: P is the brake horsepower in kilowatts at the BEP
N is the rotational speed in rpm
If uncertainty in this parameter is a concern, several simulations should be run to assess the sensitivity of the results to
changes in inertia.
Specific Speed
If reverse spin is possible, a four-quadrant curve representation can be selected based on your pumps specific speed.
According to affinity laws, impellers with similar geometry and streamlines tends to have similar specific speeds.
To simulate a pump for which no pump curve is available or whenever there is a possibility of reverse flow or spin,
selecting the built-in four-quadrant curve corresponding to the correct pump type is essential. Despite some
approximation, Bentley WaterGEMS WaterGEMS V8i will output physically meaningful results provided you select
the correct four-quadrant curve based on your pumps specific speed. The results can help you decide whether or not
additional detail is critical or even required.
To select an appropriate four-quadrant pump curve in Bentley WaterGEMS WaterGEMS V8i, simply calculate the
specific speed and select the closest available setting in the Specific Speed field of the pumps Element Editor. You can
calculate your pumps specific speed, Ns, using the following equation:
Where:
Ns is specific speed (rpm)
N is pump rotational speed (rpm)
Q is flow rate (m3/s or gpm) at te point of best efficiency
H is total head (m or ft) per stage at the point of best efficiency
Table 4-3: Specific Speeds for Typical Pump Categories in both Unit Systems (on page 122) shows typical values of
specific speed for which an exact four-quadrant representation is built into Bentley WaterGEMS WaterGEMS V8i.
Centrifugal pumps tend to have lower specific speeds than axial-flow or multi-stage pumps. Few four-quadrant
characteristic curves are available because they require painstaking laboratory work.
The results of hydraulic transient simulations are not as sensitive to the specific speed selected, provided that a check
valve is installed. You do not need to add a check valve because every pump in Bentley WaterGEMS WaterGEMS V8i
has a built-in check valve immediately downstream of the pump.
121
Creating Models
Note: If you need a four-quadrant pump curve but your pumps specific speed does not match one of the
available options, select the closest one available or request it from the manufacturer. The prediction error
cannot be linearly interpolated using specific speed, but you could run a different curve to bracket the solution
domain.
Specific Speeds for Typical Pump Categories in both Unit Systems
Unit System Specific Speed, N s
Centrifugal pumps (radial- Axial-Flow Pumps (mixed- Multistage pumps (axial or

vane or flange-screw types) flow or flange-screw types) mixed-flow)
U.S. Customary 1280 4850 7500
SI Metric 25 94 145
First-Quadrant and Four-Quadrant Representations
Most pumps used in water and wastewater systems are equipped with check valves to preclude reverse flow and/or
nonreverse or ratchet mechanisms that prevent the pump impeller from reversing its spin direction. This usually
restricts the pumps operation to the first quadrant. Provided such a pump will operate continuously at constant speed
throughout the numerical simulation and never allow reverse flow or spin, a standard multipoint pump curve provides a
rigorous and sufficient representation. The Constant Speed - Pump Curve under Pump Type (Transient) enables you to
represent this pump configuration during a transient analysis.
If you have the multipoint pump curve, you can enter it directly in WaterGEMS V8i or import it from another model or
datasource. The pump curve is used by WaterGEMS V8i to adjust the flow produced by the pump in response to
changing system heads at its suction and discharge flanges throughout the simulation period.
Note: Entering name-plate values into WaterGEMS V8i may result in significant prediction errors. These rated
values may differ significantly from the pumps actual operating performance.
If a pump curve is not available, but you can obtain the rated head and flow from the SCADA system or other
measurements, enter these as the Nominal Flow and Nominal Head, and select the four-quadrant curves whose Specific
Speed is closest to your pump: centrifugal, axial-flow (single and double-suction) and multistage (including vertical
turbines), as shown in Table 4-3: Specific Speeds for Typical Pump Categories in both Unit Systems (on page 122),
then select the Constant Speed - No Pump Curve option under Pump Type (Transient). You can also use one of these
in-built four-quadrant characteristic curves if reverse flow or spin is possible, but you do not have these data for your
pump. This will yield a physically meaningful answer, even if the parameters are inexact. The four quadrant
characteristics curves are used for all pump types except Constant Speed - Pump Curve.
Variable-Speed Pumps (VSP or VFD)
A variable-speed pump (VSP) is typically powered by a variable-frequency drive (VFD) motor controller or sometimes
by a variable-torque transmission mechanism. Variable-frequency motor controllers and soft-starters modify the
voltage phase angle using silicon controlled rectifiers to achieve speed variations in pumps. Variable-torque
transmissions allow a differential between the motor and driven ends of a pump using special mechanical, magnetic, or
hydraulic couplings.
In practice, automatic start and stop sequences can be controlled to achieve any ramp time using a programmable logic
controller (PLC). However, there may be limits to the minimum speed or torque which can be achieved. The period of
122
Creating Models
time over which soft-starters can control the motor may be limited. Finally, operational reasons may require that
startup, shifting and shutdown sequences be shortened as much as possiblebut safely. WaterGEMS V8i helps you
estimate safe ramp times to make the most of your pumps capabilities.
In WaterGEMS V8i, a variable pump is a prescribed boundary condition which is controlled by setting a time-
dependent pattern for its rotational speed or torque. You can enter any speed or torque pattern, including delays,
multiple ramps, and periods of continuous pumping.
WaterGEMS V8i does not currently model loop-back controllers, which can modify the VFDs speed or torque to
achieve a specific head or flow at some location in the system. This is because the pump may stabilize to a new steady
state within a few seconds, including during a power failure or a normal stop or start, for a typical transient event and
the loop-back controller is likely not engaged during such operations.
Pump Curve Display

The user can obtain a display of pump curves (after a run) by right clicking on the pump and selecting Pump Curve.
The user then sees a dialog where the type of curve and time steps, for which the curve is plotted, are controlled.
The default options are to plot both the head and efficiency curve at the current time. The types of curves can be turned
off by unchecking the boxes. A plot for a single time step look like the graph below.
123
Creating Models
The graph shows both the head and efficiency curve and highlights the operating point for the current time step. If the
pump is Off, the operating point is plotted at the origin.
The buttons on top of the drawing control the display. The first button enables the user to modify the look of the graph
by changing colors, fonts, legends, etc. The second button prints the graph while the third is a print preview. The fourth
copies the graph to the clipboard.
In the case of an EPS run, if the user wants to view more than the current time step, he should pick Selected Times from
the drop down.
124
Creating Models
If the pump is a constant speed pump, then a single head and efficiency curve are shown with multiple points showing
each selected time.
125
Creating Models
If a variable speed pump is selected, then a separate head and efficiency curve are generated for each time step.
126
Creating Models
If the user picks Current Time for an EPS run, it is possible to user the Time Browser to animate the pump curve and
operating points moving over time.
Pump Curve Combinations

WaterGEMS V8i provides a number of ways to view pump curves including Components > Pump Definition which
shows all available pump curves, and right clicking on a pump and selecting Pump Curves once a run is complete.
Users also need to view the performance of multiple pumps running together in parallel in a pump station. To do this it
is first necessary to include the pumps in a Pump Station element. This can be done by opening the property grid for the
pump, picking the Pump Station property and selecting the pump station in which this pump is located. It is usually
advisable to draw the pump station polygon to include the pumps within the polygon.
The pump head and efficiency characteristic curves are properties solely of the pump and can be displayed even if the
model only consists of the pump station with the pumps. If the user wants to display system head curves, then the pump
station must be part of a valid hydraulic model.
To start the Combination Pump Curve feature to view the curves either:
1. Select Analysis > Combination Pump Curve.
2. Right click on the Pump Station and select Combination Pump Curves.
Pump Curve Combination Editor
Upon opening a Combination Pump Curve dialog, the user must first select which pump station is to be analyzed by
either selecting one of the previously used pump stations from the drop down or picking the ellipse (...) button and
selecting the station from the drawing.
Once the pump station has been selected, the dialog displays the possible pump combinations in the top left pane and
the head curves in the bottom pane.
127
Creating Models
The column marked "Active" is checked if the user wants that combination displayed in the graph.
The column "ID" displays the index on the curve in the graph (e.g. Head[1] is the curve corresponding to the head of
the pump combination with ID = 1).
There is one column in the table for each pump definition referenced in that pump station. The number in the cell
indicates the number of pumps of that definition that are running for the combination corresponding to that row. If there
is a zero in a cell, the pump is off for that combination.
The top middle pane determines which type of pump or system curve is displayed. By default, only the Head
characteristic curve is displayed. The user can also turn on the (pump) efficiency or wire-to-water (overall) efficiency
curves.
The system head curves are a property of the system calculated from the perspective of a pump. When the System Head
Curve box is checked, the user must specify which pump is the Representative Pump which means which path through
the station is head loss calculated. Usually the results don't vary significantly depending on which pump is selected.
The Maximum flow and Number of Intervals entries determine the horizontal extent of the system head curve and the
number of points along the curve that will be calculated.
The top right pane is used to account for the fact that the system head curve will depend somewhat on the time of day.
The user must select at least one time step to use in determining the system head curve. If the user selects a time step in
128
Creating Models
which the pump is discharging into a closed system with no pressure dependent demands, the system head curve may
show very high or low values for head. Do not select time steps where this occurs.
In order to run or rerun the pump combination graph, select the green Compute button at the top left of the bottom pane.
The graph below shows an example with three different combinations for two time steps (system head curves).
If the user wants to change the look of the graph such as the range of head values, use the second button in the bottom
pane. That opens the graphing manager. To change the axis range, pick Chart > Axes > Left Axis > Maximum >
Change and enter a new value. See the Graphs topic for more details.
Variable Speed Pump Battery

A Variable Speed Pump Battery element represents multiple variable speed pumps that meet the following criteria:
1. the VSPs are parallel with each other (not in-line)
2. the VSPs are sharing common upstream (inflow) and downstream (outflow) nodes
3. the VSPs are identical (have the same pump definition)
4. the VSPs are controlled by the same target node and the same target head.
129
Creating Models
Parallel variable speed pumps (VSPs) are operated as one group and led by a single VSP, the so-called lead VSP, while
the other VSPs at the same battery are referred as to as lag VSPs. A lag VSP turns on and operates at the same speed as
the lead VSP when the lead VSP is not able to meet the target head and turns off when the lead VSP is able to deliver
the target head or flow.
From the standpoint of input data, Variable Speed Pump Batteries are treated exactly the same as single pump elements
that are defined as variable speed pumps of the Fixed Head Type with one exception; number of Lag Pumps must be
defined in the Lag Pump Count field.
When simulating a Pump Battery in a transient analysis, the pump battery is converted to an equivalent pump using the
following conversion rules:
1. The Flow (Initial) of the equivalent pump is the total flow of all the running pumps in the pump battery.
2. The Inertia of the Pump and Motor of the equivalent pump is the sum of all the inertia values for all the running
pumps.
3. The Specific Speed of the equivalent pump is the Specific Speed value that is closest to the result of the following
equation:
sqrt(number of running pumps) * Specific Speed of pump battery
Pump Stations
A pump station element provides a way for a user to indicate which pumps are in the same structure, serving the same
pressure zone. It provides a graphical way to display the pumps associated with the station. A pump station is not a
hydraulic element in that it is not directly used in a hydraulic analysis but rather it is a collection of pumps which are
the hydraulic elements.
A pump station is a polygon element which displays which pumps are in the station by dashed lines connecting the
pumps with the station polygon centroid. A pump does not need to be inside the polygon to be a pump assigned to the
station and pumps inside the polygon still need to be assigned to the station. The only information saved with a pump
station is the geometry of the station and the list of pumps assigned to the station.
130
Creating Models
A pump station element is useful in calculating and displaying an analysis of pump combinations (see Pump Curve
Combinations (on page 127)).
Usually the pumps and associated piping are laid out before the station is drawn. However, the station polygon can be
drawn first. The station element is created by picking the pump station element icon
from the layout menu and drawing a polygon around the extents of the station. When the polygon is complete, the user
right clicks and selects "Done".
Individual pump elements are assigned to a station by selecting the pump element and in the Pump Station property,
picking the pump station which the pump is associated. A dashed line is drawn from the pump to the station. This also
can be done in the physical alternative for pumps. To assign several pumps at once, a global edit can be used provided
that at least one pump has already been assigned to that station.
131
Creating Models
Sometimes a pump station structure can house pumps pumping to more than one pressure zone (e.g. medium service
and high service). For the purposes of WaterGEMS V8i, this would be two (or more) pump station polygon elements,
one for each pressure zone.
The property grid contains a Controls collection field that opens a filtered controls editor that only displays the controls
associated with the pumps in the selected pump station.
Pumps Dialog Box

This dialog allows you to view the collection of pumps assigned to a pump station element.
Click the New button to select a pump from the drawing view to be added to the pump station. Click Delete to remove
the currently highlighted pump from the pump station. Click the Report button to generate a report containing the list of
pumps included in the pump station as well as their associated pump definitions. Click the Zoom To button to focus the
drawing view on the pump that is highlighted in the list.
Polygon Vertices Dialog Box

This dialog box lets you define X vs. Y points that plot the shape of the polygon that represents the selected element.
The dialog box contains the X vs. Y table that allows you to define any number of points and the following buttons:
NewCreates a new row in the table.
DeleteDeletes the currently highlighted row from the table.
SCADA Elements
132
Creating Models
Define the SCADA element using the following properties:

Target Element: The domain element that the ASCADA Signal targets.
Real-Time Signal: The signal returning realtime values for the selected attribute.
Historical Signal: The signal returning historical value(s) for the selected attributes.
Target Element (Storage Unit): Displays the storage unit used by the target element.
Field: The attribute of the target element that the SCADA signal relates to.
Valves
A valve is a node element that opens, throttles, or closes to satisfy a condition you specify. The following valve types
are available in WaterGEMS V8i:
Valve Type Description
Pressure Reducing Valve (PRV) PRVs throttle to prevent the downstream hydraulic grade
from exceeding a set value. If the downstream grade rises
above the set value, the PRV will close. If the head
upstream is lower than the valve setting, the valve will
open fully.
Pressure Sustaining Valve (PSV) 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 Valve (PBV) PBVs are used to force a specified pressure (head) drop
across the valve. These valves do not automatically check
flow and will actually boost the pressure in the direction
of reverse flow to achieve a downstream grade that is
lower than the upstream grade by a set amount.
Flow Control Valve (FCV) 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).
133
Creating Models
Valve Type Description
Throttle Control Valve (TCV) TCVs are used as controlled minor losses. A TCV is a
valve that has a minor loss associated with it where the
minor loss can change in magnitude according to the
controls that are implemented for the valve. If you dont
know the headloss coefficient, you can also use the
discharge coefficient, which will be automatically
converted to an equivalent headloss coefficient in the
program. To specify a discharge coefficient, change the
Coefficient Type to Discharge Coefficient.
General Purpose Valve (GPV) GPVs are used to model situations and devices where the
flow-to-headloss relationship is specified by you rather
than using the standard hydraulic formulas. GPVs can be
used to represent reduced pressure backflow prevention
(RPBP) valves, well draw-down behavior, and turbines.
Isolation Valves Isolation Valves are used to model devices that can be set
to allow or disallow flow through a pipe. Note that for
Isolation valves, Left as referred to by the Is offset to
the left of referenced link? property is left relative to the
pipe's coordinate system (which is the alignment of the
pipe), and not the absolute or world coordinate system.
When an isolation valve is placed, a pipe bend is added at
the location of the valve; that way if the pipes end
node(s) are moved later the valve will remain attached to
the pipe. If an isolation valve is closed, it will report N/A
for HGL and Pressure results.
Applying a Zone to a Valve

To Apply a Previously Created Zone to a Valve:
1. Select the valve in the Drawing View.
Applying Minor Losses to a Valve
Valves can have an unlimited number of minor loss elements associated with them. Minor losses are used on pressure
pipes and valves to model headlosses due to pipe fittings or obstructions to the flow.
If you have a single minor loss value for a valve, you can type it in the Minor Loss field of the Properties window. If
you have multiple minor loss elements for a valve and would like to define a composite minor loss, or would like to use
a predefined minor loss from the Minor Loss Engineering Library, access the Minor Losses dialog by clicking the
ellipsis button in the Minor Losses field of the Properties window.
To Apply a Minor Loss to a Valve
1. Select the valve in the Drawing View.
134
Creating Models
2. In the Properties window, type the minor loss value in the Minor Loss field.
To Apply Composite Minor Losses to a Valve
1. Click a valve in your model to display the Property Editor, or right-click a valve and select Properties from the
shortcut menu.
2. In the Physical: Minor Losses section of the Property Editor, set the Specify Local Minor Loss? value to False.
3. Click the Ellipses (...) button next to the Minor Losses field.
4. In the Minor Losses dialog box, each row in the table represents a single minor loss type and its associated headloss
coefficient. For each row in the table, perform the following steps:
5. Type the number of minor losses of the same type to be added to the composite minor loss for the valve in the
Quantity column, then press the Tab key to move to the Minor Loss Coefficent column.Click the arrow button to
select a previously defined Minor Loss, or click the Ellipses (...) button to display the Minor Loss Coefficients to
define a new Minor Loss.
6. When you are finished adding minor losses to the table, click Close. The composite minor loss coefficient for the
minor loss collection appears in the Property Editor.
8. To delete a row from the table, select the row label then click Delete.
9. To view a report on the minor loss collection, click Report.
Defining Headloss Curves for GPVs
A General Purpose Valve (GPV) element can be used to model head loss vs. flow for devices that cannot be adequately
modeled using either minor losses or one of the other control valve elements. Some examples of this would included
reduced pressure backflow preventers (RPBP), compound meters, well draw down, turbines, heat exchangers, and in-
line granular media or membrane filters.
To model a GPV, the user must define a head loss vs. flow curve. This is done by picking Component > GPV Head
Loss Curve > New. The user would then fill in a table with points from the curve.
135
Creating Models
The user can create a library of these curve or read them from a library. Because there is so much variability in the
equipment that can be modeled using GPVs, there is no default library.
Once the GPV head loss curve has been created, the user can place GPV elements like any other element. Once placed,
the user assigns a head loss curve to the specific GPV using "General Purpose Head Loss Curve" in the property grid.
A GPV can also have an additional minor loss. To specify that, the user must provide a minor loss coefficient and the
(effective) diameter of the valve.
A GPV does not act as a check valve. Flow can move in either direction through the valve. Therefore, when modeling a
device like a RPBP, it may be necessary to place a check valve on one of the adjacent pipes to account for that
behavior.
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.
To Define a Headloss Curve
1. Select the GPV in the Drawing View.
2. In the Properties window, click the menu in the GPV Headloss Curve field and select Edit GPV Headloss Curves.
3. In the GPV Headloss Curves dialog that appears, click the New button. Enter a name for the curve, or accept the
default name.
4. Define at least two points to describe a headloss curve. A point consists of a flow value for each headloss value in
the Flow vs. Headloss table. The curve will be plotted in the curve display panel below the table.
5. Click the Close button.
To Import a Predefined Headloss Curve From an Engineering Library
136
Creating Models
1. Select the GPV in the Drawing View.

2. In the Properties window, click the menu in the GPV Headloss Curve field and select Edit GPV Headloss Curves.
3. In the GPV Headloss Curves dialog that appears, click the New button. Enter a name for the curve, or accept the
default name.
4. Click the Synchronization Options button and select Import From Library.
5. In the Engineering Libraries dialog that appears, click the plus button to expand the GPV Headloss Curves Libraries
node, then click the plus button to expand the node for the library you want to browse.
6. Select the headloss curve entry you want to use and click the Select button.
7. Click the Close button.
Defining Valve Characteristics

You can apply user-defined valve characteristics to any of the following valve types:
PRV
PSV
PBV
FCV
TCV
GPV
To create a valve with user-defined valve characteristics:
1. Place a PRV, PSV, PBV, FCV, TCV, or GPV valve element.
2. Double-click the new valve to open the Properties editor.
3. In the WaterGEMS V8i Data section, change the Valve Type to User Defined.
4. In the Valve Characteristics field, select Edit Valve Characteristics.
5. Define the valve characteristics in the Valve Characteristics dialog that opens.
6. In the Valve Characteristics field, select the valve characteristic definition that the valve should use.
Note: If the Valve Characteristic Curve is not defined then a default curve will be used. The default curve will
have (Relative Closure, Relative Discharge Coefficient) points of (0,1) and (1,0).
Valve Characteristics Dialog Box
The following management controls are located above the valve characteristic list pane:
Creates a new valve characteristic definition.
New
Creates a copy of the currently highlighted valve

characteristic definition.
Duplicate
Deletes the valve characteristic definition that is currently

highlighted in the list pane. You can hold down the Ctrl
Delete key while clicking on items in the list to select multiple
entries at once.
137
Creating Models
Renames the valve characteristic definition that is

currently highlighted in the list pane.
Rename
Opens a report of the data associated with the valve

characteristic definition that is currently highlighted in the
Report list pane.

The tab section is used to define the settings for the minor loss that is currently highlighted in the valve characteristic
list pane. The following controls are available:
Valve Characteristic Tab This tab consists of input data fields that allow you to
define the valve characteristic.
Relative Closure The ratio of valve stroke/travel to the total stroke/travel

required to close the valve. A Relative Closure of 100%
represents a fully closed valve.
Relative Discharge Coefficient The discharge coefficient of the valve relative to the fully
open discharge coefficient. A Relative Discharge
Coefficient of 100% represents a fully open valve (exactly
equal to the fully open discharge coefficient) and 0%
represents a discharge coefficient of zero (fully closed).
Library Tab This tab displays information about the valve

characteristic that is currently highlighted in the valve
characteristic list pane. If the valve characteristic is
derived from an engineering library, the synchronization
details can be found here. If the valve characteristic was
created manually for this project, the synchronization
that the valve characteristic was not derived from a library
entry.
descriptive notes that will be associated with the valve
characteristic that is currently highlighted in the valve
characteristic list pane.
Valve Characteristic Curve Dialog Box
This dialog is used to define a valve characteristic entry in the Valve Characteristics Engineering Library.
The dialog consists of a table containing the following attribute columns:
Relative Closure: Percent opening of the valve (100% = fully closed, 0% = fully open).
138
Creating Models
Relative Discharge Coefficient:The discharge coefficient of the valve relative to the fully open discharge
coefficient. A Relative Discharge Coefficient of 100% represents a fully open valve (exactly equal to the fully open
discharge coefficient) and 0% represents a discharge coefficient of zero (fully closed).
Click New to add a new row to the table. Click Delete to remove the currently highlighted row from the table. You can
hold down the Ctrl key while clicking on items in the list to select multiple entries at once.
General Note About Loss Coefficients on Valves

Valves are modeled as links (like pipes) in the steady state / EPS engine and as such the engine supports the notion of
minor losses in fully open links. This is to account for such things as bends and fittings, or just the physical nature of
the link (element). However, note that the minor loss for a valve only applies when the valve is fully open (inactive)
and not restricting flow. For example, a flow control valve (FCV) that has a higher set flow than the hydraulics provide
for, is fully open and not limiting the flow passing through. In this case the computation will use any minor loss on the
FCV and calculate the corresponding head loss. If on the other hand the set flow of the FCV was low enough for the
valve to be required to operate, the head loss across the valve is determined by the function of the valve. In this case the
head loss would be the value corresponding to the function of reducing the flow to the set value of the FCV.
The purpose of several of the valve types included in WaterGEMS V8i is simply to impart a head loss in the system,
similar in some ways to a minor loss. One example here is the Throttle Control Valve (TCV). The TCV supports a head
loss coefficient (or discharge coefficient) that is used to determine the head loss across the valve. It is important to note,
however, that the head loss coefficient on the TCV is actually different from a minor loss in the way it is used by the
computation. The minor loss applies when the valve is fully open (inactive) and the head loss coefficient applies when
the valve is active. This same principle applies to other valve types such as General Purpose Valves (GPVs), Pressure
Breaker Valves (PBVs) and Valves with a Linear Area Change (VLAs), the only difference being that GPVs use a
headloss/flow curve, PBVs use a headloss value and VLAs use a discharge coefficient, instead of a head loss
coefficient, to define the valve's behavior when it is in the active state.
In some cases a minor loss coefficient sounds like it could be a duplicate of another input value, but the way in which it
is used in the computation is not the same.
Modulating Control Valve

Control valves, such as pressure reducing valves (PRV), modify their opening to control pressure or flow in the system.
For example, PRV's adjust valve position to reduce inlet pressure meet a target outlet pressure.
Through HAMMER V8i SELECT series 3, HAMMER maintained a constant valve position throughout a transient
analysis. In many cases that opening is correct, but there are instances where the valve position will modulate
significantly in response to the transient and must be accounted for. In some instances, valve modulation can contribute
to transient problems.
With SELECT series 4, there is a new PRV property "Modulate Valve during Transient" which, when set to True,
enables HAMMER to adjust the valve opening during a transient run. The default value for this property is False. This
property is saved in the Transient alternative.
When "Modulate Valve during Transient" is set to True, the user must set the "Opening rate coefficient" and Closure
rate coefficient". The units for these properties are % change in opening/second/foot of HGL difference between the
control valve setting and the calculated pressure at the previous time step (xxx %/sec/ft or yyy %/sec/m). These values
are highly valve specific. The default values are for both rates. The closing and opening rates for a given valve may be
different. Values will be lower for larger valves and will be much higher for direct acting valves than pilot controlled
valves. The values should be calibrated using high speed pressure loggers. A reasonable initial estimate may be on the
order of 0.1.
139
Creating Models
The valve position is calculated in HAMMER as

V(t+1) = V(t) + cr (H(t) - Hs) dt, if H(t) > Hs
V(t+1) = V(t) + co (H(t) - Hs) dt, if H(t) < Hs
Where:
V= valve position (% closed)
cr = closing rate (%/s/ft)
cr = opening rate (%/s/ft)
Hs = target outlet hydraulic grade (ft)
H(t) = outlet hydraulic grade at time t (ft)
dt = time step size, s
If the opening or closing rates are set too high, it is possible to create numerical instability in HAMMER.
When using modulating control valves, it is necessary to specify either a non-zero fully open minor loss coefficient or
discharge coefficient. This value is set in the property "Valve coefficient type".
While modulation is possible in any type of control valve, HAMMER SELECT series 4 only supports this behavior in
PRV's.
Inaccurate results may occur if the valve becomes fully open or fully closed during a run or the pressure drops below
vapor pressure at the valve. The percent closure for the valve can be found in temporary file C:\Users
\FirstName.LastName\AppData\Local\Temp\Bentley\HAMMER\ PRVCLOSURE.TXT.
If the user selects False for "Modulate Valve during Transient", it is still possible to adjust valve opening during a
transient run by changing the default value for "Operating Rule" from Fixed to an Operational (Transient Valve) pattern
that the user has established under Patterns. In these patterns, the relative closure is a function of time. (See help topic
Pattern Manager.)
Spot Elevations
Spot elevations can be placed to better define the terrain surface throughout the drawing. They have no effect on the
calculations of the network model. Using spot elevations, elevation contours and enhanced pressure contours can be
generated with more detail. The only input required for spot elevation elements is the elevation value.
Turbines
A turbine is a type of rotating equipment designed to remove energy from a fluid. For a given flow rate, turbines
remove a specific amount of the fluid's energy head.
In a hydroelectric power plant, turbines convert the moving waters kinetic energy to mechanical (rotational) energy.
Each turbine is mechanically coupled with a generator that converts rotational energy to electrical energy. Each
generator's output terminal transmits electricity to the distribution grid. At steady state, the electricity produced by the
turbine-generator system is equal to the electrical grid load on the generator.
The figure below is a generalized schematic of a hydroelectric power generation plant. A reservoir (usually elevated)
supplies a low pressure tunnel and a penstock. Water flows through the penstock under increasingly higher pressure
(and velocity if diameter decreases) as it approaches the turbine. Most of the turbine's rotational energy drives a
generator to produce electricity. Water emerges from the turbine through the draft tube and tailrace and flows into the
downstream reservoir. Surge tanks can be connected to the penstock and/or tailrace to limit the magnitude of transient
pressures, especially if the length of the upstream conduit/penstock or if (rarely) the tailrace is relatively long.
140
Creating Models
Hydraulic turbines and penstocks often operate under high pressure at steady-state. Rapid changes such as electrical
load rejection, load acceptance or other emergency operations can result in very high transient pressures that can
damage the penstock or equipment. During load rejection, for example, the wicket gates must close quickly enough to
control the rapid rise in rotational speed while keeping pressure variations in the penstock and tailrace within
established tolerances. Using Hammer, designers can verify whether the conduits and flow control equipment are likely
to withstand transient pressures that may occur during an emergency.
Electrical load varies with time due to gradual variations in electricity demand in the distribution grid. Depending on
the type of turbine, different valves are used to control flow and match the electrical load. Turbines can be classified
into two broad categories: a) impulse turbine, and b) reaction turbine.
Impulse Turbine
An impulse turbine has one or more fixed nozzles through which pressure is converted to kinetic energy as a liquid
jet(s) typically the liquid is water. The jet(s) impinge on the moving plates of the turbine runner that absorbs virtually
all of the moving water's kinetic energy. Impulse turbines are best suited to high-head applications. One definition of an
impulse turbine is that there is no change in pressure across the runner.
141
Creating Models
In practice, the most common impulse turbine is the Pelton wheel shown in the figure below. Its rotor consists of a
circular disc with several buckets evenly spaced around its periphery. The splitter ridge in the centre of each bucket
divides the incoming jet(s) into two equal parts that flow around the inner surface of the bucket. Flow partly fills the
buckets and water remains in contact with the air at ambient (or atmospheric) pressure.
Once the free jet has been produced, the water is at atmospheric pressure throughout the turbine. This results in two
isolated hydraulic systems: the runner and everything upstream of the nozzle (including the valve, penstock and
conduit). Model the penstock independently using regular pipe(s), valve(s) and a valve to atmosphere for the nozzle.
Transients occur whenever the valve opens or closes and the penstock must withstand the resulting pressures.
Note: The turbine element in HAMMER is not used to represent impulse turbines. Transients caused by impulse
turbines can be approximated in HAMMER by using a Throttle Control Valve (TCV) or Discharge to Atmosphere
element to represent the turbine nozzle.
Reaction Turbines
The figure below is a schematic of a typical reaction turbine. A volute casing and a ring of guide vanes (or wicket gate
around the circumference) deliver water to the turbine runner. The wicket gate controls the flow passing through the
turbine and the power it generates. A mechanical and/or electrical governor senses gradual load variations on the
generator and opens or closes the wicket gates to stabilize the system (by matching electrical output to grid load).
142
Creating Models
Hammer currently models hydraulic transients that result from changes in variables controlled by the governor: it does
not explicitly model the governor's internal operation or dynamics. Depending on the Operating Case being simulated,
HAMMER either assumes the governor is `disconnected' or `perfect'.
The governor is an electro or mechanical control system that may not be active - or may not react fast enough - during
the emergency conditions of primary interest to modelers: instant load rejection or (rapid) load rejection. Instant load
rejection assumes the governor is disconnected.
At other times, the governor will strive to match electrical output at the synchronous or `no-load' speed: e.g. during load
acceptance or load variation. Given the fact that no two governors are the same, it is useful to assume the governor is
`perfect' in those cases and that it can match the synchronous speed exactly.
Each of these categories corresponds to a range of specific speeds that can be calculated from the turbine's rated power,
rotational (synchronous) speed and head.
Note that there is no option in HAMMER to change the runner blade angle of a Kaplan turbine, so it is assumed the
runner blade angle is constant during the transient analysis. Engineering judgment should be used to determine if this
approximation is satisfactory in each case.
The primary hydraulic variables used to describe a turbine in the above schematic are:
Q = Flow
H = Head
143
Creating Models
N = Rotational Speed
I = Rotational Inertia
w = Wicket Gate Position (% open)
M = Electrical Load or Torque
Modeling Hydraulic Transients in Hydropower Plants

In a hydropower generation plant, it is essential to predict the transient pressures that could occur and to implement an
adequate surge control strategy to ensure the safety and reliability of the unit. The impact of gradual or diurnal load
variations on the turbine-generator may be of interest during normal operations but an electric or mechanical governor
can control moderate transients.
The primary purpose of hydraulic transient simulations is therefore to protect the system against rapid changes in the
electrical and/or hydraulic components of the hydroelectric system. In each case, hydraulic transients result from
changes in the variables controlled by the governor.
Electrical Load or Torque on the turbine-generator system varies with the electrical load in the distribution grid. In
steady-state operation, the electrical torque and the hydraulic torque are in dynamic equilibrium. From a hydraulic
perspective, electrical torque is an external load on the turbine-generator unit.
Speed is another possible control variable for numerical simulations. For turbines, however, the governor strives to
keep the turbine at synchronous speed by varying the wicket gate position during load variation and acceptance
(assuming a perfect governor). If field data were available, the speed could be used to determine whether the model
simulates the correct flow and pressures.
Once the time-varying electrical torque and wicket gate positions are known, the turbine equations (Numerical
Representation of Hydroelectric Turbines), HAMMER solves flow, Q, and rotational speed, N, in conjunction with the
characteristic curves for the turbine unit(s). This yields the transient pressures for the load rejection, load acceptance,
emergency shutdown, operator error or equipment failure. The possible emergency or transient conditions are discussed
separately in the sections that follow.
Load Rejection
Load rejection occurs when the distribution grid fails to accept electrical load from the turbine-generator system. After
the load is rejected by the grid, there is no external load on the turbine-generator unit and the speed of the runner
increases rapidly. This can be catastrophic if immediate steps are not taken to slow and stop the system. To keep the
speed rise within an acceptable limit, the wicket gates must close quickly and this may result in high (followed by low)
hydraulic transient pressures in the penstock. Since load rejection usually results in the most severe transient pressures,
it typically governs the design of surge control equipment.
During load rejection, the generation of electrical power by the turbine-generator unit should decrease to zero as
quickly as possible to limit the speed rise of the unit. To accomplish this, the wicket gates close gradually in order to
reduce flow. The table below shows an example of electrical load and wicket gate position versus time to simulate load
rejection. In a real turbine a governor would control the wicket gate closure rate, however the turbine governor is not
modeled explicitly in HAMMER and the user controls the rate of wicket gate closure.
If the power generated by the water flowing through the turbine is greater than the electrical load, then the turbine will
speed up; if the electrical load is greater, the turbine will slow down.
Note: Load and gate position are entered in different parameter tables in HAMMER because they may not use the
same time intervals. HAMMER interpolates automatically as required.
Load and Wicket Gate Changes for Load Rejection
144
Creating Models
Time (s) Electrical Load (MW) Wicket Gate Position (%)
0 350 100
1 100 50
2 0 0
Instant Load Rejection

Instant Load Rejection is similar to the Load Rejection case, except the electrical load on the turbine drops
instantaneously to zero (i.e. the turbine is disconnected from the generator).
During instant load rejection, the generation of electrical power by the turbine-generator unit should decrease to zero as
quickly as possible to limit the speed rise of the unit. To accomplish this, the wicket gates close gradually in order to
reduce flow. The table below shows an example of wicket gate position versus time to simulate Instant Load Rejection.
In a real turbine a governor would control the wicket gate closure rate, however the turbine governor is not modeled
explicitly in HAMMER and the user controls the rate of wicket gate closure..
Wicket Gate Changes for Instant Load Rejection
Time (s) Wicket Gate Position (%)
0 100
1 50
2 0
Load Acceptance
Full load acceptance occurs when the turbine-generator unit is connected to the electrical grid. Transient pressures
generated during full load acceptance can be significant but they are usually less severe than those resulting from full
load rejection.
HAMMER assumes the turbine initially operates at no-load speed (NLS), and the turbine generates no electrical power.
When the transient simulation begins, HAMMER assumes the electrical grid is connected to the output terminal of the
generator and wicket gates have to be open as quickly as possible to meet the power demand - all without causing
excessive pressure in the penstock.
Note that in this case, HAMMER assumes the turbine governor is 'perfect' - in other words the power produced by the
turbine always equals the electrical load. Therefore the user doesn't need to enter an electrical load; just a curve of
wicket gate position versus time, and the turbine's rated flow and head. Under the Load Acceptance case the turbine
will always operate at its rated (or synchronous) speed.
Wicket Gate Changes for Full Load Acceptance
0 0
1 50
2 100
145
Creating Models
Load Variation
Load variation on the turbine-generator unit can occur due to the diurnal changes in electricity demand in the
distribution grid. During load variation, the governor controls the wicket gate opening to adjust flow through the
turbine so that the unit can match the electrical demand. The water column in the penstock and conduit system
accelerates or decelerates, resulting in pressure fluctuations.
The transient pressures that occur during general load variation may not be significant from a hydraulic design
perspective since they are often lower than the pressure generated during a full load rejection or emergency shutdown.
At steady-state, the turbine-generator system usually runs at full load with the wicket gates 100% open. The amount of
electricity produced by the system depends on the flow through the wicket gates. A decrease in electrical load requires
a reduction in the wicket gate opening to adjust the flow.the table below shows an example of typical user input to
simulate transient pressures for load variation.
Note that in this case, HAMMER assumes the turbine governor is 'perfect' - in other words the power produced by the
turbine always equals the electrical load. Therefore the user doesn't need to enter an electrical load; just a curve of
wicket gate position versus time. Under the Load Variation case the turbine will always operates at its rated (or
synchronous) speed.
Wicket Gate Changes for General Load Variation
0 100
5 85
10 70
15 57
20 43
30 30
35 35
42 42
55 57
65 70
80 85
90 100
Turbine Parameters in WaterGEMS V8i
Note: These attributes are used by HAMMER only.
146
Creating Models
Fundamentally, a turbine is a type of rotating equipment designed to remove energy from a fluid. For a given flow rate,
turbines remove a specific amount of the fluids energy head. WaterGEMS V8i provides a single but very powerful
turbine representation:
Turbine between 2 PipesA turbine that undergoes electrical load rejection at time zero, requiring it to be shut
down rapidly. The four-quadrant characteristics of generic units with certain specific speeds are built into
WaterGEMS V8i. The turbine element allows nonlinear closure of the wicket gates and is equipped with a spherical
valve that can be closed after a time lag. It has the following parameters:
Time (Delay until Valve Operates) is a period of time that must elapse before the spherical valve of the turbine
activates.
Time for Valve to Operate is the time required to operate the spherical valve. By default, it is set equal to one time
step.
Pattern (Gate Opening) describes the percentage of wicket gate opening with time.
Operating Case allows you to choose among the four possible cases: instantaneous load rejection, load rejection
(requires torque/load vs time table), load acceptance and load variation.
Diameter (Spherical Valve) is the diameter of the spherical valve.
Efficiency represents the efficiency of the turbine as a percentage. This is typically shown on the curves provided by
the manufacturer. A typical range is 85 to 95%, but values outside this range are possible.
Moment of Inertia The moment of inertia must account for the turbine, generator, and entrained water.
Speed (Rotational) denotes the rotation of the turbine blades per unit time, typically as rotations per minute or rpm.
The power generated by the turbine depends on it.
Specific Speed enables you to select from four-quadrant characteristic curves to represent typical turbines for three
common types: 30, 45, or 60 (U.S. customary units) and 115, 170, or 230 (SI metric units).
The equation to estimate specific speed for a turbine is as follows:
In US units n is in rpm, P is in hp, and H is in ft.In SI units n is in rpm, P is in kW, and H is in m.

Turbine Curve For a transient run, HAMMER uses a 4-quadrant curve based on Specific Speed, Rated Head, and
rated Flow. This is only used for steady state computations.
Flow (Rated) denotes the flow for which the turbine is rated.
Head (Rated) denotes the head for which the turbine is rated.
Electrical Torque Curve defines the time vs torque response for the turbine. Only applies to the Load Rejection
operating case.
Turbine Curve Dialog Box

This dialog is used to define the points that make up the flow-head curve that is associated with the turbine curve for
the associated turbine element. The turbine curve represents the head-discharge relationship of the turbine at its rated
speed.
The New button adds a new row to the table; the Delete button removes the currently selected row from the table, and
the Report button generates a preformatted report displaying the Head vs. Flow data points for the current turbine
curve.
147
Creating Models
Periodic Head-Flow Elements

The Periodic Head-Flow element represents a versatile hydraulic boundary condition which allows you to specify a
constant head (pressure), flow, or any time-dependent variation, including periodic changes that repeat indefinitely until
the end of the simulation.
Note: The Periodic Head/Flow element supports a single branch connection only. If there is more than one
branch connected to it, the transient run will fail and an error message may appear, such as: "Only one active
pipe may be connected to this type of node in its current configuration."
This element is used to prescribe a boundary condition at a hydraulic element where flow can either enter or leave the
system as a function of time. It can be defined either in terms of Head (for example, the water level of a clear well or
process tank) or Flow (for example, a time-varying industrial demand). The periodic nature of variation of head/flow
can be of sinusoidal or of any other shape that can be approximated as a series of straight lines.
Note: During a Steady State of EPS run (used to determine the initial conditions for a transient analysis), the
head/flow for this element is held constant at the initial head/flow value on the sinusoidal or user-defined
pattern. The head/flow only varies during a transient analysis.
Periodic Head-Flow Pattern Dialog Box

This dialog is used to define the points that make up the head or flow pattern that is associated with a non-sinusoidal
periodic head-flow element. The pattern is defined by creating Head or Flow vs Time points.
the Report button generates a preformatted report displaying the Time vs. Flow (or Head) data points for the Periodic
Head-Flow curve.
148
Creating Models
Air Valves
Air valves are installed at local high points to allow air to come into the system during periods when the head drops
below the pipe elevation and expels air from the system when fluid columns begin to rejoin. The presence of air in the
line limits subatmospheric pressures in the vicinity of the valve and for some distance to either side, as seen in profiles.
Air can also reduce high transient pressures if it is compressed enough to slow the fluid columns prior to impact.
There are essentially two ways in which an active air valve can behave during the transient simulation:
1. Pressure below atmospheric - air valve is open and acts to maintain pressure to 0 on the upstream end and maintains
the same flow on the upstream and downstream side.
2. Pressure above atmospheric - air valve is closed and acts as any junction node.
If an air valve becomes open during the initial conditions calculation (steady state or EPS), the hydraulic grade on the
downstream side may be less than the pipe elevation. This can be displayed as the hydraulic grade line drawn below the
pipe. This should be interpreted as a pressure pipe that is not flowing full. Full flow resumes at the point where the
hydraulic grade line crosses back above the pipe.
Because air valves have the possibility to switch status during a steady state or EPS, they can lead to instability in the
model especially if there are many air valves in the system. To improve the stability of the model, it is desirable to force
some of the valves closed. This can be done by setting the property "Treat air valve as junction" to True for those
valves that are expected to be closed anyway.
If all of the pumps upstream of an air valve are off during a steady state or EPS, the pressure subnetwork is
disconnected in that area and the model will issue warning messages for all nodes in that vicinity indicating that they
are disconnected.
Note: In the rare event that you need to model an air valve that is open during the initial conditions, the initial air
volume will need to be entered. The friction factors in the adjacent pipes may also need to be checked, as the
head loss computed by the initial conditions calculation may not be a true head loss. It may be necessary to
specify the initial conditions manually (by setting the 'Specify Initial Conditions?' Transient Solver calculation
option to True - see the Calculation options topic for details - then manually typing in values for the fields
grouped under Transient Initial in the Property Editor.
149
Creating Models
The following HAMMER attributes describe the air valve behavior:

Slow Closing Air Valve Type
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
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 (Air Outflow Orifice): Diameter of the air outflow orifice (the orifice through which air is expelled from
the pipeline).
Double Acting Air Valve Type
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.
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. By default, this diameter is considered infinite (i.e. there is no restriction to air
inflow).
the pipeline). By default, this diameter is considered infinite.
Triple Acting Air Valve Type
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.
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.
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.
inflow).
Vacuum Breaker Air Valve Type
150
Creating Models
inflow).
Determining the Type of Air Valve to Use

When modeling an air valve, it must conform to one of the four available types: (selected from the "Air Valve Type"
attribute) Double Acting, Triple Acting, Vacuum Breaker and Slow Closing. Industry terminology is sometimes not
consistent with HAMMER's definition of these types, so it is important to understand their behavior and assumptions.
Below describes each air valve type and when it should be used.
Note: If you cannot approximate the size of your openings with a circular orifice diameter or if you need to enter
a specific relationship between pressure and air flow rate, select "Air Flow Curve" as the "Air Flow Calculation
Method" in the properties of the air valve.
Double Acting - This type of air valve has two actions:

1. Air inflow through an inflow orifice diameter
2. Air outflow through an outflow orifice diameter
The diameters of these orifices don't change during the transient simulation. This type of air valve should be used when
air enters the valve through a specific size opening, and leaves the system through another specific size opening,
without any transition. The opening that allows air outflow is typically smaller, in order to control air release. Here are
some examples of when the Double Acting air valve type would be used:
An air valve with an "anti-slam", spring loaded disc with perforations, which opens under vacuum conditions. When
pressure returns, the spring closes the disc and air is forced to exit through the small perforations. The air inflow
orifice would be the size of the opening through which air flows when the disc rises off the seat. The air outflow
orifice would be the equivalent orifice size of the perforations in the disc.
An air valve with a spring loaded orifice that admits air on vacuum conditions and a separate, smaller opening that
expels air. The spring loaded orifice would be the air inflow orifice and the smaller opening would be the air
outflow orifice.
Triple Acting - This type of air valve has three actions:
1. Air Inflow
2. Air Outflow through a large orifice
3. Air Outflow through a small orifice
Air inflow passes through an opening with a fixed size. Air outflow first passes through a large-sized opening, which
switches to a smaller sized opening just before all of the air has escaped. This cushions the air pocket collapse and
subsequent collision of the water columns. This type of air valve should be used when the opening through which air is
expelled changes based on some condition. The condition to trigger the reduction in size of the outflow orifice can
either be based on a pressure differential or an air volume. Typically a float is used to decrease the opening size, but not
always.
151
Creating Models
Here are some examples of when the Triple Acting air valve type would be used:
An air valve similar to the one seen in the above diagram, consisting of two openings and a float. When the volume
of air in the system becomes less than the "transition volume", the float rises, which partially closes the outlet
opening. The air inflow orifice would be the size of the "inlet" opening. The "large air outflow orifice" would be the
full size of the outlet opening. The "small air outflow orifice" would be the size of the outlet opening after the float
has risen.
An air valve with a float that closes off the outlet opening completely, forcing air out of a separate, smaller opening.
The "large air outflow orifice" would be a diameter equivalent to the size of the main outlet opening plus the small
opening. The "small air outflow orifice" would be the size of the separate, smaller opening alone.
An "anti-slam" air valve with a disc or float that first allows air outflow to freely pass out of a large opening. As air
velocity increases, the float is "blown" into position by the pressure differential it creates, forcing air out of a
smaller opening. The "large air outflow orifice" would be the large size opening (before the float rises) and the
"small air outflow orifice" would be the smaller sized opening (after the float rises). "Transition Pressure" would be
selected as the outflow orifice trigger type.
Vacuum Breaker - This type of air valve has only one operation: air inflow. During subatmospheric pressure, air enters
through the air inflow orifice diameter. The outflow orifice diameter is assumed to be very small (effectively zero) so it
doesn't let air out. When looking at the detailed report, you may notice the air volume change as the air pocket is
compressed, but the mass of air in the pipe doesn't reduce. There are probably a limited number of applications for this
type valve, but it may be used for a draining pipeline.
Note: Any air pocket left in the system due to a vacuum breaker valve is assumed to be expelled out of the
system by some other means. HAMMER currently cannot track the behavior of these trapped air pockets (the
underlying assumption is that the air must exit the system where it came in)
Slow Closing - This type of air valve has two actions:

Free air inflow upon subatmospheric pressure
Linear closure of the air outflow orifice when air begins to exit
Although similar to the other air valve types, the slow-closing air valve only has a single orifice involved; for the
expulsion of air and liquid. An air inflow orifice is not required because HAMMER assumes that air will be freely
allowed into the system (no throttling) when the head drops below the air valve elevation. The valve starts to close
linearly with respect to area only when air begins to exit from the pipeline (after the head begins to rise).
152
Creating Models
It is possible for liquid to be discharged through this valve for a period after the air has been expelled, unlike the other
air valve types, which closes when all the air has been evacuated from the pipeline. Typically you will want the valve to
be fully closed after all air has been expelled, but before too much water has been expelled.
Air Flow Curves Dialog Box

The following management controls are located above the air flow curve list pane:
Creates a new air flow curve.
New
Deletes the air flow curve that is currently highlighted in

the list pane. You can hold down the Ctrl key while
Delete clicking on items in the list to select multiple entries at
once.
Creates a copy of the currently highlighted air flow curve.
Duplicate
Renames the air flow curve that is currently highlighted in

the list pane.
Rename
Opens a report of the data associated with the air flow

curve that is currently highlighted in the list pane.
Report

The tab section is used to define the settings for the air flow curve that is currently highlighted in the air flow curve list
pane. The following controls are available:
Air Flow Curve Tab This tab consists of input data fields that allow you to
define the air flow curve.
Flow (Free Air) The volume of air flow at the associated pressure.
Pressure (Line) The pressure at the air flow curve point. Note that only
gauge pressure values are supported, not absolute
pressure.
153
Creating Models
Library Tab This tab displays information about the air flow curve that
is currently highlighted in the air flow curve list pane. If
the curve is derived from an engineering library, the
synchronization details can be found here. If the curve
was created manually for this project, the synchronization
that the curve was not derived from a library entry.
descriptive notes that will be associated with the air flow
curve that is currently highlighted in the air flow curve
list pane.
Note: The Air Flow result attribute shown in the detailed report shows the volumetric flow rate of air at the
conditions present inside the pipeline.
Air Flow-Pressure Curve

This dialog allows you to define pattern curves for the Air Flow Curve Engineering Library.
The following buttons are located above the curve points table on the left:
New: Creates a new row in the curve points table.
Delete: Deletes the currently highlighted row from the curve points table.
The curve points table contains the following columns:
Flow (Free Air): The volume of air flow at the associated pressure.
Pressure (Line): The pressure at the air flow curve point. Note that only gauge pressure values are supported, not
absolute pressure.
Hydropneumatic Tanks
154
Creating Models
155
Creating Models
156
Creating Models
157
Creating Models
Initial Conditions Attributes

The following attributes of the hydropneumatic tank influence the initial conditions calculation (steady state or EPS).
You'll notice that they are all within the "Operating Range" or "Physical" section of the hydropneumatic tank
properties.
Elevation (base) - The elevation of the base of the tank. It is used as a reference when entering initial hydraulic
grade in terms of "level" (i.e., if the "elevation (base)" is set to 20m and the operating range is set to "level", a "level
(initial)" value of 1.0 represents an elevation of 21m).
Operating Range Type - Specify whether the initial hydraulic grade of the tank is based on levels measured from the
base elevation or as elevations measured from the global datum (zero). For example, if the base elevation is 20m,
you want the initial hydraulic grade to be 70m., and you want to use levels, then select "level" for this field and
enter 50m as the initial level.
HGL (Initial) or Level (Initial) - Depending on the operating range type selected, this represents the known
boundary hydraulic grade at the tank during steady state. It is the water surface elevation plus the pressure head of
the compressed gas in the hydropneumatic tank. The transient simulation will begin with this head. However, if
you've selected "true" for the "Treat as Junction" attribute, the transient simulation will ignore this value and instead
use the computed steady state hydraulic grade
Liquid Volume (Initial) - This represents the volume of liquid in the tank at the start of the initial conditions,
corresponding to the initial HGL. This includes the inactive volume below the affective volume, when using the
"constant area approximation" tank calculation model.
Elevation - The elevation from which to calculate pressure in the hydropneumatic tank (typically the bottom of the
tank.) It could be set to the estimated water surface, since the air pressure (used in the gas law equation) is above
that point. However, the bottom elevation and water surface are typically very close, so this likely will not make a
noticeable difference.
Volume (Tank) - This represents the total volume of the tank. This is only used in an EPS simulation (to find the gas
volume so that the gas law equation can be used) or when using the bladder option ("Has Bladder?" = "True")
158
Creating Models
during a transient simulation. When using a bladder tank, WaterGEMS V8i assumes the bladder occupies this full
tank volume at its "preset pressure,".
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.
Tank Calculation Model - Specifies whether to use the gas law or a constant area approximation method during
steady state or EPS initial condition calculations. The constant area approximation uses a linear relationship; the
user must specify minimum/maximum HGL and the corresponding volume between. The gas law model is non-
linear and follows the gas law--as gas is compressed, it becomes harder to compress it further.
Atmospheric Pressure Head - When using the gas law tank calculation model, this field represents atmospheric
pressure at the location being modeled. This is required because the gas law equation works in absolute pressure, as
opposed to gauge pressure.
HGL on/HGL off - Exposed when using the constant area approximation method. The "HGL on" field is the lowest
operational hydraulic grade desired, and the "HGL off" is the highest operational hydraulic grade desired.
Corresponding controls should be entered to turn the pump on and off during an EPS simulation. Note that typically
a transient simulation will use steady state initial conditions, so these fields are not considered; only the steady state
HGL and user-entered gas volume are used to define the initial volume and head for the transient simulation.
Volume (effective) - Exposed when using the constant area approximation method. Represents the volume between
the HGL on and HGL off fields.
Note: The "atmospheric pressure head" field is not used during the transient simulation. The transient
calculation engine assumes an atmospheric pressure head of 1 atm or 10.33 m.
Gas Law vs. Constant Area Approximation

For the initial conditions, you must select either "gas law" or "constant area approximation" for the "Tank calculation
model" attribute of the hydropneumatic tank. The constant area approximation selection exposes the "Volume
(effective)," "HGL on," and "HGL off" fields. The gas law selection exposes the "Atmospheric pressure" field. These
fields are primarily there to support the WaterCAD and WaterGEMS products, which can directly open a HAMMER
model. They are only used to track the change in HGL/volume for EPS simulations, which typically aren't used in
HAMMER. A transient analysis typically begins with a steady state simulation, which only considers the "HGL
(Initial)" and "volume of gas (initial)". This is because a steady state simulation is a snapshot in time, so the head/
volume are not changing. So in most cases, it does not matter which tank calculation method you choose. You will
likely want to select "gas law" for simplicity, but additional information on both approaches is provided below.
Constant area approximation: This method approximates a hydropneumatic tank by using a tall, thin tank whose
water surface elevation approximates the HGL in a hydropneumatic tank. The HGL on and HGL off fields represent
the maximum and minimum hydraulic grade lines within the hydropneumatic tank (i.e. when an associated booster
pump would turn on or off). An approximate diameter is computed based on the effective volume of the
hydropneumatic tank so that the tank cross sectional area multiplied by the distance between HGL on and HGL off
gives the same volume as the hydropneumatic tank.
Gas Law: This method uses the ideal gas law, PV=nRT, to compute new hydraulic grades as liquid volume changes
in the EPS simulation (nRT is assumed to be constant). The initial liquid volume is subtracted from the total tank
volume to find the gas volume. The physical "elevation" is subtracted from the initial HGL to find the gauge
pressure. The atmospheric pressure is added to the gauge pressure to get absolute pressure, which is used in the
ideal gas law equation.
159
Creating Models
Both methods typically yield similar results within the "effective" control range, but the gas law is technically more
accurate.
Transient Simulation Attributes

The following hydropnematic tank attributes influence the transient simulation:
Hydropneumatic Tank Type - Specify the type of Hydropneumatic Tank that this model element represents. Sealed
means the tank is a fully sealed pressure vessel. Vented means the tank has an air valve attached. Dipping Tube
means the tank has an internal dipping or ventilation tube.
Diameter (Tank Inlet Orifice) - This is the size of the opening between the gas vessel and the main pipe line. It is
typically smaller than the main pipe size. It is used to compute the correct velocity through the tank inlet, so the
correct headloss is computed based on the minor loss coefficient (the standard head loss equation is used: Hl =
K*V2/2g.)
Diameter (Dipping Tube) - The diameter of the dipping or ventilation tube within the hydropneumatic tank (only
applicable for the Dipping Tube tank type).
Volume (Compression Chamber) - The volume of the air around the dipping tube that is compressed once the water
level elevation exceeds the bottom of the dipping tube.
Air Flow Calculation Method - Specify whether the air valve air flow rate is determined by user-entered curves of
pressure vs. air flow rate, or whether it is calculated based on a user-entered orifice diameter (not applicable for a
sealed hydropneumatic tank). The calculated Air Flow result attribute shown in the detailed report shows the
volumetric flow rate of air at the conditions present inside the pipeline.
Diameter (Air Inflow Orifice) - This is the equivalent orifice size of the opening that allows air to enter the tank.
Diameter (Air Outflow Orifice) - This is the equivalent orifice 1size of the opening that allows air to leave the tank.
Air Flow Curve (Air Inflow Orifice) - The curve that defines the rate of air inflow (a 'free air' rate, measured at
atmospheric pressure) into the tank versus the differential pressure across the air valve.
Air Flow Curve (Air Outflow Orifice) - The curve that defines the rate of air outflow (a 'free air' rate, measured at
atmospheric pressure) out of the tank versus the differential pressure across the air valve.
Elevation (Top of Dipping Tube) - The elevation of the top of the dipping tube and the dipping tube-type
hydropneumatic tank.
Elevation (Bottom of Dipping Tube) - The elevation of the bottom of the dipping tube.
Dipping Tube Hydropneumatic Tank Parameters
160
Creating Models
Minor Loss Coefficient (Outflow) - This is the 'k' coefficient for computing headlosses using the standard headloss
equation, H = kV2/2g. It represents the headlosses for tank outflow. If you lump other minor losses through the tank
assembly (bends, fittings, contractions, etc) into this coefficient, keep in mind that the velocity is calculated using
the area of the "diameter (tank inlet orifice)" that you entered.
In some cases, you may want to analyze a range of different initial conditions, which could potentially change the
starting hydraulic grade of your hydropneumatic tank. The gas law can be employed in this case. For example, if you
know the initial gas volume is 300 L at a steady state pressure head of 50 m, you can compute the 'K' constant using the
gas law, PVk=K: (50 m + 10.33 m)(0.3m3) = 18.099. (gas law exponent assumed to be 1.0) So, if your new steady state
pressure head is 30 m, the new initial gas volume (which you must enter) is computed as V = (18.099)/(30 m+10.33 m)
= 0.449 m3 = 449 L. The transient calculation engine always uses an atmospheric pressure head of 1 atm or 10.33 m
when solving the gas law equation.
Has Bladder? - Denotes whether the gas is contained within a bladder. If it is set to "True", HAMMER
automatically assumes that the bladder occupied the full-tank volume at the preset pressure at some time and that
the air volume was compressed to a smaller size by the steady-state pressure in the system. The "Volume of gas
(initial)" is not used in this case, since it is calculated based on the full tank size, preset pressure and steady state
pressure.
Pressure (Gas-Preset) - This is the pressure (not a hydraulic grade) in the gas bladder before it is exposed to pipeline
pressure; the pressure when it fills the entire tank volume. Often called the "precharge" pressure; it is only exposed
when selecting "true" for "Has bladder?"
Report Period - used to report extended results in the Transient Analysis Detailed Report. Represents a timestep
increment. For example, entering '10' would cause extended results to be reported every 10 timesteps.
Elevation Type - This allows you to specify the type of approach used in tracking the gas-liquid interface (a new
feature as of version 08.11.01.32). By default, the liquid surface elevation is not tracked and is essentially assumed
to be fixed, at the tank physical bottom elevation. For more information on how this option is used for tracking the
liquid elevation, see Tracking the Air-Liquid Interface (on page 161).
Tracking the Air-Liquid Interface

The "Elevation Type" field in the Hydropneumatic tank properties allows you to control how the air-liquid interface
(water surface elevation) is tracked. This field presents 3 options, Fixed, Mean Elevation and Variable Elevation.
161
Creating Models
Fixed
This is the default option for the "Elevation Type" field and is consistent with the behavior of previous versions (prior
to 08.11.01.32). The liquid elevation is assumed to be at a fixed location during the transient simulation, equal to the
bottom of the tank. The gas pressure used in the gas law equation is then equal to the hydraulic grade line within the
tank, plus the atmospheric pressure, minus the tank's base elevation.
This is acceptable for most cases, mainly because the elevation difference between the range of possible liquid levels is
typically quite small. So, it does not account for much of a pressure difference. This can be observed by adjusting the
"Elevation" attribute in the tank properties.
Mean Elevation
Selecting "Mean Elevation" exposes the "Liquid Elevation (Mean)" field, which allows you to specify a custom liquid
(water surface) elevation, instead of assuming it is equal to the tank bottom (as is with the "fixed" option). It represents
the average elevation of the liquid/gas interface throughout a transient simulation. This is useful in cases where the
liquid elevation is significantly higher than the tank bottom, but doesn't move significantly during a transient
simulation. So, although no tracking of changes in liquid elevation occurs, it allows you to get a more accurate
calculation in some cases. The absolute gas pressure used in the gas law equation during the calculations based on the
mean elevation that you enter.
Variable Elevation
Selecting "Variable Elevation" exposes the "Variable Elevation Curve" field, which allows you to enter a table of liquid
elevation versus equivalent diameter. The variable level hydropneumatic tank type is for users who have detailed
information about the tank's geometry and want to perform as accurate a simulation as possible. Typically, this type of
representation would be selected in the detailed design stage. It would also be appropriate in the case of low-pressure
systems and/or relatively tall tanks with large movements of the interface relative to the HGL of the gas. The initial
liquid level is determined from the initial gas volume which is an input parameter. The tank cross-sectional area at any
elevation is interpolated from an input table of the vessel's geometry spanning the range from the pipe connection at the
bottom to the top of the tank.
Reporting
After computing the transient simulation with a variable elevation hydropneumatic tank, you can view the liquid level
over time by looking at the Transient Analysis Detailed Report. This report is found under Report > Transient Analysis
Reports and will show this extended, tabular data for the tank when you've entered a value for the "report period"
property of that tank.
Variable Elevation Curve Dialog Box

This dialog allows you to define the variable elevation curve for hydropneumatic tanks.
162
Creating Models
The variable level hydropneumatic tank type is for users who have detailed information about the tank's geometry and
want to perform as accurate a simulation as possible. Typically, this type of representation would be selected in the
detailed design stage. It would also be apropos in the case of low-pressure systems and/or relatively tall tanks with large
movements of the interface relative to the HGL of the gas. The initial liquid level is determined from the initial gas
volume which is an input parameter. The tank cross-sectional area at any elevation is interpolated from an input table of
the vessel's geometry spanning the range from the pipe connection at the bottom to the top of the tank.
the Report button generates a preformatted report displaying the Liquid Elevation vs. Diameter (Equivalent) data points
for the current elevation curve.
Acces this dialog by setting the hydropneumatic tanks Elevation Type to Variable Elevation and by clicking the
ellipsis button in the Variable Elelvation Curve field.
Surge Valves
Surge Valve elements represent a surge-anticipator valve (SAV), a surge relief valve (SRV), or both of them combined.
A SAV opens on low pressure in anticipation of a subsequent high pressure. A SRV opens when pressure exceeds a
threshold value.
The following attributes describe the surge-anticipator valve behavior:
Threshold Pressure (SAV): Pressure below which the SAV opens.
SAV Closure Trigger: The closure of an open/opening SAV is initiated either by time (Time SAV Stays Fully Open
attribute) or the threshold pressure (Threshold Pressure attribute), but not both. When based on pressure, the SAV
will begin to close when the pressure rises back above the specified Threshold Pressure (SAV) value, which may
occur before the SAV has fully opened.
Time for SAV to Open: Amount of time that the SAV takes to fully open after being triggered.
Time SAV Stays Fully Open: Amount of time that the SAV remains fully open (i.e., the time between the end of
opening phase and the start of the closing phase).
Time for SAV to Close: Amount of time for the SAV to close fully, measured from the time that it was completely
open.
There are three optional valve configurations as defined by the attribute SAV/SRV type: (1) Surge Anticipator Valve,
(2) Surge Relief Valve, and (3) Surge Anticipator & Relief Valve.
For the SAV, at full opening it's capacity is represented by the discharge coefficient Cv, while the valve characteristics
at partial openings are provided by the valve curves discussed in Closing Characteristics of Valves (note that there is no
user-specified valve currently provided for the SAV).
163
Creating Models
The SRV is modelled as being comprised of a vertical-lift plate which is resisted by a compressed spring. At the
threshold pressure, there is an equilibrium between the compressive force exerted by the valve's spring on the movable
plate and the counter force applied by the pressure of the liquid. For a linear spring, the lift x is given by the equation:
A (P - P0) = k x, where A is the pipe area, P is the instantaneous pressure, P0 is the threshold pressure, and k is the
spring constant. In this formulation, the acceleration of the spring and plate system is ignored. As the plate lifts away
from the pipe due to the excess pressure, more flow can be vented to atmosphere to a maximum value at 0.937 times
the pipe diameter.
Check Valves
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 valves closure is partial.
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 valves 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 esceeds the downstream
pressure.
Rupture Disks
A rupture disk node is located between two pipes. It is designed to fail when a specified threshold pressure is reached.
This creates an opening in the pipe through which flow can exit the system to atmosphere.
If the disk is intact, then this node is represented as a typical Junction. After the threshold pressure is exceeded, it is
presumed that the disk has blown off and the liquid rushes out of the newly-created orifice discharging to atmosphere.
164
Creating Models
Discharge to Atmosphere Elements

Models a point where flow leaves the pipe network and discharges to atmosphere. There are three choices for the
Discharge Element Type:
Orifice - represents an opening to atmosphere at a junction of two or more pipes or the end of a single pipe. The
initial pressure is typically positive and there is usually an outflow from the system at time zero. If the pressure P is
positive, then the outflow/demand is Q =
Qi. summed over all the Branches, i. P varies quadratically with Q. When the pressure drops to zero, this element
allows air to enter the pipeline freely on the assumption that the opening for the liquid is infinite for air. In this case,
the air pocket respectively expands or contracts accordingly as the liquid flows away from or towards the node, but
the air remains at the branch end point(s) located at the orifice.
Valve - discharges water from the system at a pipe end open to atmospheric pressure. It is essentially an Orifice to
Atmosphere with a variable diameter which could become zero; optionally, the valve can start the simulation in the
closed position and proceed to open after a time delay. As long as the diameter is positive, either outflow for
positive pressure or injection of air for zero pressure are possible. In the latter case, the rate of change of the air
volume Xi in each branch is described by the relation dXi / dt = - Qi, with the total volume X being the summation
over all branch volumes Xi. After the valve closes, it behaves like a Junction element (and as a dead end junction if
there is only a single branch connected).
Rating Curve - releases water from the system to atmosphere based on a customizable rating curve relating head and
flow. Below a certain value of head, the discharge is zero; in stage-discharge relations, head is equivalent to level
for which the discharge increases with increasing level.
165
Creating Models
Orifice Between Pipes Elements

This element represents a fixed-diameter orifice which breaks pressure, useful for representing choke stations on high-
head pipelines.
Valve with Linear Area Change Elements

This element functions either as a check valve that closes instantaneously and remains closed when reverse flow occurs,
or as a positive-acting leaf valve closing linearly over the prescribed time. An ideal valve useful for verifying best-case
assumptions or representing motorized valves.
The head loss/discharge coefficient accounts for the vena contracta by means of a formula for two-dimensional flow
solved with the Schwartz-Christoffel transformation.
If the check valve closes, it remains shut independent of the pressure difference across it. When the valve is closed,
independent vapor pockets can exist on both sides of the valve.
166
Creating Models
Surge Tanks
A surge tank (also known as a stand pipe) typically has a relatively small volume and is located such that its normal
water level is typically equal to the hydraulic grade line at steady state. When low transient pressures occur, the tank
feeds water into the system by gravity to avoid subatmospheric pressure at the tank connection and vicinity.
There are two different surge tank types, as defined in the attribute called Surge Tank Type.
Simple Surge Tanks
This node can operate in three distinct modes during a transient analysis: normal (level between the top and the
connecting pipe(s) at the bottom); weir overflow (level at the top) with the cumulative volume being tracked and
printed in the output log; and drainage (level at the elevation of the connecting branch(es)).
If equipped with an optional check valve, it becomes a one-way surge tank which supplies the pipeline with liquid
whenever the adjacent head is sufficiently low (the refilling operation is a slow process which is not represented in
HAMMER). During normal operation, the continuity equation applied to this node is dHT / dt = Q / A, where HT is the
tank level, A is the tank's cross-sectional area and Q =
Qi is the net inflow to the tank. At the mouth of the tank, there is a differential orifice with head loss
, where the subscripts T and or refer to the tank and orifice, respectively, b is the head loss coefficient and d = di for
inflow (Q > 0) and -1 for outflow (Q < 0). By definition, d (known as the Ratio of Losses in HAMMER) asserts that
head losses are di times greater for inflow than for outflow. A typical value of di is 2.5.
A user can optionally choose a Section type for the Simple Surge Tank. The choices are: a). Circular - so a tank
diameter is required; b). non-circular - so an equivalent cross-sectional area is required; or c). variable area - where the
cross-sectional area is provided in a table as a function of elevation. Note that for variable area tanks there is no facility
for a check valve to preclude inflow to the tank.
167
Creating Models
168
Creating Models
Differential Surge Tanks

There are numerous modes of operation for differential surge tanks ranging from drainage, with the entry of air into the
pipeline, to overflow from the tank. Other modes are distinguished by the riser level relative to the orifice elevation and
the tank level versus the top of the riser. For "normal" operation, the tank level is between the orifice and the top of the
riser. During a powerful upsurge, the upper riser will overflow into the tank to complement the orifice flow.
169
Creating Models
Protective Equipment Reference

Combination Air Valve (CAV)is installed at local high points to allow air to come into the system during periods
when the head drops below the pipe elevation and expels air from the system when water columns begin to rejoin.
The presence of air in the line limits subatmospheric pressures in the vicinity of the valve and for some distance to
either side, as shown on HAMMER profile graphs. Air can also reduce high transient pressures if it is compressed
enough to slow the water columns prior to impact. This valve requires the following parameters:
Initial Air Volume near the valve at the start of the simulation. The default value is zero. If there is an initial air
volume, pressure at the valve must be equal to zero at the start of the simulation.
Small Outflow Diameter is the size of the opening that releases air from the system when the volume of air is less
than the Transition Volume. This diameter is typically small enough to throttle air flow, compressing any air
remaining in the system.
Transitional Volume is the threshold volume of air at which the outflow diameter changes between the smaller and
bigger size. The default value of this parameter is zero.
Outflow Diameter is the size of the opening that releases air from the system when the volume of air is greater than,
or equal to, the Transition Volume. This diameter is typically larger than the Small Outflow Diameter. Because it is
rare for this to throttle, the default value of this diameter is considered to be infinite.
Inflow Diameter is the size of the opening that lets air enter the system. This diameter is typically large to allow the
free entry of air without throttling. By default, this diameter is considered infinite in HAMMER.
Air Valve (Slow-Closing) between 2 Pipesallows air into the system freely when the head drops to below the pipe
elevation and releases air and/or fluid from the pipe when head increases again. Also known as a downsurge relief
valve. Unlike a CAV, the large outlet closes over a preset time period. This valve requires the following parameters:
Time to close the valve. Valve starts to close only when air begins to exit the pipe. If air reenters, then the valve
opens fully again.
170
Creating Models
Diameter is the size of the valve opening for inflow and outflow.
SAV/SRV at End of 1 Piperepresents a surge-anticipator valve (SAV), a surge relief valve (SRV), or both of
them combined. A SAV opens on low pressure in anticipation of a subsequent high pressure. A SRV opens when
pressure exceeds a threshold value. These valves require the following parameters:
Type of Valve(s) provides three possible valve types: SAV, SRV, and SAV+SRV.
Diameter of Orifice/ Throat for the liquid discharged by the valve.
Parameters for SRV
Diameter is the opening available to release fluid from the system.
Threshold Pressure is the critical pressure at which the SRV opens. This may be controlled by a spring, piloting, or
other mechanism.
Spring Constant represents the restoring force of the return spring per unit lift off the valve seat. A typical value of
this constant is 150 lb/in (26.27 N/mm).
Parameters for SAV:
Diameter is not used by HAMMER but useful for display. Flow through the valve is determined based on the Cv at
Full Opening and valve type. It is assumed that the percent of open-area curve for each valve type corresponds to its
Cv curve.
Threshold Pressure is the critical pressure below which the SAV opens.
Type of SAV provides five options: Needle, Circular Gate, Globe, Ball, and Butterfly.
Time to Open is the time required to open the SAV fully upon activation.
Open Time is the time the SAV remains fully open (i.e., the time between the valve's opening and closing phases).
Time to Close is the time required to close the SAV fully. SAV must be closed as soon as pressures are relieved to
avoid developing too high a return-flow velocity. SAV may not be able to close against extremely high reverse-flow
velocities for certain pilot configurations.
CV at Full Opening refers to the valve coefficient, which is a function of flow through the valve and the
corresponding pressure drop across it.
SAV/SRV between 2 Pipesoperates in the same way and requires the same parameters as the SAV/SRV at End of
1 Pipe hydraulic element described previously.
Note: In rare circumstances when the pressure is zero or negative at the SAV, in reality air would be sucked into
the pipeline through the valve. However air inflow is not modeled by WaterGEMS V8i. Instead, this condition is
modeled by not adding negative inflows, but retaining the negative flow that is predicted.
Other Tools
Although WaterGEMS V8i is primarily a modeling application, some additional drafting tools can be helpful for
intermediate calculations and drawing annotation. MicroStation and AutoCAD provide a tremendous number of
drafting tools. WaterGEMS V8i itself (including Stand-Alone) provides the following graphical annotation tools:
Border tool
Text tool
Line tool.
You can add, move, and delete graphical annotations as you would with any network element (see Manipulating
Elements (on page 180)).
Border Tool
171
Creating Models
The Border tool adds rectangles to the drawing pane. Examples of ways to use the Border tool include drawing property
lines and defining drawing boundaries.
To Draw a Border in the Drawing View
1. Click the Border tool in the Layout toolbox.
2. Click in the drawing to define one corner of the border.
3. Drag the mouse cursor until the border is the shape and size you want, then click.
Text Tool
The text tool adds text to the drawing pane. Examples of ways to use the Text tool include adding explanatory notes,
titles, or labels for non-network elements. The size of the text in the drawing view is the same as the size of labels and
annotations. You can define the size of text, labels, and annotation in the Drawing tab of the Tools > Options dialog.
To Add Text to the Drawing View
1. Click the Text tool in the Layout toolbox.
2. Click in the drawing to define where the text should appear.
3. In the Text Editor dialog, type the text as it should appear in the drawing view, then click OK. Note that text will be
in a single line (no carriage returns allowed). To add multiple lines of text, add each line separately with the Text
tool.
To Rotate Existing Text in the Drawing View
1. Click the Select tool in the Layout toolbox.
2. Right-click the text and select the Rotate command.
3. Move the mouse up or down to define the angle of the text, then click when done.
To Edit Existing Text in the Drawing View
2. Right-click the text and select the Edit Text command.
3. Make the desired changes in the Text Editor dialog that appears, then click OK.
Line Tool
The Line tool is used to add lines and polylines (multi segmented lines) to the drawing pane. WaterGEMS V8i can
calculate the area inside a closed polyline. Examples of ways to use the Line tool include drawing roads or catchment
outlines.
To Draw a Line or Polyline in the Drawing View:
1. Click the Line tool in the Layout toolbox.
2. Click in the drawing to define where the line should begin.
3. Drag the mouse cursor and click to place the line, or to place a bend if you are drawing a polyline.
4. Continue placing bends until the line is complete, then right-click and select Done.
To Close an Existing Polyline in the Drawing View:
2. Right-click the polyline and select the Close command.
To Calculate the Area of a Closed Polyline:
172
Creating Models

2. Right-click the polyline and select the Enclosed Area command.
To Add a Bend to an Existing Line or Polyline:
2. Right-click at the location along the line or polyline where the bend should be placed and select the Bend > Add
Bend command.
To Remove Bends from an Existing Line or Polyline:
2. Right-click the bend to be removed and select the Bend > Remove Bend command. To remove all of the bends from
a polyline (not a closed polyline), right-click the polyline and select the Bend > Remove All Bends command.
Pump and Turbine Characteristics in WaterGEMS V8i

The pump and turbine characteristics used in WaterGEMS V8i are defined in the following files:
C:\Program Files\Bentley\<Product Name>8\QuadrantCurvesPredefined.txt
C:\Program Files\Bentley\<Product Name>8\QuadrantCurves.txt
Note: For a 64-bit installation of WaterGEMS V8i, the folder location is C:\Program Files\Bentley\<Product
Name>8\x64.
The 'QuadrantCurvesPredefined.txt' file contains predefined pump and turbine characteristics, and should not be edited.
The 'QuadrantCurves.txt' file is available for users to enter their own data.
Both files contain characteristics for pump/turbine units of a particular specific speed. When defining a pump or turbine
in the WaterGEMS V8i application itself, users should select the closest available specific speed to the unit they are
modeling.
If the actual pump or turbine characteristics are available, users should enter those using them methods described in this
document.
General
The files start with the following header:
*** <Product Name> AUXILIARY DATA FILE ***
Each file is then broken into two sections - one for pumps and one for turbines - as indicated by the following lines in
the file:
[PUMPS]
[TURBINES]
Pump Data
Pump data can be specified in one of two formats: circular format, or Suter format. Details for the different formats are
as follows.
Circular
The relative values of Q (flow) and N (speed) along lines of 100% head (QH and NH) and 100% torque (QM and NM)
are entered at a suitable interval throughout the entire operating range of the pump. WaterGEMS V8i can then use these
curves to calculate the values of head and torque for any values of Q and N using homologous relations.
173
Creating Models
The data file format is given below - fields in italics need to be replaced with appropriate values: SPECIFIC SPEED
(US/SI): [Specific speed, US units] / [Specific speed, SI units]CURVE FORMAT: CircularFormatHEAD: NHDQH,1
NH,1QH,2 NH,2. .. .QHNHD NH,NHDTORQUE: NMDQM,1 NM,1QM,2 NM,2. .. .QM,NMD NM,NMD
Where NHD and NMD are the number of head and torque data points respectively.
The discharges and speeds are given in percent (%) and are relative to the pump's rated discharge and speed. The
specific speed must be entered as an integer value so that it can be correctly parsed to appear in the WaterGEMS V8i
user interface. Also note that large positive and negative Flow, Speed pairs are recommended in order to properly
describe the asymptotes of the 4 quadrant curves.
An example of pump characteristics using this format is presented in the figure below:
174
Creating Models
Suter Format
An alternative file format uses a method attributed to Suter, described in Fluid Transients (Wylie & Streeter, 1978). In
this format, pump characteristic data is presented in terms of two angular functions, WH(x) and WB(x) which are
determined using the following relations:
175
Creating Models
Where
are respectively the non-dimensional head, discharge, torque and speed normalized by the rated head, discharge, torque
and speed. The data file format is as follows: SPECIFIC SPEED (US/SI): [Specific speed, US units] / [Specific speed,
SI units]CURVE FORMAT: SuterFormatHEAD: NHDx1 WH1x2 WH2. .. .xNHD WHNHDTORQUE: NMDx1
WB1x2 WB2. .. .xNMD WBNMD
Where NHD and NMD are the number of head and torque data points respectively.
Note that in order to provide satisfactory calculation results, it is important to describe points where the sign of the
WH(x) and WB(x) functions changes from positive to negative and vice versa. However, due to internal translations in
the WaterGEMS V8i engine, WH(x) and WB(x) can approach, but should never equal, zero (minimum values of 0.0001
are suggested for both functions).
An example of pump characteristics entered using this format is given in the figure below:
176
Creating Models
Turbines
The turbine data format is similar to that used for circular format for pumps, except data is also required for different
wicket gate positions. Suter format is not currently supported for turbines. In addition, turbines in WaterGEMS V8i are
always expected to operate in the first quadrant of operation (positive flow and positive speed).
The data file format is follows: SPECIFIC SPEED (US/SI): [Specific speed, US units] / [Specific speed, SI
units]NUMGATES: NGGATE: WG1 ND1H1,1 Q1,1 P1,1H1,2 Q1,2 P1,2. . .. . .H1,ND1 Q1,ND1
P1,ND1. . .. . .GATE: WGNG NDNGHNG,1 QNG,1 PNG,1HNG,2 QNG,2 PNG,2. . .. . .HNG,NDNG QNG,NDNG
PNG,NDNG
177
Creating Models
Where NG represents the number of different wicket gate openings described in the data; WGi represents a particular
gate opening value; ND is the number of data points for the associated gate opening value; H, Q and P represent head,
flow and power respectively (the first subscript of H, Q and P denotes wicket gate position index, while the second one
is the data index for that wicket gate position);
It should be noted that:
(a) WGi, Hi,j , Qi,j and Pi,j are in percent (%) relative to rated head, flow and power (H, Q and P), or full gate opening
(WG)
(b) WGi increases with i.
(c) Hi,j , Qi,j and Pi,j decrease with j, for fixed i.
(d) WGi should be between 20% and 100% (inclusive). Below 20% gate opening, WaterGEMS V8i currently assumes a
linear decrease in flow until the time the gate opening equals 0%.
An example of turbine characteristics is given in the figue below (note: some data is omitted so the figure can fit on a
single page).
178
Creating Models
Entering user-defined pump and turbine characteristics

To enter user-defined pump and turbine characteristics, users should follow these steps:
1. Close down WaterGEMS V8i.
2. Browse to C:\Program Files\Bentley\<Product Name>8 and open the QuadrantCurves.txt file.
3. Enter the data using one of the formats described above. Pump data should go immediately after the [PUMP] line in
the QuadrantCurves.txt file; turbine data should go after the [TURBINE] line.
4. Make a note of the specific speed values entered for the pump / turbine.
5. Save and close QuadrantCurves.txt.
6. Open WaterGEMS V8i, and then open a file (or create a new one).
7. For a pump, go to Components > Pump Definitions > Transient > Specific Speed and select the specific speed for
the data you just entered (see step 4). Now for each pump that uses this pump definition, WaterGEMS V8i will use
the user-defined pump characteristics in the calculations.
8. For a turbine, right-click on the turbine and select Properties. Then chose the appropriate specific speed in the
'Specific Speed' field (see step 4). WaterGEMS V8i will now use the user-defined turbine characteristics in the
calculations.
How The Pressure Engine Loads HAMMER Elements

The pressure engine models the various WaterGEMS V8i elements as follows:
Periodic Head/Flow Element using Head: A reservoir with the HGL determined from the sinusoidal wave
properties, or from the head pattern. Only the initial (time zero) HGL is applied so that the steady state analysis will
correspond to the transient initial conditions.
Periodic Head/Flow Element using Flow: A junction with demand determined from the sinusoidal wave properties,
or from the flow pattern. Only the initial (time zero) flow is applied so that the steady state analysis will correspond
to the transient initial conditions.
Air Valve: If the "Treat Air Valve as Junction" property is set to True the Air Valve is loaded as a junction with no
demand. If the "Treat Air Valve as Junction" property is set to False, the air valve is loaded such that it opens the
system to atmosphere. This is most commonly used to simulate high points in pumped sewer systems, so the default
behavior is to treat the air valve as a junction.
Hydropneumatic Tank: A hydropneumatic tank is loaded as a normal tank with the properties of the tank being
dictated by the tank calculation model that is used.
Surge Valve: Junction with no Demand.
Check Valve: Short Pipe with a Check Valve in line with the direction of flow.
Rupture Disk: Junction with no demand.
Discharge to Atmosphere: For the Orifice and Valve types this element is loaded as a junction with emitter
coefficient determined by the flow and pressure drop properties. If either of these properties are invalid (<= 0) then
no emitter coefficient is loaded. Furthermore, for the valve type if the valve is initially closed, no emitter coefficient
is loaded. For the rating curve type this element is loaded as a reservoir connected to a GPV with rating curve used
as the GPV headloss curve.
Valve with linear area change: GPV with a headloss curve based on the valve's discharge coefficient.
Turbine: GPV using the turbine's headloss curve.
Orifice: GPV with a headloss curve calculated from the nominal head/flow loss using the orifice equation.
Surge Tank: Without a check valve, this element is loaded as a tank. With a check valve this element is loaded as a
Junction.
179
Creating Models
Adding Elements to Your Model
WaterGEMS V8i provides several ways to add elements to your model. They include:
Adding individual elements
Adding elements using the layout tool
Replacing an element with another element.
To add individual elements to your model
1. Click an element symbol on the Layout toolbar. The mouse cursor changes to the element symbol you selected.
2. Click in the drawing pane to add the element to your model.
3. Click again to add another element of the same type to your model.
4. To add a different element, click on the desired element symbol in the Layout toolbar, then click in the drawing
pane.
5. To stop adding elements, right-click in the drawing pane to display a shortcut menu, then click Done.
To add elements using the layout tool
The layout tool is used to quickly add new elements to your model without having to select a new element button on the
Layout toolbar. When the layout tool is active, you can right-click in the drawing pane to select different elements and
pipes to add to the model.
1. Click the Layout tool on the Layout toolbar.

2. Right-click in the drawing pane, then select the type of element you want to add from the shortcut menu. The
shortcut menu displays only those element types that are compatible with your pipe selection.
3. Click in the drawing pane to add the element.
4. Click again to add another of the same element type. The elements you add will automatically be connected by
pipes.
5. To change the element, right-click and select a different element from the shortcut menu.
6. To stop adding elements using the Layout tool, right-click anywhere in the drawing pane and click Done.
Manipulating Elements
You can manipulate elements in your model in any one of the following ways:
Select elementsManually select individual elements, manually select multiple elements, select all elements, or
select all elements of a single element type. See Select, Move, and Delete Elements (on page 181).
Move elementsMove elements in the drawing pane. See Select, Move, and Delete Elements (on page 181).
Delete elementsRemove elements from the model. See Select, Move, and Delete Elements (on page 181).
Split pipesSplit an existing pipe into two new pipes by adding a new node element along the existing pipe. See
Splitting Pipes (on page 182).
Reconnect pipesDisconnect an exisiting pipe from an existing node element and attach it to another existing
node element. See Reconnect Pipes (on page 182).
180
Creating Models
Model curved pipesYou can lay out curved pipes. See Modeling Curved Pipes (on page 183).
Assign isolation valves to pipesThis tool finds the nearest pipe for each of the specified isolation valves and
assigns the valve to that pipe. See Assign Isolation Valves to Pipes Dialog Box (on page 183).
Batch split pipesThis tool allows you to split pipes with neighboring nodes that are found within the specified
tolerance. See Batch Pipe Split Dialog Box (on page 184).
Batch morph nodesThis tool allows you to morph a selected node type into another type of node element as a
batch operation. See Batch Morph (on page 186).
Merge nodes in close proximityallows you to merge together nodes that fall within a specified tolerance of one
another. See Merge Nodes in Close Proximity (on page 187).
Select links adjacent to one or more nodesThis command lets you select all link elements attached to one or
more nodes. See Select Adjacent Links (on page 188).
Select, Move, and Delete Elements

The following element selection options are available:
To manually select an element:
Click the element. Selected elements appear in red.
Note: You can change the selection color in the Options dialog box, which is accessible by selecting Tools >
Options.
To manually select multiple elements:

Click the first element, then click additional elements while holding down Shift or Ctrl.
To select elements by drawing a polygon:
1. Select Edit > Select By Polygon.
2. Click in the drawing pane near the elements you want to select, then drag the mouse to draw the first side of the
polygon.
3. Click again to finish drawing the first side of the polygon and drag the mouse to begin drawing the next side of the
polygon.
4. Repeat step 3 until the polygon is complete, then right-click and select Done.
To select all elements:
To select all of the elements in your model, select Edit > Select All.
To select all elements of the same type:
To select all elements of the same type (for example, all junction chambers), select Edit > Select by Element, then click
the desired element type.
All elements of the selected type appear in red, including connecting pipes.
To clear selected elements:
Click the Select tool then click any blank space in the drawing pane.
Or
Click Edit > Clear Selection.
Or
Press the Esc key.
181
Creating Models
You can also clear a selected element by clicking a different element.

To move an element in the model:
1. Click the Select tool on the Layout toolbar.
2. Select the element(s) you want to move, then drag it to its new location. Pipe connections move with the element.
To delete an element:
Select the element, then press Delete
Or
Select Edit > Delete.
Splitting Pipes
You may encounter a situation in which you need to add a new element in the middle of an existing pipe. For example,
you may want to insert a new manhole to maintain maximum access hole spacing.
To split an existing pipe:
1. Select the desired element symbol on the Layout toolbar.
2. In the drawing pane, place the cursor over the pipe you want to split and click.
3. You are prompted to confirm that you want to split the pipe.
4. If you choose to split the pipe, the element will be inserted and two new pipes will be created with the same
characteristics as the original pipe (lengths are split proportionally).
5. If you choose not to split the pipe, the new element will be placed on top of the pipe without connecting to anything.
If you accidentally split a pipe, this action can be undone by selecting Edit > Undo.
You can also split an existing pipe with an existing element:
To do this in the Stand-Alone version, drag the element into position along the pipe to be split, then right-click the node
and select Split <Pipe Label> from the shortcut menu (where <Pipe Label> is the name of the pipe to be split).
To do this in the MicroStation version, drag the element into position along the pipe to be split. Hold down the Shift
key, then right-click the node and select Split <Pipe Label> from the shortcut menu (where <Pipe Label> is the name of
the pipe to be split).
Reconnect Pipes
In certain circumstances, you may wish to disconnect a pipe from a node without deleting and redrawing the pipe in
question. For example, if the model was built from a database and the Establish By Spatial Data option was used to
determine pipe connectivity, pipes may have been connected to the wrong nodes.
To disconnect and reconnect a pipe:
1. Right-click the pipe to be disconnected close to the end of the pipe nearest the end that you want disconnected.
2. The pipe is now connected to the junction that it will remain connected to and your mouse cursor. Hover the mouse
cursor over the junction to which you would like to connect the pipe and click the left mouse button. The pipe will
now be connected to this junction.
182
Creating Models
Modeling Curved Pipes

You can model curved pipes in WaterGEMS V8i by using the Bend command, which is available by right-clicking in
the Drawing Pane when placing a link element.
The software does not account for any additional head loss due to the curvature because in most cases the increased
head loss is negligible. If you feel the extra head loss is significant, it is possible to increase the Manning's n value to
account for such losses.
To model a curved pipe:
1. Select the desired link element using the Layout button on the Layout toolbar.
2. Place the first segment of the curved pipe in your model, then right click and select Bend from the shortcut menu.
3. Repeat Step 2 for each segment in the curved pipe. Be sure to insert bends to clearly show the curved alignment.
4. When the curved pipe is complete, right click and select the next downstream element (for a conduit, this is usually
a manhole).
Assign Isolation Valves to Pipes Dialog Box

The Assign Isolation Valves to Pipes tool finds the nearest pipe for each of the specified isolation valves and assigns
the valve to that pipe.
Choose Features to Process Allows you to specify which isolation valves to include in
the assignment operation. The following options are
available: All : All isolation valves within thmodel will be
assigned to their nearest pipe. Selection : Only the
isolation valves that are currently selected in the drawing
pane will be assigned to their nearest pipe. Selection Set :
Only those isolation valves that are contained within the
selection set specified in the drop down list will be
assigned to their nearest pipe.
183
Creating Models
Also process isolation valves that already have an When this box is checked, the assign operation will also
associated pipe assign to the nearest pipe those valves that are already
assigned to a pipe.
Allow assignment to inactive pipes When this box is checked, pipes that are marked Inactive
will not be ignored during the assignment operation.
The relationship between an isolation valve and their referenced pipe is displayed in the drawing pane with a dashed
line, like this:
Batch Pipe Split Dialog Box

The Batch Pipe Split dialog allows you to split pipes with neighboring nodes that are found within the specified
tolerance.
184
Creating Models
Choose Features to Process Allows you to specify which pipes to include in the split
operation. The following options are available: All : All
pipes in the model that have a neighboring node within
the specified tolerance will be split by that junction.
Selection : Only the pipes that are currently selected in the
drawing pane will be split by a neighboring junction that
lies within the specified tolerance. Selection Set : Only
those pipes that are contained within the selection set
specified in the drop down list will be split by a
neighboring junction that lies within the specified
tolerance.
Allow splitting with inactive nodes When this box is checked, nodes that are marked Inactive
will not be ignored during the split operation.
Tolerance This value is used to determine how close a pipe must be

to a node in order for the pipe to be split by that junction.
Pipes will be split by every junction that falls within the specified tolerance. To prevent unwanted pipe splits, first use
the Network Navigators Network Review > Pipe Split Candidates query to verify that the tolerance you intend to use
for the Batch Split operation will not include nodes that you do not want involved in the pipe split operation.
To use the Network Navigator to assist in Batch Pipe Split operations
1. Open the Network Navigator.
2. Click the [>] button and select the Network Review...Pipe Split Candidates query.
185
Creating Models
3. In the Query Parameters dialog box, type the tolerance you will be using in the pipe split operation and click OK.
4. In the Network Navigator, highlight nodes in the list that you do not want to be included in the pipe split operation
and click the Remove button.
5. Open the Batch Pipe Split dialog.
6. Click the Selection button.
7. Type the tolerance you used in the Network Review query and click OK.
Batch Pipe Split Workflow

We recommend that you thoroughly review and clean up your model to ensure that the results of the batch pipe split
operation are as expected.
Note: Cleaning up your model is something that needs to be done with great care. It is best performed by
someone who has good familiarity with the model, and/or access to additional maps/personnel/information
that will allow you to make the model match the real world system as accurately as possible.
We provide a number of Network Navigator queries that will help you find "potential" problems (see Using the
Network Navigator (on page 200)).
1. Review and clean up your model as much as possible prior to running the "batch split" operation. Run the "duplicate
pipes" and "nodes in close proximity" queries first. (Click the View menu and select Queries. In the Queries dialog
expand the Queries-Predefined tree. The Duplicate Pipes and Nodes in Close Proximity queries are found under the
Network Review folder.)
2. Next, use the network navigator tool to review "pipe split candidates" prior to running batch split.
3. Using the network navigator tool, run the "pipe split candidates" query to get the list of potential batch split
candidate nodes. Take care to choose an appropriate tolerance (feel free to run the query multiple times to settle on a
tolerance that works best; jot down the tolerance that you settle on, you will want to use that same tolerance value
later when you perform the batch split operation).Manually navigate to and review each candidate node and use the
"network navigator" remove tool to remove any nodes that you do not want to process from the list.After reviewing
the entire list, use the network navigator "select in drawing" tool to select the elements you would like to process.
4. Run the batch split tool. Choose the "Selection" radio button to only process the nodes that are selected in the
drawing. Specify the desired tolerance, and press OK to proceed.
Batch Morph
This tool allows you to morph a selected node type into another type of node element as a batch operation.
186
Creating Models
First, select the nodes to be morphed from the following choices:

All: All nodes in the model will be morphed to the specified Target Element Type.
Selection: Only the nodes that are currently selected in the drawing pane will be morphed to the specified Target
Element Type.
Selection Set: Only those nodes that are contained within the selection set specified in the drop down list will be
morphed to the specified Target Element Type.
Check the Allow Morphing of Inactive Nodes? box to include nodes set as Inactive in the batch operation.
Finally, select the Target Element Type that the selected nodes will be morphed into.
Note: Users can morph junction elements into Isolation Valves using two steps: First, morph the desired
junctions into TCV's, GPV's, or PBV's. Then use the Skelebrator "Inline Isolation Valve Replacement" operation.
Merge Nodes in Close Proximity

This dialog allows you to merge together nodes that fall within a specified tolerance of one another.
187
Creating Models
To access the dialog, right-click one of the nodes to be merged and select the Merge nodes in close proximity
command.
Node to keep: Displays the node that will be retained after the merge operation.
Tolerance: Allows you to define the tolerance for the merge operation. Nodes that fall within this distance from the
"Node to keep" will be available in the "Nodes to merge" pane.
Refresh: Refreshes the nodes displayed in the "Nodes to merge" pane. Click this button after making a change to the
tolerance value to update the list of nodes available for the merge operation.
Select nodes to merge: Toggle this button on to select the nodes that are selected in the "Nodes to merge" pane in the
drawing pane.
Nodes to merge: This pane lists the nodes that fall within the specified tolerance of the "Node to keep". Nodes whose
associated boxes are checked will be merged with the Node to keep when the Merge operation is initiated.
Merge: Performs the merge operation using the nodes whose boxes are checked in the "Nodes to merge" list.
Close: Closes the dialog without performing the merge operation.
Select Adjacent Links

You edit element properties in the Property Editor, one of the dock-able managers in WaterGEMS V8i.
To edit element properties:
Double-click the element in the drawing pane. The Property Editor displays the attributes of the selected element.
or
Select the element whose properties you want to edit, then select View > Properties or click the Properties button on the
Analysis toolbar.
Editing Element Attributes
188
Creating Models
You edit element properties in the Property Editor, one of the dock-able managers in WaterGEMS V8i.
To edit element properties:
Double-click the element in the drawing pane. The Property Editor displays the attributes of the selected element.
or
Select the element whose properties you want to edit, then select View > Properties or click the Properties button on the
Analysis toolbar.
Property Editor
The Property Editor is a contextual dialog box that changes depending on the status of other dialog boxes. For example,
when a network element is highlighted in the drawing pane, the Property Editor displays the attributes and values
associated with that element. When one of the manager dialog boxes is active, the Property Editor displays the
properties pertaining to the currently highlighted manager element.
Attributes displayed in the Property Editor are grouped into categories by default. An expanded category can be
collapsed by clicking the plus (+) button next to the category heading. A collapsed category can be expanded by
clicking the minus (-) button next to the category heading.
Note: The available fields will also change depending on the currently active solver. The currently active solver is
determined by the Active Numerical Solver Calculation Option.
You can change the sorting to alphabetical by clicking the Search button and selecting Arrange Alphabetically.
For the most efficient data entry in Text Box style fields, instead of clicking on the Field, click on the label to the left of
the field you want to edit, and start typing. Press Enter to commit the value, then use the Up/Down keyboard arrows to
navigate to the next field you want to edit. You can then edit the field data without clicking the label first; when you are
finished editing the field data, press the Enter key, and proceed to the next field using the arrow keys, and so on.
Find Element
The top section of the Property Editor contains the Find Element tool. The Find Element tool lets you:
Quickly find a recently-created or added element in your model. The Element menu contains a list of the most
recently-created and added elements. Click an element in the Element menu to center the drawing pane around that
element and highlight it.
Find an element in your model by typing the element label or ID in the Element menu then clicking the Find button
or pressing Enter. The drawing pane centers around the highlighted element.
Find all elements of a certain type by using an asterisk (*) as a wild-card character. For example, if you want to find
all of the conduits in your model, you type co* (this is not case-sensitive) then click the Findbutton. The drawing
pane centers around and highlights the first instance of a conduit in your model, and lists all conduits in your model
in the Element menu. Once the Element menu is populated with a list of elements, you can use the Find Next and
Find Previous buttons to quickly navigate to the next or previous element in the list.
Note: See the Using the Like Operator (on page 226) topic for more information about wildcard symbols.
The following controls are included:
189
Creating Models
Element Type an element label or ID in this

field then click the Find button to
quickly locate it in your model. The
element selected in this menu will be
centered in the drawing pane when
the Zoom To command is initiated, at
the magnification level specified by
the Zoom Level menu. The drop-
down menu lists recently-created or
added elements, elements that are part
of a selection set, and that are part of
the results from a recent Find
operation.
Find Previous This button allows you to find the

previous element in the list of results
from a recent Find operation.
Find Zooms the drawing pane view to the

element typed or selected in the
Element menu at the magnification
level specified in the Zoom Level
menu.
Find Next This button allows you to find the

next element in the list of results from
a recent Find operation.
Help Displays online help for the Property

Editor.
Zoom Level Allows you to specify the

magnification level at which elements
are displayed in the drawing pane
when the Zoom To command is
initiated.
Alphabetic Displays the attribute fields in the

Property Editor in alphabetical order.
Categorized Displays the attribute fields in the

Property Editor in categories. This is
the default.
Related Topics
Editing Attributes in the Property Editor
Property Search
190
Creating Models
You can search for a specific attribute by typing the name of the attribute into the search box and clicking the Search
button
.
When you have entered one or more search terms, only those properties containing the search term will be displayed in
the property editor.
When the box contains search terms the Search button turns to a Clear button
. Click this button to clear the terms from the search box.
To match multiple items, enter the desired list of terms separated by semicolon without spaces in between.
A maximum of 12 search terms are stored in the search box. Click the down arrow to view the last 12 search terms that
were used; clicking an entry in this list will make that search term active.
Labeling Elements
When elements are placed, they are assigned a default label. You can define the default label using the Labeling tab of
the Tools > Options dialog.
You can also relabel elements that have already been placed using the Relabel command in the element FlexTables.
Relabeling Elements
You can relabel elements from within the Property Editor.
To relabel an element:
1. Select the element in the Drawing Pane then, if the Property Editor is not already displayed, select View >
Properties.
2. In the General section of the Property Editor, click in the Label field, then type a new label for the element.
Set Field Options Dialog Box

The Set Field Options dialog box is used to set the units for a specific attribute without affecting the units used by other
attributes or globally.
To use the Set Field Options dialog box, right-click any numerical field that has units, then select Units and Formatting.
Value Displays the value of the currently selected item.
Unit Displays the type of measurement. To change the unit,

select the unit you want to use from the drop-down list.
With this option you can use both U.S. customary and S.I.
units in the same worksheet.
191
Creating Models
Display Precision Sets the rounding of numbers and number of digits

displayed after the decimal point. Enter a number from 0
to 15 to indicate the number of digits after the decimal
point.
Format Selects the display format used by the current field.

Choices include: Scientific Converts the entered value
to a string of the form "-d.ddd...E+ddd" or "-d.ddd...e
+ddd", where each 'd' indicates a digit (0-9). The string
starts with a minus sign if the number is negative. Fixed
Point Abides by the display precision setting and
automatically enters zeros after the decimal place to do
so. With a display precision of 3, an entered value of 3.5
displays as 3.500. General Truncates any zeros after the
decimal point, regardless of the display precision value.
With a display precision of 3, the value that would appear
as 5.200 in Fixed Point format displays as 5.2 when using
General format. The number is also rounded. So, an
entered value of 5.35 displays as 5.4 regardless of the
display precision. Number Converts the entered value
to a string of the form "-d,ddd,ddd.ddd...", where each 'd'
indicates a digit (0-9). The string starts with a minus sign
if the number is negative. Thousand separators are
inserted between each group of three digits to the left of
the decimal point.
Date/Time Formats
You can pick from various predetermined date/time formats. The following is a list of supported formats, and a sample
of what the format will look like for 1 year, 1 month, 1 day, 1 hour, 1 minute, and one second into the simulation.
Elapsed Time Short: 9504.04 (hours)
Elapsed Time Long: 396:01:01:01
Short Time: 1:01 AM
Long Time: 1:01:01 AM
Short Date: 2/01/2009
Long Date: Monday, Feb 01, 2009
Short Date & Short Time: 2/01/2009 1:01 AM
Short Date & Long Time: 6/15/2009 1:01:01 AM
Long Date & Short Time: Monday, Feb 01, 2009 1:01 AM
Long Date & Long Time: Monday, Feb 01, 2009 1:01:01 AM
Sortable Date & Time: 2009-01-01T01:01:01
Universal Sortable Date & Time: 2009-01-01 01:01:01Z
Universal Full Date & Time: Monday, Feb 01, 2009 01:01:01 AM
Using Named Views
192
Creating Models
The Named View dialog box is where you can store the current views X and Y coordinates. When you set a view in the
drawing pane and add a named view, the current view is saved as the named view. You can then center the drawing
pane on the named view with the Go To View command.
Choose View > Named Views to open the Named View dialog box.
The toolbar contains the following controls:
Contains the following commands: Named View

Opens a Named View Properties box to create a new
New named view. Folder Opens a Named Views Folder
Properties box to enter a label for the new folder.
Deletes the named view or folder that is currently

Delete selected.
Rename the currently selected named view or folder.

Rename
Centers the drawing pane on the named view.

Go to View
Updates the currently highlighted view using the current

Update Named View view in the drawing pane.
Moves the selected named view or folder up or down.

Shift Up and Shift Down
Expands or collapses the named views and folders.

Expand All or Collapse All
193
Creating Models
Displays online help for Named Views.

Help
Using Selection Sets

Selection sets are user-defined groups of network elements. They allow you to predefine a group of network elements
that you want to manipulate together. You manage selection sets in the Selection Sets Manager (on page 195).
WaterGEMS V8i contains powerful features that let you view or analyze subsets of your entire model. You can find
these elements using the Network Navigator (see Using the Network Navigator (on page 200)). The Network
Navigator lets you choose a selection set, then view the list of elements in the selection set or find individual elements
from the selection set in the drawing.
In order to use the Network Navigator, you must first create a selection set. There are two ways to create a selection set:
From a selection of elements--You create a new selection set in the Selection Sets Manager, then use your mouse to
select the desired elements in the drawing pane.
From a query--Create a query in the Queries Manager, then use the named query to find elements in your model and
place them in the selection set.
The following illustration shows the overall process.
194
Creating Models
You can perform the following operations with selection sets:

Viewing Elements in a Selection Sets
Creating a Selection Set from a Selection (on page 198)
Creating a Selection Set from a Query
Adding Elements to a Selection Set (on page 199)
Removing Elements from a Selection Set (on page 199)
Selection Sets Manager

The Selection Sets Manager allows you to create, edit, and navigate to selection sets. The Selection Sets Manager
consists of a toolbar and a list pane, which displays all of the selection sets that are associated with the current project.
The toolbar contains the following buttons:
New Contains the following commands:

Create from Selection Creates a
new static selection set from elements
you select in your model. Create from
Query Creates a new dynamic
selection set from existing queries.
Delete Deletes the selection set that is

This command is also available from
the short-cut menu, which you can
access by right-clicking an item in the
list pane.
Edit When a selection-based selection set

is highlighted when you click this
button, opens the Selection Set
Element Removal dialog box, which
lets you edit the selection set. This
command is also available from the
short-cut menu, which you can access
by right-clicking an item in the list
pane. When a query-based selection
set is highlighted when you click this
button, opens the Selection By Query
dialog box, which lets you add or
remove queries from the selection set.
This command is also available from
the short-cut menu, which you can
access by right-clicking an item in the
list pane.
195
Creating Models
Rename Lets you rename the selection set that

is currently highlighted in the list
pane. This command is also available
from the short-cut menu, which you
can access by right-clicking an item
in the list pane.
Select In Drawing Lets you quickly select all the

elements in the drawing pane that are
part of the currently highlighted
selection set. Once you have selected
the elements in a selection set using
Select In Drawing, you can delete
them all at once or create a report on
them. This command is also available
from the short-cut menu, which you
can access by right-clicking an item
in the list pane.
Help Displays online help for the Selection

Sets Manager.
You can view the properties of a selection in the Property Editor by right-clicking the selection set in the list pane and
selecting Properties from the shortcut menu.
To view elements in a Selection Set
You use the Network Navigator to view the elements that make up a selection set.
1. Open the Network Navigator by selecting View > Network Navigator or clicking the Network Navigator button on
the View toolbar.
2. Select a selection set from the Selection Set drop-down list. The elements in the selection set appear in the Network
Navigator.
Note: You can double-click an element in the Network Navigator to select and center it in the Drawing Pane.
To Create a Selection Set from a Selection

You create a new selection set by selecting elements in your model.
1. Select all of the elements you want in the selection set by either drawing a selection box around them or by holding
down the Ctrl key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Create Selection Set.
3. Type the name of the selection set you want to create, then click OK to create the new selection set. Click Cancel to
close the dialog box without creating the selection set.
4. Alternatively, you can open the Selection Set manager and click the New button and select Create from Selection.
The software prompts you to select one or more elements.
Create Selection Set Dialog Box
This dialog box opens when you create a new selection set. It contains the following field:
New Selection Set Name: Type the name of the new selection set.
196
Creating Models
To create a Selection Set from a Query

You create a dynamic selection set by creating a query-based selection set. A query-based selection set can contain one
or more queries, which are valid SQL expressions.
1. In the Selection Sets Manager, click the New button and select Create from Query. The Selection by Query dialog
box opens.
2. Available queries appear in the list pane on the left; queries selected to be part of the selection set appear in the list
pane on the right. Use the arrow buttons in the middle of the dialog to add one or all queries from the Available
Queries list to the Selected Queries list, or to remove queries from the Selected list. You can also double-click
queries on either side of the dialog box to add them to or remove them from the selection set.
To add elements to a Selection Set
You can add a single or multiple elements to a static selection set.
1. Right-click the element to be added, then select Add to Selection Set from the shortcut menu.
2. In the Add to Selection Set dialog box, select the selection set to which you want to add the element.
3. Click OK to close the dialog box and add the element to the selected selection set. Click Cancel to close the dialog
box without creating the selection set.
To add a group of elements to a static selection set all at once
1. Select all of the elements to be added by either drawing a selection box around them, or by holding down the Ctrl
key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Add to Selection Set.
To Add To Selection Set Dialog Box
This dialog box opens when you select the Add to Selection Set command. It contains the following field:
Add To: Selects the selection set to which the currently highlighted element or elements will be added.
To remove elements from a Selection Set
You can easily remove elements from a static selection set in the Selection Set Element Removal dialog box.
1. Display the Selection Sets Manager by selecting View > Selection Sets or clicking the Selection Sets button on the
View toolbar.
2. In the Selection Sets Manager, select the desired selection set then click the Edit button.
3. In the Selection Set Element Removal dialog box, find the element you want to remove in the table. Select the
element label or the entire table row, then click the Delete button.
4. Click OK.
Selection Set Element Removal Dialog Box
This dialog opens when you click the edit button from the Selection Sets manager. It is used to remove elements from
the selection set that is highlighted in the Selection Sets Manager when the Edit button is clicked.
Selection By Query Dialog Box

The Selection by Query dialog box is used to create selection sets from available queries. The dialog box contains the
following controls:
197
Creating Models
Available Queries: Contains all the queries that are available for your selection set. The Available Columns list is
located on the left side of the dialog box.
Selected Queries: Contains queries that are part of the selection set. To add queries to the Selected Queries list, select
one or more queries in the Available Queries list, then click the Add button [>].
Query Manipulation Buttons: Select or clear queries to be used in the selection set:
[ > ] Adds the selected items from the Available Queries list to the Selected Queries list.
[ >> ] Adds all of the items in the Available Queries list to the Selected Queries list.
[ < ] Removes the selected items from the Selected Queries list.
[ << ] Removes all items from the Selected Queries list.
Note: You can select multiple queries in the Available Queries list by holding down the Shift key or the Control
key while clicking with the mouse. Holding down the Shift key provides group selection behavior. Holding down
the Control key provides single element selection behavior.
Group-Level Operations on Selection Sets

You can perform group-level deletions and reporting on elements in a selection set by using the Select In Drawing
button in the Selection Sets Manager.
Note: While it is not possible to directly edit groups of elements in a selection set, you can use the Next button in
the Network Navigator to quickly navigate through each element in the selection set and edit its properties in
the Property Editor.
To delete multiple elements from a selection set

1. Open the Selection Sets Manager by selecting View > Selection Sets or clicking the Selection Sets button on the
View toolbar.
2. In the Selection Sets Manager, highlight the selection set that contains elements you want to delete.
3. Click the Select In Drawing button in the Selection Sets Manager to highlight all of the selection set's elements in
the drawing pane. If there is only one selection set listed in the Selection Sets manager, you don't have to highlight it
before clicking the Select In Drawing button.
4. Shift-click (hold down the Shift key and click the left mouse button) any selected elements that you do not want to
delete.
5. Right-click and select Delete. The highlighted elements in the selection set are deleted from your model.
To create a report on a group of elements in a selection set
1. Open the Selection Sets Manager by selecting View > Selection Sets or clicking the Selection Sets button on the
View toolbar.
2. In the Selection Sets Manager, highlight the selection set that contains elements you want to report on.
3. Click the Select In Drawing button in the Selection Sets Manager to highlight all of the selection set's elements in
the drawing pane. If there is only one selection set listed in the Selection Sets manager, you don't have to highlight it
before clicking the Select In Drawing button.
4. Shift-click (hold down the Shift key and click the left mouse button) any selected elements that you do not want to
include in the report.
5. Right-click and select Report. A report window displays the report.
Creating a Selection Set from a Selection
198
Creating Models
You can create a new selection set by selecting elements in your model.
To create a new selection set from a selection:
1. Select all of the elements you want in the selection set by either drawing a selection box around them or by holding
down the Ctrl key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Create Selection Set.
3. Type the name of the selection set you want to create, then click OK to create the new selection set. Click Cancel to
close the dialog box without creating the selection set.
4. Alternatively, you can open the Selection Set Manager and click the New button and select Create from Selection.
WaterGEMS V8i prompts you to select one or more elements.
Create Selection Set Dialog Box
This dialog box appears when you create a new selection set. It contains the following field:
New Selection Set Name: Lets you type the name of the new selection set.
Adding Elements to a Selection Set

You can add a single or multiple elements to a static selection set.
To add an element to a static selection set:
1. Right-click the element to be added, then select Add to Selection Set from the shortcut menu.
To add a group of elements to a static selection set all at once:
1. Select all of the elements to be added by either drawing a selection box around them, or by holding down the Ctrl
key while clicking each one in turn.
2. When all of the desired elements are highlighted, right-click and select Add to Selection Set.
Add to Selection Set Dialog Box
This dialog box appears when you select the Add to Selection Set command. It contains the following field:
Add To: Drop-down menu that lets you select the selection set to which the currently highlighted element or elements
will be added.
Removing Elements from a Selection Set

You can easily remove elements from a static selection set in the Selection Set Element Removal dialog box.
To remove an element from a static selection set:
1. Display the Selection Sets Manager by selecting View > Selection Sets or clicking the Selection Sets button on the
View toolbar.
2. In the Selection Sets Manager, select the desired selection set then click the Edit button.
3. In the Selection Set Element Removal dialog box, find the element you want to remove in the table. Select the
element label or the entire table row, then click the Delete button.
199
Creating Models
4. Click OK.
Selection Set Element Removal Dialog Box
This dialog appears when you click the edit button from the Selection Set Manager. It allows you to remove elements
from the selection set that is highlighted in the Selection Sets Manager when the Edit button is clicked.
Using the Network Navigator
The Network Navigator consists of a toolbar and a table that lists the Label and ID of each of the elements contained
within the current selection. The selection can include elements highlighted manually in the drawing pane, elements
contained within a selection set, or elements returned by a query.
To open the Network Navigator, click the View menu and select the Network Navigator command, press <Ctrl+3>, or
click the Network Navigator button
on the View toolbar.
The following controls are included in Network Navigator:
200
Creating Models
Choose the element sets to use in the query. Once a query

is selected, it can be executed when you click the > icon.
If there is already a Query listed in the list box, it

can be run when the Execute icon is clicked.
Query Selection List
Click to run the selected query.

Execute
Zooms the drawing pane view to the selected element at

Previous the magnification level specified in the Zoom Level
menu.
Chooses the element below the currently selected one in

Zoom To the list.
Specifies the magnification level at which elements are

Next displayed in the drawing pane when the Zoom To
command is initiated.
Copies the elements to the Windows clipboard.

Copy
Removes the selected element from the list.

Remove
Selects the listed elements in the drawing pane and

performs a zoom extent based on the selection.
Select In Drawing
When this toggle button is on, elements returned by a

query will be highlighted in the drawing pane to increase
Highlight
their visibility.
Refreshes the current selection.

Refresh Drawing
Opens WaterGEMS V8i Help.

Help
Predefined Queries
The Network Navigator provides access to a number of predefined queries grouped categorically, accessed by clicking
the [>] button. Categories and the queries contained therein include:
Network
201
Creating Models
Network queries include All Elements queries for each element type, allowing you to display all elements of any type
in the Network Navigator.
Network Review
Network Review Queries include the following:
Nodes In Close Proximity - Identifies nodes within a specific tolerance.
Crossing Pipes - Identifies pipes that intersect one another with no junction at the intersection.
Orphaned Nodes - Identifies nodes that are not connected to a pipe in the model.
Orphaned Isolation Valves - Identifies isolation valves that are not connected to a pipe in the model.
Dead End Nodes - Identifies nodes that are only connected to one pipe.
Dead End Junctions - Identifies junctions that are only connected to one pipe.
Pipe Split Candidates- Identifies nodes near a pipe that may be intended to be nodes along the pipe. The tolerance
value can be set for the maximum distance from the pipe where the node should be considered as a pipe split
candidate.
Pipes Missing Nodes - Identifies which pipes are missing either one or both end nodes.
Duplicate Pipes - Identifies instances in the model where a pipe shares both end nodes with another pipe.
Network Trace
Network Trace Queries include the following:
Find Connected - Locates all the connected elements to the selected element in the network.
Find Adjacent Nodes - Locates all node elements connected upstream or downstream of the selected element or
elements.
Find Adjacent Links - Locates all link elements connected upstream or downstream of the selected element or
elements.
Find Disconnected - Locates all the disconnected elements in the network by reporting all the elements not
connected to the selected element.
Find Shortest Path - Select a Start Node and a Stop Node. The query reports the shortest path between the two nodes
based upon the shortest number of edges.
Trace Upstream - Locates all the elements connected upstream of the selected downstream element.
Trace Downstream - Locates all the elements connected downstream of the selected upstream element.
Isolate - Select an element that needs to be serviced. Run the query to locate the nearest isolation valves. In order to
service the element, this will identify where shut off points and isolation valves are located.
Find Initially Isolated Elements - Locates elements that are not connected or cannot be reached from any boundary
condition.
Input
Input Queries include a number of queries that allow you to find elements that satisfy various conditions based on input
data specified for them. Input queries include:
Duplicate Labels - Locates duplicate labels according to parameters set by the user. See Using the Duplicate Labels
Query for more information.
Elements With SCADA Data - Locates elements that are have SCADA data associated with them.
Inactive Elements - Locates elements that have been set to Inactive.
Pipes with Check Valves - Locates pipes that have the Has Check Valve? input attribute set to True.
Controlled Elements - Locates all elements that are referenced in a control Action.
Controlled Pumps - Locates all pumps that are referenced in a control Action.
Controlled Valves - Locates all valves that are referenced in a control Action.
Controlled Pipes - Locates all pipes that are referenced in a control Action.
202
Creating Models
Controlling Elements - Locates all elements that are referenced in a control Condition.
Initially Off Pumps - Locates all pumps whose Status (Initial) input attribute is set to Off.
Initially Closed Control Valves - Locates all control valves whose Status (Initial) input attribute is set to Closed.
Initially Inactive Control Valves - Locates all control valves whose Status (Initial) input attribute is set to Inactive.
Initially Closed Pipes - Locates all pipes whose Status (Initial) input attribute is set to Closed.
Fire Flow Nodes - Locates nodes included in the group of elements specified in the Fire Flow Alternative's Fire
Flow Nodes field.
Constituent Source Nodes - Locates all nodes whose Is Constituent Source? input attribute is set to True.
Nodes with Non-Zero Initial Constituent Concentration - Locates all nodes whose Concentration (Initial) input
attribute value is something other than zero.
Tanks with Local Bulk Reaction Rate Coefficient - Locates all tanks whose Specify Local Bulk Rate? input attribute
is set to True.
Pipes with Local Reaction Rate Coefficients - Locates all pipes whose Specify Local Bulk Reaction Rate? input
attribute is set to True.
Pipes with Hyperlinks - Locates all pipes that have one or more associated hyperlinks.
Nodes with Hyperlinks - Locates all nodes that have one or more associated hyperlinks.
Results
Results Queries include a number of queries that allow you to find elements that satisfy various conditions based on
output results calculated for them. Results queries include:
Negative Pressures - Locates all nodes that have negative calculated pressure results.
Pumps Operating Out of Range - Locates all pumps whose Pump Exceeds Operating Range? result attribute
displays True.
Pumps Cannot Deliver Flow or Head - Locates all pumps whose Cannot Deliver Flow or Head? result attribute
displays True.
Valves Cannot Deliver Flow or Head - Locates all valves whose Cannot Deliver Flow or Head? result attribute
displays True.
Empty Tanks - Locates all tanks whose Status (Calculated) result attribute displays Empty.
Full Tanks - Locates all tanks whose Status (Calculated) result attribute displays Full.
Off Pumps - Locates all pumps whose Status (Calculated) result attribute displays Off.
Closed Control Valves - Locates all control valves whose Status (Calculated) result attribute displays Closed.
Inactive Control Valves - Locates all control valves whose Status (Calculated) result attribute displays Inactive.
Closed Pipes - Locates all pipes whose Status (Calculated) result attribute displays Closed.
Failed Fire Flow Constraints - Locates all elements whose Satisfies Fire Flow Constraints? result attribute displays
False.
Self-Cleansing Pipes - Locates all pipes that satisfy the user-defined criteria for self-cleansing pipes (Shear Stress,
Velocity, or Shear Stress and Velocity).
Using the Duplicate Labels Query

WaterGEMS V8i internally keeps track of elements using a read-only ID property. In addition to this, users can and
should identify elements using labels. The labels are purely for display and not used for data base management or
hydraulic calculations. For the past several versions of the program, the models ran even if they contained duplicate or
blank labels. On some occasions, however, duplicate labels could cause confusion (e.g. picking the wrong instance of
an element in setting up a control). The Duplicate Labels query is a tool to find duplicate or blank labels.
The Duplicate Labels query is accessed through View > Network Navigator > Queries - Predefined > Input > Duplicate
Labels.
203
Creating Models
This opens a dialog where the user can control the behavior of the query.
The element type parameter enables the user to search for duplicate queries across all elements or within a specific type
of element.
Spot elevations are not included as a choice because duplicate spot elevations are not usually problematic.
The second choice in the dialog enables the user to control whether blank labels should be considered as duplicates.
The defaults for these parameters are to consider all elements and blank labels should be considered.
The query returns a list of elements with duplicate labels with their ID and Type. The user can highlight those elements
in the drawing, zoom to individual elements and modify them as desired.
Using the Pressure Zone Manager
The Pressure Zone Manager is a tool for identifying elements that are located in a pressure zone based on the
boundaries of the zone. It also provides the ability to conduct flow balance calculations for any pressure zone, color
code by pressure zone and export information on elements in a zone to the Zone Manager.
It is important to distinguish between the Pressure Zone Manager and the Zone Manager. The pressure zone manager
identifies which elements are included within a pressure zone. It is specific to the current scenario and is not a
permanent property of the elements. A Zone is a property that can be assigned to any element. It can be based on any
criteria you desire. Assignment of an element to a Zone based on what Pressure Zone it is in can be performed by
identifying a representative element within a pressure zone and assigning that zone to every node element in the
pressure zone. Zones are further described here: Zones (on page 214))
The Pressure Zone Manager identifies elements in a pressure zone, by starting at one element and tracing through the
network until it reaches a boundary element which can include closed pipes, closed isolation valves, pumps or any
control valve. You can determine which types of elements can serve as pressure zone boundaries. Once all elements
within a pressure zone have been identified, the pressure zone manager moves to an element outside of the pressure
zone and searches for elements within that pressure zone. This continues until all elements have been assigned to a zone
or are serving as zone boundaries.
You may find that the pressure zone manager has identified more pressure zones than are in the system. This is due to
the fact that the manager assigns all elements to a pressure zone so that there are pressure zones for example, between
the plant clearwell and the high service pumps or between the reservoir node representing the groundwater aquifer and
the well pump. These "pressure zones" only contain a small number of elements.
Starting pressure zone manager
Start the pressure zone manager by selecting Analysis > Pressure Zone or clicking the Pressure Zone Manager button.
When the pressure zone manager opens, you will see a left pane which lists the scenarios for which pressure zone
studies have been set up. The first time, it will be blank. In the right pane, You see the Summary tab which lists the
scenarios for which the pressure zone manager has been run and the number of pressure zones which were identified in
the run.
204
Creating Models
To begin a pressure zone study, select New from the top of the left pane, and then pick which scenario will be used for
the study. You can perform pressure zone studies for any scenario.
Specifying Boundary Elements
Once the scenario has been selected, you can define which elements are to be used as pressure zone boundary elements
using the Options tab in the right pane. The user choose from the following settings:
1. Always use
2. Use when closed
3. Do not use
4. (Pipes Only) Use when closed/Check valve
5. (Control Valves Only) Use When Active - When this is selected as the default status for a valve-type, elements of
that valve-type will only be included as boundary nodes in the Pressure Zone tracing if their Status (Initial) field is set
to "Active", and will be ignored otherwise.
6. (Control Valves Only) Use when Closed or Active - When this is selected as the default status for a valve-type,
elements of that valve-type will only be included as boundary nodes in the Pressure Zone tracing if their Status (Initial)
field is set to "Active" or "Closed", and will be ignored otherwise.
It is also possible to specify that an individual element behave differently from the default behaviors in the bottom right
pane by clicking the Select from Drawing button at the top of the table and picking the element from the drawing.
Zone Scope
205
Creating Models
Once the settings have been established, select the scenario to be run in the left pane. Click the Zone Scope tab in the
right pane.
The first choice in the Zone Scope tab is whether to identify pressure zones for the entire network of a subset of the
network. The default value is "Entire network".
If you want to run the pressure zone manager for a portion of the system, you should select Network Subset from the
drop down menu and then click on the box to the right of the drop down arrow. This opens the drawing where you can
make a selection using the standard selection tools as shown below. The fourth button enables you to select by drawing
a polygon around the elements while the fifth button enables you to choose a previously created selection set.
Remember to Right click "Done" when finished drawing the polygon.
Upon picking the green check mark, the Zone Scope dialog opens again, displaying the elements selected.
206
Creating Models
Associating Pressure Zones with the "Zone" property

You can now run the pressure zone identification part of the pressure zone manager. However, if you want to associate
pressure zones identified with Zones in the Zone Manager, the bottom of the right pane is the place to make that
association. Each Zone is associated with a Representative Element - that is, an element that you are certain will be in
the pressure zone associated with the Zone. For example, if Tank A is in the "Tank A Zone", then Tank A is a logical
choice for the representative element. If a zone is to be named after the PRV feeding the zone, it is best to relabel the
node on the downstream side of the PRV as something like "PRV Z Outlet" and choose that as the representative
element. You can access the Zone Manager by selecting the button at the top of the lower right pane. All of the Zones
in the Zone Manager are listed in the column labeled Zone but you do not need to identify a representative element in
each. It is best to set up Zones before starting the pressure zone manager. In that way, the drop down list under
Representative Element on the Zone Scope tab (see below) will be populated.
Running Pressure Zone Manager
207
Creating Models
To identify pressure zones, select the Compute button (4th button on top of the left pane). The pressure zone manager
runs and prepares statistics on each pressure zone as shown below.
Overall Results
For each pressure zone, the number of nodes, the number of boundary (isolation) elements, the number of pipes, the
length of pipe in the zone, the number of customer meters, the volume of water in the zone and the color associated
with the zone in the drawing are displayed in the top right pane.
The lower portion of the right pane provides information on the individual elements in each pressure zone indicating
the pipes, nodes, and customer meters in each zone and the pipes and nodes that serve as boundaries each in their own
tab. You can also create selection sets corresponding to elements in each pressure zone by picking a pressure zone in
the center pane (called Label), and then clicking the Create a Selection Set button on top of the lower right pane.
Exporting Pressure Zones to Zones
At this point, the pressure zones are labeled Pressure Zone - x, where x is a number indicating the order in which the
pressure zone was identified. These pressure zones can be associated with the Zones using the fifth button, Export
Pressure Zone. This opens up the Export dialog which lists the Zones that will be associated with the pressure zones
based on representative elements.
208
Creating Models
The options at the bottom of the dialog control whether the Zone assignments that will be made will overwrite existing
Zone assignments.
After selecting OK, each element in a pressure zone that has a representative element is assigned the Zone name
associated with that representative element.
For more information, see Pressure Zone Export Dialog Box

Pressure Zone Flow Balance
The fourth button performs a flow balance on each pressure zone. For each Pressure Zone, it displays the Zone (if one
is associated with the pressure zone), net inflow (flow across the boundaries but not including flow originating from
209
Creating Models
tanks and reservoirs in the pressure zone), the demand in that zone, the minimum and maximum elevations in the
pressure zone, the minimum and maximum hydraulic grade lines in the pressure zone, and the minimum and maximum
pressure in the pressure zone. If the scenario is not steady state, then the results correspond to the current time step. The
lower pane displays the flow through each boundary element. If the hydraulics have not been calculated for this system,
a message is given that the model needs to be calculated.
For more information, see Pressure Zone Flow Balance Tool Dialog Box (on page 212).
Color Coding by Pressure Zone
The sixth button color codes the drawing by pressure zone. Each zone is colored according to the color displayed in the
rightmost column of the table. In the image below, the main zone is blue, the red zone is boosted through a pump, the
magenta zone is a reduced zone fed through a PRV and the green zone is a well.
210
Creating Models
Other Pressure Zone Results

Other buttons such as Report, Refresh, Export to Selection Set, Zoom to and Copy behave as they do for other
WaterGEMS V8i features.
The results of a pressure zone analysis as stored in a .pzs file.
Pressure Zone Export Dialog Box

This dialog allows you to associate pressure zones with zones using representative elements.
211
Creating Models
The table of export data contains a row for each pressure zone, as well as a row for the boundary elements. The first
column specifies the pressure zone. The second column specifies the zone, specified by you, to assign the elements of
the pressure zone to. This comun consists of pull-down menus containing all of the model's zones. Additionally, there is
an ellipsis (...) button that will bring up the Zone Manager if you need to add/remove/modify the model's zones (see
Zones (on page 214) for more information). The third column is informational. It lists the representative element for
the selected zone, which is specified in the Pressure Zone Manager (see Using the Pressure Zone Manager (on page
204)).
The special <Boundary Elements> pressure zone contains all of the boundary elements for every pressure zone. The
other pressure zones each contain all of the elements in that pressure zone, excluding the boundary elements that seal
off that pressure zone.
If you do not assign a zone to each pressure zone in the table before clicking the OK button, a warning will appear
prompting you to do so.
The two Options radio buttons are mutually exclusive. "Overwrite Existing Zones" specifies that all elements in the
pressure zones will be assigned to the corresponding zone chosen in the table. "Only Update Unassigned Zones"
specifies that only those elements in the pressure zone that are not currently assigned to any zone will be assigned to the
corresponding zone in the table. The exception is the <Boundary Elements> pressure zone, which will always be
exported as if the "Overwrite Existing Zones" option is selected.
The "Highlight Pressure Zone In Drawing" toolbar button causes the elements of the pressure zone in the current row of
the table to be highlighted in the drawing. This option gives allows you to see what elements are going to be affected by
the export operation.
Pressure Zone Flow Balance Tool Dialog Box

The Flow Balance Tool dialog box allows you to perform a flow balance and/or a volume balance on each pressure
zone.
212
Creating Models
For each Pressure Zone, it displays the Zone (if one is associated with the pressure zone), net inflow (flow across the
boundaries but not including flow originating from tanks and reservoirs in the pressure zone) or net volume, the
demand in that zone, the minimum and maximum elevations in the pressure zone, the minimum and maximum
hydraulic grade lines in the pressure zone, and the minimum and maximum pressure in the pressure zone.
The Report button allows you to generate a preformatted report containing all of the data displayed in the tables.
The Copy buttons (above the Pressure Zones and Boundary Elements tables) will copy the contents of the table to the
clipboard in a format that is compatible with spreadsheet programs like Excel.
The Highlight Pressure Zone In Drawing button will toggle on/off highlighting of the the pressure zone for the
currently active row in the Pressure Zone table.
For Volume balance, the sum of the flows over the run is found using the following formula:
Where:
N = number of time steps
Qi = flow in i-th time step (cfs)
ti= time step duration for i-th time step

The value of Qi is the net flow into the pressure zone at the start of the i-th time step.
ti is the difference in time between the start and end of that time step (because of pump cycling, the time step size
changes).
Using Prototypes
Prototypes allow you to enter default values for elements in your network. These values are used while laying out the
network. Prototypes can reduce data entry requirements dramatically if a group of network elements share common
data.
For example, if a section of the network contains all three foot-diameter manholes , use the manhole prototype to set the
Diameter field to 3.00 ft. When you create a new manhole in your model, its diameter attribute will default to 3.00 ft.
Note: Changes to the prototypes are not retroactive and will not affect any elements created prior to the change.
If a section of your system has distinctly different characteristics than the rest of the system, adjust your prototypes
before laying out that section. This will save time when you edit the properties later.
For instructions on how to create prototypes, see Creating Prototypes .
213
Creating Models
Zones
The Zones manager allows you to manipulate zones quickly and easily. Zones listed in the Zones manager can be
associated with each nodal element using the Element Editors, Prototypes, or FlexTables. This manager includes a list
of all of the available zones and a toolbar.
To open the Zones manager
Choose Components > Zones
or
Click the Zones icon
from the Components toolbar.

The Zones manager opens.
The toolbar contains the following icons:

NewAdds a new zone to the zone list.
DuplicateCreates a copy of an existing zone.
DeleteDeletes an existing zone. You can hold down the Ctrl key while clicking on items in the list to select multiple
entries at once.
Rename - Renames the selected zone.
Notes - Enter information about the zone.
214
Creating Models
Engineering Libraries
Engineering Libraries are powerful and flexible tools that you use to manage specifications of common materials,
objects, or components that are shared across projects. Some examples of objects that are specified through engineering
libraries include pipe materials, Storm Data, and unit sanitary loads. You can modify engineering libraries and the items
they contain by using the Engineering Libraries command in the Components menu, or by clicking the ellipsis (...)
buttons available next to the fields in dialog boxes that make use of engineering libraries.
Note: The data for each engineering library is stored in an XML file in your WaterGEMS V8i program directory.
We strongly recommend that you edit these files only using the built-in tools available by selecting Components
> Engineering Libraries.
You work with engineering libraries and the items they contain in the Engineering Libraries dialog box, which contains
all of the projects engineering libraries. Individual libraries are compilations of library entries, along with their
attributes. For more information about working with engineering libraries, see Working with Engineering Libraries (on
page 215).
By default, each project you create in WaterGEMS V8i uses the items in the default libraries. In special circumstances,
you may wish to create custom libraries to use with one or more projects. You can do this by copying a standard library
or creating a new library.
When you change the properties for an item in an engineering library, those changes affect all projects that use that
library item. At the time a project is loaded, all of its engineering library items are synchronized to the current library.
Items are synchronized based on their label. If the label is the same, then the items values will be made the same.
The default libraries that are installed with WaterGEMS V8i are editable. In addition, you can create a new library of
any type, and can then create new entries of your own definition.
Library types are displayed in the Engineering Library manager in an expanding/collapsing tree view.
Library types can contain categories and subcategories, represented as folders in the tree view.
Individual library entries are contained within the categories, subcategories, and folders in the tree view.
Libraries, categories, folders, and library entries are displayed in the tree view with their own unique icons. You can
right-click these icons to display submenus with different commands.
Working with Engineering Libraries

When you select a library entry in the tree view, the attributes and attribute values associated with the entry are
displayed in the editor pane on the right side of the dialog box.
Working with Libraries
Right-clicking a Library icon in the tree view opens a shortcut menu containing the following commands:
Create Library Creates a new engineering library of the currently

highlighted type.
Add Existing Library Lets you add an existing engineering library that has been
stored on your hard drive as an .xml file to the current
project.
Working with Categories
215
Creating Models
Right-clicking a Category icon in the tree view opens a shortcut menu containing the following commands:
Add Item Creates a new entry within the current library.
Add Folder Creates a new folder under the currently highlighted

library.
Save As Lets you save the currently highlighted category as

an .xml file that can then be used in future projects.
Remove Deletes the currently highlighted category from the

library.
Working with Folders

Right-clicking a Folder icon in the tree view opens a shortcut menu containing the following commands:
Add Item Creates a new entry within the current folder.
Add Folder Creates a new folder under the currently highlighted

folder.
Rename Lets you rename the currently highlighted folder.
Delete Deletes the currently highlighted folder and its contents.
Working with Library Entries

Right-clicking a Library Entry icon in the tree view opens a shortcut menu containing the following commands:
Rename Lets you rename the currently highlighted entry.
Delete Deletes the currently highlighted entry from the library.
Engineering Libraries Dialog Box

The Engineering Libraries dialog box contains an explorer tree-view pane on the left, a library entry editor pane on the
right, and the following buttons above the explorer tree view pane:
New Opens a submenu containing the

following commands: Create Library
Creates a new engineering library.
Add Existing Library Lets you add
an existing engineering library that
has been stored on your hard drive as
an .xml file to the current project.
216
Creating Models
Save Opens a submenu containing the

following commands: Save As Lets
you save the current engineering
library under a new name and/or to a
new location. ProjectWise Check Out
Lets you check out an existing
engineering library that has been
stored in ProjectWise.
Remove Removes the currently highlighted

engineering library from the current
project.
Rename Lets you rename the currently

highlighted engineering library.
Transient Valve Curve Editor

The following buttons are located above the curve points table on the left.
Time from Start: Lets you specify the amount of time from the Start Time of the pattern to the time step point being
defined.
Relative Closure: The percentage closed the valve is at the associated time.
Transient Pump Curve

defined.
Multiplier: Lets you specify the multiplier value associated with the time step point
Transient Turbine Curve

217
Creating Models
defined.
Relative Gate Opening: The percentage compared to fully open for the turbine gate opening at the associated time
step point.
Valve Relative Closure Curve Editor

defined.
Relative Closure: The percentage closed the valve is at the associated time.
Hyperlinks
The Hyperlinks feature is used to associate external files, such as pictures or movie files, with elements. You can Add,
Edit, Delete, and Launch hyperlinks from the Hyperlinks manager.
To use hyperlinks, click Tools > Hyperlinks. The Hyperlinks dialog box opens. The dialog box contains a toolbar and a
tabular view of all your hyperlinks.
New: Creates a new hyperlink. Opens the Add Hyperlink dialog box.
Delete: Deletes the currently selected hyperlink.
Edit: Edits the currently selected hyperlink. Opens the Edit Hyperlink dialog box.
Launch: Launches the external file associated with the currently selected hyperlink.
The table contains the following columns:
Element Type: Displays the element type of the element associated with the hyperlink.
Element: Displays the label of the element associated with the hyperlink.
Link: Displays the complete path of the hyperlink.
Description: Displays a description of the hyperlink, which you can optionally enter when you create or edit the
hyperlink.
Once you have created Hyperlinks, you can open the Hyperlinks dialog box from within a Property dialog box
associated with that Hyperlink.
Click the ellipsis (...) in the Hyperlinks field and the Hyperlinks dialog box opens.
218
Creating Models
To Add a Hyperlink
1. Click Tools > Hyperlink. The Hyperlinks dialog box opens.
2. Click New to add a hyperlink. The Add Hyperlink dialog box opens.
3. Select the element type to associate an external file.
4. Click the ellipsis (...) to select the element in the drawing to associate with the hyperlink.
5. Click the ellipsis (...) to browse to the external file you want to use, select it and then click Open. This will add it to
the Link field.
6. Add a description of your Hyperlink.
7. Click OK.
You can add more than one associated file to an element using the hyperlink feature, but you must add the associations
one at a time.
To Edit a Hyperlink
1. Click Tools > Hyperlinks. The Hyperlinks dialog box opens.
2. Select the element to edit and click Edit. The Edit Hyperlink dialog box opens.
3. Click the ellipsis (...) to browse to a new file to associate with the hyperlink.
4. Add a description.
5. Click OK.
To Delete a Hyperlink
1. Choose Tools > Hyperlinks. The Hyperlinks dialog box opens.
2. Select the element you want to delete.
3. Click Delete.
To Launch a Hyperlink
Hyperlinks can be launched from the Hyperlinks dialog box, the Add Hyperlink dialog box, and from the Edit
Hyperlink dialog box. Launch in order to view the image or file associated with the element, or to run the program
associated with the element.
1. Choose Tools > Hyperlinks. The Hyperlinks dialog box opens.
2. Select the element and click on the Hyperlinks icon. The hyperlink will launch.
Note: Click to open the Add or Edit dialog boxes and click Launch to open from there.
Add Hyperlink
New hyperlinks are created in this dialog box. The dialog contains the following controls:
Element Type: Select an element type from the drop-down list.
Element: Select an element from the drop-down list of specific elements from the model. Or click the ellipsis to
select an element from the drawing.
Link: Click the ellipsis (...) to browse your computer and locate the file to be associated with the hyperlink. You can
also enter the path of the external file by typing it in the Link field.
Description: Create a description of the hyperlink.
Edit Hyperlink
219
Creating Models
You edit existing hyperlinks in the Edit Hyperlink dialog box. The Edit Hyperlinks dialog box contains the following
controls:
Link: Defines the complete path of the external file associated with the selected hyperlink. You can type the path
yourself or click the ellipsis (...) to search your computer for the file. Once you have selected the file, you can test
the hyperlink by clicking Launch.
Description: Accesses an existing description of the hyperlink or type a new description.
Using Queries
A query in WaterGEMS V8i is a user-defined SQL expression that applies to a single element type. You use the Query
Manager to create and store queries; you use the Query Builder dialog box to construct the actual SQL expression.
Queries can be one of the following three types:
Project queriesQueries you define that are available only in the WaterGEMS V8i project in which you define
them.
Shared queriesQueries you define that are available in all WaterGEMS V8i projects you create. You can edit
shared queries.
Predefined queriesFactory-defined queries included with WaterGEMS V8i that are available in all projects you
create. You cannot edit predefined queries.
You can also use queries in the following ways:
Create dynamic selection sets based on one or more queries.
Filter the data in a FlexTable using a query. For more information, see Sorting and Filtering FlexTable Data (on
page 728).
You can use predefined queries in the Network Navigator. See Using the Network Navigator (on page 200) for
more details.
Queries Manager
The Queries manager is a docking manager that displays all queries in the current project, including predefined, shared,
and project queries. You can create, edit, or delete shared and project queries from within the Queries Manager, as well
as use it to select all elements in your model that are part of the selected query.
To open the Queries manager, click the View menu and select the Queries command, press <Ctrl+5>, or click the
Queries button
on the View toolbar.
220
Creating Models
The Queries manager consists of a toolbar and a tree view, which displays all of the queries that are associated with the
current project.
The toolbar contains the following icons:
Contains the following commands: Query Creates a

new SQL expression as either a project or shared query,
New depending on which item is highlighted in the tree view.
Folder Creates a folder in the tree view, allowing you
to group queries. You can right-click a folder and create
queries or folders in that folder.
Deletes the currently-highlighted query or folder from the

tree view. When you delete a folder, you also delete all of
Delete the queries it contains.
Renames the query or folder that is currently highlighted

in the tree view.
Rename
Opens the Query Builder dialog box, allowing you to edit

the SQL expression that makes up the currently-
Edit highlighted query.
Opens all the Queries within all of the folders.
Expand All
221
Creating Models
Closes all the Query folders.
Collapse All
Opens a submenu containing the following options: Select

in Drawing Selects the element or elements that satisfy
Select in Drawing the currently highlighted query. Add to Current Selection
Adds the element or elements that satisfy the currently
highlighted query to the group of elements that are
currently selected in the Drawing Pane. Remove from
Current Selection Removes the element or elements
that satisfy the currently highlighted query from the group
of elements that are currently selected in the Drawing
Pane. Select Within Current Selection Selects the
element or elements that both satisfy the current query
and are already selected in the Drawing Pane.
Displays online help for the Query Manager.
Help
Query Parameters Dialog Box

Some predefined queries require that a parameter be defined. When one of these queries is selected, the Query
Parameters dialog box will open, allowing you to type the parameter value that will be used in the query. For example,
when the Pipe Split Candidates query is used the Query Parameters dialog will open, allowing the Tolerance parameter
to be defined.
Creating Queries
A query is a valid SQL expression that you construct in the Query Builder dialog box. You create and manage queries
in the Queries Manager. You also use queries to filter FlexTables and as the basis for a selection set.
To create a query from the Queries Manager:
1. Open the Queries Manager by selecting View > Queries, clicking the Queries button on the View toolbar, or by
pressing CTRL+5.
2. Perform one of the following steps:
3. To create a new project query, highlight Queries - Project in the list pane, then click the New button and select
Query.
4. To create a new shared query, highlight Queries - Shared in the list pane, then click the New button and select
Query. You can also right-click an existing item or folder in the list pane and select New > Query from the shortcut
menu.
5. In the Select Element Type dialog box, select the desired element type from the drop-down menu. The Query
Builder dialog box appears.
6. 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:
7. Double-click the field you wish to include in your query. The database column name of the selected field appears in
the preview pane.
222
Creating Models
8. Click the desired operator or keyword button. The SQL operator or keyword is added to the SQL expression in the
preview pane.
9. Click the Refresh button above the Unique Values list pane to see a list of unique values available for the selected
field. Note that the Refresh button is disabled after you use it for a particular field (because the unique values do not
change in a single query-building session).
10. Double-click the unique value you want to add to the query. The value is added to the SQL expression in the
preview pane. You can also manually edit the expression in the preview pane.
11. Check the Validate box above the preview pane to validate your SQL expression when the query is applied.
12. Click the Apply button above the preview pane to execute the query. If the expression is valid, the word
VALIDATED is displayed in the lower right corner of the dialog box.
13. Click OK.
223
Creating Models
1. Perform these optional steps in the Queries Manager:
224
Creating Models
2. To create a new folder in the tree view, highlight the existing item or folder in which to place the new folder, then
click the New button and select Folder. You can create queries and folders within folders.
3. To delete an existing query or folder, click the Delete button. When you delete a folder, you also delete all of its
contents (the queries it contains).
4. To rename an existing query or folder, click the Rename button, then type a new name.
5. To edit the SQL expression in a query, select the query in the list pane, then click the Edit button. The Query
Builder dialog box appears.
6. To quickly select all the elements in the drawing pane that are part of the currently highlighted query, click the
Select in Drawing button.
Query Builder Dialog Box
You construct the SQL expression that makes up your query in the Query Builder dialog box. The Query Builder dialog
box is accessible from the Queries Manager and from within a FlexTable.
The top part of the dialog box contains all the controls you need to construct your query: a list pane displaying all
available attributes for the selected element type, a SQL control panel containing available SQL keywords and
operators, and list view that displays all the available values for the selected attribute. The bottom part of the dialog box
contains a preview pane that displays your SQL expression as you construct it.
All the dialog box controls are described in the following table.
Fields Lists all input and results fields

applicable to the selected element
type. This list displays the labels of
the fields, while the underlying
database column names of the fields
become visible in the preview pane
when you add them to the expression.
Double-click a field to add it to your
SQL expression.
SQL Controls These buttons represent all the SQL

operators and controls that you can
use in your query. They include = , > ,
< , _ , ? , * , <> , >= , <= , [ ] , Like ,
And , and Or . Click the appropriate
button to add the operator or keyword
to the end of your SQL expression,
which is displayed in the preview
pane.
225
Creating Models
Unique Values When you click the Refresh button,

this list displays all the available
unique values selected field. Double-
click a value in the list to add it to the
end of your SQL expression, which is
displayed in the preview pane. If you
select a different field, you must click
the Refresh button again to update the
list of unique values for the selected
field. When you first open the Query
Builder dialog box, this list is empty.
Refresh Updates the list of unique values for

the selected field. This button is
disabled after you use it for a
particular field.
Copy Copies the entire SQL expression

displayed in the preview pane to the
Windows clipboard.
Paste Pastes the contents of the Windows

clipboard into the preview pane at the
location of the text cursor. For
example, if your cursor is at the end
of the SQL expression in the preview
pane and you click the Paste button,
the contents of your clipboard will be
added to the end of the expression.
Validate Validates the SQL expression in the

preview pane. If the expression is not
valid, a message appears. When you
click this button and your SQL
expression passes validation, the word
VALIDATED appears in the lower
right corner of the dialog box.
Apply Executes the query. The results of the

query are displayed at bottom of the
Query Builder dialog box in the form
x of x elements returned.
Preview Pane Displays the SQL expression as you

add fields, operators and/keywords,
and values to it.
Using the Like Operator

The Like operator compares a string expression to a pattern in an SQL expression.
226
Creating Models
Syntax
expression Like pattern
The Like operator syntax has these parts:
Part Description
expression SQL expression used in a WHERE clause .
pattern String or character string literal against which expression

is compared.
You can use the Like operator to find values in a field that match the pattern you specify. For pattern, you can specify
the complete value (for example, Like Smith), or you can use wildcard characters to find a range of values (for
example, Like Sm*).
In an expression, you can use the Like operator to compare a field value to a string expression. For example, if you
enter Like C* in an SQL query, the query returns all field values beginning with the letter C. In a parameter query ,
you can prompt the user for a pattern to search for.
The following example returns data that begins with the letter P followed by any letter between A and F and three
digits:
Like P[A-F]###
To search for a string that contains a symbol that is normally a wildcard (*or #) enclose it in brackets like this: [#].
To search using a user defined date field, enclose the date in # symbols like this:
Conduit_Field_1 > #1/1/2009#
The following table shows how you can use Like to test expressions for different patterns.
Kind of match Pattern Match(returns True) No match(returns False)
Multiple characters a*a aa, aBa, aBBBa aBC
*ab* abc, AABB, Xab aZb, bac
Special character a[*]a a*a aaa
Multiple characters ab* abcdefg, abc cab, aab
Single character a?a aaa, a3a, aBa aBBBa
Single digit a#a a0a, a1a, a2a aaa, a10a
Range of characters [a-z] f, p, j 2, &
Outside a range [!a-z] 9, &, % b, a
Not a digit [!0-9] A, a, &, ~ 0, 1, 9
Combined a[!b-m]# An9, az0, a99 abc, aj0
227
Creating Models
User Data Extensions

User data extensions are a set of one or more attribute fields that you can define to hold data to be stored in the model.
User data extensions allow you to add your own data fields to your project. For example, you can add a field for
keeping track of the date of installation for an element, or the type of area serviced by a particular element.
Note: The user data does not affect the hydraulic model calculations. However, their behavior concerning
capabilities like editing, annotating, sorting and database connections is identical to any of the standard pre-
defined attributes.
User data extensions exhibit the same characteristics as the predefined data used in and produced by the model
calculations. This means that user data extensions can be imported or exported through database and shapefile
connections, viewed and edited in the Property Editor or in FlexTables, included in tabular reports or element detailed
reports, annotated in the drawing, color coded, and reported in the detailed element reports.
Note: The terms user data extension and field are used interchangeably here. In the context of the User Data
Extension feature, these terms mean the same thing.
You define user data extensions in the User Data Extensions dialog box.
To define a user data extension:
1. Select Tools > User Data Extensions.
2. In the list pane on the left, select the element type for which you want to define a new attribute field.
3. Click the New button to create a new user data extension. A user data extension with a default name appears under
the element type. You can rename the new field if you wish.
4. In the Property Editor for the new field, enter the following:
5. Type the name of the new field. This is the unique identifier for the field. The name field in the Property Editor is
the name of the column in the data source.
6. Type the label for the new field. This is the label that will appear next to the field for the user data extension in the
Property Editor for the selected element type. This is also the column heading if the data extension is selected to
appear in a FlexTable.
7. Click the Ellipses (...) button in the Category field, then use the drop-down menu in the Select Category dialog box
to select an existing category in which the new field will appear in the Property Editor. To create a new category,
simply type the category name in the field.
8. Type a number in the Field Order Index field. This is the display order of fields within a particular category in the
Property Editor. This order also controls the order of columns in Alternative tables. An entry of 0 means the new
field will be displayed first within the specified category.
9. Type a description for the field. This description will appear at the bottom of the Property Editor when the field is
selected for an element in your model. You can use this field as a reminder about the purpose of the field.
10. Select an alternative from the drop-down menu in the Alternative field. This is the alternative that you want to
extend with the new field.
11. Select a data type from the drop-down menu in the Data Type field.
12. If you select Enumerated, an Ellipses (...) button appears in the Default Value field. Enumerated user data
extensions are fields that present multiple choices.
13. Enter the default value for the new field. If the data type is Enumerated, click the Ellipses (...) button to display the
Enumeration Editor dialog box, where you define enumerated members.
228
Creating Models
15. To import an existing User Data Extension XML File, click the Import button, then select the file you want to
import. User Data Extension XML Files contain the file name extension .xml or .udx.xml.
16. To export existing user data extensions, click the Export to XML button, then type the name of the udx.xml file. All
user data extensions for all element types defined in the current project are exported.
17. To share the new field among two or more element types, select the user data extension in the list pane, then click
the Sharing button or right-click and select Sharing. In the Shared Field Specification dialog box, select the check
box next to the element or elements that will share the user data extension. The icon next to the user data extension
changes to indicate that it is a shared field.
18. To delete an existing user data extension, select the user data extension you want to delete in the list pane, then click
the Delete button, or right-click and select Delete.
19. To rename a the display label of an existing user data extension, select the user data extension in the list pane, click
the Rename button or right-click and select Rename, then type the new display label.
20. To expand the list of elements and view all user data extensions, click the Expand All button.
21. To collapse the list of elements so that no user data extensions are displayed, click the Collapse All button.
22. Click OK to close the dialog box and save your user data extensions. The new field(s) you created will appear in the
Property Editor for every instance of the specified element type in your model.
User Data Extensions Dialog Box

The User Data Extensions dialog box displays a summary of the user data extensions associated with the current
project. The dialog box contains a toolbar, a list pane displaying all available WaterGEMS V8i element types, and a
property editor.
The toolbar contains the following controls:
229
Creating Models
Import Merges the user data extensions in a

saved User Data Extension XML file
(.udx.xml or .xml) into the current
project. Importing a User Data
Extension XML file will not remove
any of the other data extensions
defined in your project. User data
extensions that have the same name
as those already defined in your
project will not be imported.
Export to XML Saves existing user data extensions

for all element types in your model to
a User Data Extension XML file
(.udx.xml) for use in a different
project.
Add Field Creates a new user data extension for

the currently highlighted element
type.
Share Shares the current user data extension

with another element type. When you
click this button, the Shared Field
Specification dialog box opens. For
more information, see Sharing User
Data Extensions Among Element
Types (on page 232).
Delete Field Deletes the currently highlighted user

data extension
Rename Field Renames the display label of the

currently highlighted user data
extension.
Expand All Expands all of the branches in the

hierarchy displayed in the list pane.
Collapse All Collapses all of the branches in the

hierarchy displayed in the list pane.
The property editor section of the dialog contains following fields, which define your new user data extension:
Attribute Description
General
230
Creating Models
Name The unique identifier for the field. The name field in the
Property Editor is the name of the column in the data
source.
Label The label that will appear next to the field for the user
data extension in the Property Editor for the selected
element type. This is also the column heading if the data
extension is selected to appear in a FlexTable.
Category The section in the Property Editor for the selected element
type in which the new field will appear. You can create a
new category or use an existing category. For example,
you can create a new field for junctions and display it in
the Physical section of that elements Property Editor.
Field Order Index The display order of fields within a particular category in
the Property Editor. This order also controls the order of
columns in Alternative tables. An entry of 0 means the
new field will be displayed first within the specified
category.
Field Description The description of the field. This description will appear
at the bottom of the Property Editor when the field is
selected for an element in your model. You can use this
field as a reminder about the purpose of the field.
Alternative Selects an existing alternative to extend with the new

field.
Referenced By Displays all the element types that are using the field. For
example, if you create a field called "Installation Date"
and you set it up to be shared, this field will show the
element types that share this field. So for example, if you
set up a field to be shared by junctions and catch basins,
the Referenced By field would show "Manhole, Catch
Basin".
Units
231
Creating Models
Data Type Specifies the data type for the user data extension. Click
the down arrow in the field then select one of the
following data types from the drop-down menu: Integer
Any positive or negative whole number. Real Any
fractional decimal number (for example, 3.14). It can also
be unitized with the provided options. Text Any string
(text) value up to 255 characters long. Long Text Any
string (text) up to 65,526 characters long. Date/Time
The current date. The current date appears by default in
the format month/day/year. Click the down arrow to
change the default date. Boolean True or False.
Enumerated When you select this data type, an Ellipses
button appears in the Default Value field. Click the
Ellipses (...) button to display the Enumeration Editor
dialog box, where you can add enumerated members and
their associated values. For more information, see
Enumeration Editor Dialog Box (on page 234).
Default Value The default value for the user data extension. The default
value must be consistent with the selected data type. If
you chose Enumerated as the data type, click the Ellipses
(...) button to display the Enumeration Editor.
Dimension Specifies the unit type. Click the drop-down arrow in the
field to see a list of all available dimensions. This field is
available only when you select Real as the Data Type.
Storage Unit Specifies the storage units for the field. Click the drop-
down arrow in the field to see a list of all available units;
the units listed change depending on the Dimension you
select. This field is available only when you select Real as
the Data Type.
Numeric Formatter Selects a number format for the field. Click the drop-
down arrow in the field to see a list of all available
number formats; the number formats listed change
depending on the Dimension you select. For example, if
you select Flow as the Dimension, you can select Flow,
Flow - Pressurized Condition, Flow Tolerance, or Unit
Load as the Numeric Formatter. This field is available
only when you select Real as the Data Type.
Sharing User Data Extensions Among Element Types

You can share user data extensions across multiple element types in WaterGEMS . Shared user data extensions are
displayed in the Property Editor for all elements types that share that field.
The icons displayed next to the user data extensions in the User Data Extensions dialog box change depending on the
status of the field:

232
Creating Models
Indicates a new unsaved user data extension.

Indicates a user data extension that has been saved to the data source.

Indicates a user data extension that is shared among multiple element types but has not been applied to the data
source.

Indicates a user data extension that is shared among multiple element types and that has been applied to the data
source. Fields with this icon appear in the Property Editor for any elements of the associated element types that
appear in your model.
Observe the following rules when sharing user data extensions:
You can select any number of element types with which to share the field. The list is limited to element types that
support the Alternative defined for the Field. For example, the Physical Alternative may only apply to five of the
element types. In this case, you will only see these five items listed in the Alternative drop-down menu.
You cannot use the sharing feature to move a field from one element type to another. Validation is in place to
ensure that only one item is selected and if it is the same as the original, default selection. If it is not, a message
appears telling you that when sharing a field, you must select at least two element types, or select the original
element type.
To unshare a field that is shared among multiple element types, right-click the user data extension you want to keep
in the list pane, then select Sharing. Clear all the element types that do not want to share the field with and click
OK. If you leave only one element type checked in the Shared Field Specification dialog box, it must be the original
element type for which you created the user data extension.
The fields that were located under the catch basin and conduit element type root nodes will be removed completely.
You can also unshare a field by using the Delete button or right-clicking and selecting Delete. This will unshare and
delete the field.
To share a user data extension:
1. Open the User Data Extensions dialog box by selecting Tools > User Data Extensions.
2. In the list pane, create a new user data extension to share or select an existing user data extension you want to share,
then click the Sharing button.
3. In the Shared Field Specification dialog box, select the check box next to each element type that will share the user
data extension.
4. Click OK.
5. The icon next to the user data extension in the list pane changes to indicate that it is a shared field.
233
Creating Models
Shared Field Specification Dialog Box

Select element types to share a user data extension in the Shared Field Specification dialog box. The dialog box
contains a list of all possible element types with check boxes.
Select element types to share the current user data extension by selecting the check box next to the element type. Clear
a selection if you no longer want that element type to share the current field.
Enumeration Editor Dialog Box

The Enumeration Editor dialog box opens when you select Enumerated as the Data Type for a user data extension, then
click the Ellipses (...) button in the Default Value field. Enumerated fields are fields that contain multiple selections -
you define these as members in the Enumeration Editor dialog box.
234
Creating Models
For example, suppose you want to identify pipes in a model of a new subdivision by one of the following states:
Existing, Proposed, Abandoned, Removed, and Retired. You can define a new user data extension with the label Pipe
Status for pipes, and select Enumerated as the data type. Click the Ellipses (...) button in the Default Value field in the
Property Editor for the user data extension to display the Enumeration Editor dialog box. Then enter five members with
unique labels (one member for each unique pipe status) and enumeration values in the table. After you close the User
Data Extensions dialog box, the new field and its members will be available in the Property Editor for all pipes in your
model. You will be able to select any of the statuses defined as members in the new Pipe Status field.
You can specify an unlimited number of members for each user data extension, but member labels and values must be
unique. If they are not unique, an error message appears when you try to close the dialog box.
The dialog box contains a table and the following controls:
NewAdds a new row to the table. Each row in the table represents a unique enumerated member of the current
user data extension.
DeleteDeletes the current row from the table. The enumerated member defined in that row is deleted from the
user data extension.
Define enumerated members in the table, which contains the following columns:
Enumeration Member Display LabelThe label of the member. This is the label you will see in WaterGEMS V8i
wherever the user data extension appears (Property Editor, FlexTables, etc.).
Enumeration ValueA unique integer index associated with the member label. WaterGEMS V8i uses this number
when it performs operations such as queries.
User Data Extensions Import Dialog Box

The Import dialog box opens after you initiate an Import command and choose the xml file to be imported. The Import
dialog displays all of the elements contained within the selected xml file. Uncheck the boxes next to a domain element
to ignore them during import.
235
Creating Models
Formula Dialog Box

This dialog allows you to define formulas for use with the Real (Formula) User Data Extension type.
You construct the formula using the available fields, operators, and functions. All the dialog box controls are described
as follows:
Fields: Lists all input and results fields applicable to the selected element type. This list displays the labels of the
fields while the underlying database column names of the fields become visible in the preview pane when you add
them to the formula. Double-click a field to add it to your formula.
Operators: These buttons represent all of the operators that can be used in the formula. Click the appropriate button
to add the operator to the end of your formula , which is displayed in the preview pane. Besides the common options
for options for adding, subtracting, multiplying and dividing values , there are also ( ) which allows for more
complex formulas, and the caret (^) which is used for raising a value to the power of a value.
Available Math Functions: Lists mathematical functions that can be used in the formula. If you hover over a
function it will describe the number of required parameters and a brief description of what the function does.
Copy: Copies the entire formula displayed in the preview pane to the Windows clipboard.
Paste: Pastes the contents of the Windows clipboard into the preview pane at the location of the text cursor. For
example, if your cursor is at the end of the formula in the preview pane and you click the Paste button, the contents
of your clipboard will be added to the end of the formua.
Preview Pane: Displays the formula as you add fields, operators, and functions to it.
Property Grid Customizations Manager
The Property Grid Customizations Manager allows you to create customization profiles that define changes to the
default user interface. Customization profiles allow you to turn off the visibility of properties in the Properties Editor.
Customization Profiles can be created for a single project or shared across projects. There are also a number of
predefined profiles.
The Property Grid Customizations Manager consists of the following controls:
New This button opens a submenu

Folder: This command creates a new
folder under the currently highlighted
node in the list pane. Customization:
This command creates a new
customization profile under the
currently highlighted node in the list
pane.

highlighted folder or customization
profile.
Rename This button allows you to rename the

currently highlighted folder or
customization profile.
236
Creating Models
Duplicate This button allows you to make a

copy of the highlighted customization
profile.
Edit Opens the Customization Editor

dialog allowing you to edit the
currently highlighted customization
profile.
Help Opens the online help.
Customization Editor Dialog Box

This dialog box allows you to edit the customization profiles that are created in the Customization Manager. In the
Customization editor you can turn off the visibility of various properties in the Property Grid.
You can turn off any number of properties and/or entire categories of properties in a single customization profile.
Note that element types that are not used in the current model are marked with an icon.
To remove a property from the property grid:
1. Select the element type from the pulldown menu.
2. Find the property you want to turn off by expanding the node of the category the property is under.
3. Uncheck the box next to the property to be turned off.
4. Click OK.
To turn off all of the properties under a category:
1. Select the element type from the pulldown menu.
2. Uncheck the box next to the category to be turned off.
3. Click OK.
Tooltip Customization
Tooltip customization allows you to define what data is displayed in the tooltip that appears when you hover over an
element in the drawing pane.
Tooltip Customization settings can be created for a single project or shared across projects. There are also a number of
predefined profiles.
The Tooltip Customizations Manager consists of the following controls:
237
Creating Models
New This button opens a submenu

Folder: This command creates a new
folder under the currently highlighted
node in the list pane. Customization:
This command creates a new
customization profile under the
currently highlighted node in the list
pane.

highlighted folder or customization
profile.
Rename This button allows you to rename the

currently highlighted folder or
customization profile.
Duplicate This button allows you to make a

copy of the highlighted customization
profile.
Make Active This button allows you to make the

profile the active one.
Edit Opens the Tooltip Customization

Editor dialog allowing you to edit the
profile.
Tooltip Customization Editor

This dialog allows you to define the tooltip customizations on a per-element basis.
238
Creating Models
On the left is a list of all of the element types. If the box for an element type is unchecked, no tooltip will be displayed
for that element type.
Highlight an element type to define the tooltip in the pane on the upper right. You can type in the field or use the
Append button to select from a number of predefined variables. After a tooltip using these variables has been defined,
these variables will be populated with the associated values in the drawing pane after the model has been calculated.
The Preview pane displays an example of how the tooltip will look.
i-Models
The term i-models is used to describe a type of Bentley file (container) which can be used to share data between
applications. The formal definition of an i-model is:
An immutable container for rich multi-discipline information published from known sources in a known state at a
known time. It is a published rendition in a secure read-only container. It is a portable, self-describing and semantically
rich data file.
i-models can be thought of as similar to shapefiles in that they provide ways to share data. They are immutable in that
they cannot be modified (they are read-only). They reflect the state of the model file at the time the i-model was
created.
i-model support is built on Bentley technology and is not automatically installed with WaterGEMS V8i or other
hydraulic products. The software to use i-models is installed with Microstation and other Microstation based products
(versions 08.11.07 or later). If a user attempts to create an i-model and the support for i-model creation is not installed,
an error message to download and install the necessary files is issued. The i-model files can be installed from the
Bentley SELECTdownload site.
An i-model can contain all the elements and their properties for a model for a given scenario and time-step or the
information can be filtered so that only a fraction of the elements and their properties are incorporated in the i-model.
An i-model is generally much smaller than the .sqlite file for the hydraulic model even though it does contain results.
239
Creating Models
Publishing an i-model
To create an i-model, select File > Export > Publish i-model once the desired scenario and time-steps have been
selected.
The following dialog opens with the defaults set so that all elements and properties are included in the i-model.
The top left pane is a summary of this element types are to be included in the i-model. If a box by the element type is
checked, that element type is included. The Table/Properties column reflects the selections on the right side of the
dialog in terms of which elements and properties are included.
The bottom left portion of the dialog is used to identify which elements are to be included in the i-model. This can be
specified individually for each element type.
If the "Publish a subset of elements based on the active Flex Table filters" box is checked, only those elements that are
in the filtered flex table will be included in the i-model.
If the "Exclude topologically inactive elements" box is checked, only active elements (Is active? = True) are included in
the i-model.
The user will usually not need to include all element properties in the i-model. The right side of the dialog is to identify
which properties of the elements are going to be included in the i-model. The default is "all properties". If the user
wants to only include a subset of properties, the user should create a flex table with only those properties and select that
240
Creating Models
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 Project table), the user can explicitly state the table path (e.g. Tables - Predefined
or Tables - Project). 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.
The Properties box on the right side of the dialog shows the properties that are imported for that element type.
If the box for "Publish project elements in 3D" is selected, the elements will be published in 3D.
The main motivation behind allowing publishing geometries in 3D is to enable clash-detection. That feature is expected
to be more important for gravity hydraulic products, but it is included with pressure-based applications as well. The
basic functionality regarding this topic can be summarized as:
Node cells' z-coordinates are assigned according to their elevation values, at their cell's insertion point.
3D node cells in the cell-library are supported.
Pipes are exported as cylinders, with partial toroidal shapes at their vertices.
Pipe cylinder diameters match assigned diameter values.
Pipe elevations in pressure applications are assumed to be at center of cylinders.
Pipe elevations in gravity applications have more details to be aware of (e.g. rim, invert and crown elevations).
References and any extra graphics published (e.g. annotations) are assigned a z-coordinate of 0.0.
When all settings are established for all element types, the user picks OK.
Upon starting the publishing, the user is asked for the file name for the .dgn file that will contain the i-model. The user
names the file and path as with any other Windows application.
241
Creating Models
Publish to Map Mobile i-model

To publish to a Map Mobile i-model, select File > Export > Publish to Map Mobile i-model once the desired scenario
and time-steps have been selected.
The Publish to Map Mobile i-model dialog box consists of the same controls as the Publish to i-model dialog. See
Publishing an i-model (on page 240) for more details on using this dialog.
You can use a geospatial reference (specified in the options dialog - see Options Dialog Box - Project Tab (on page
73)) when publishing from stand-alone. This spatial reference is applied to the i-model being published.
If publishing from MicroStation, a geospatial reference is used when publishing the i-model if one has been assigned.
Invalid geospatial references are ignored.
If specified correctly, GPS capabilities will be enabled in the Map Mobile app, including the ability to get directions to
a selected element.
Viewing an i-model
It is anticipated that numerous applications will be able to view and use i-models. Initially, i-models can be view using
Bentley View
ProjectWise Navigator
242
Creating Models
Microstation
In all of these applications, it is possible to open an i-model by browsing to the i-model when the application starts and
opening the file.
If the model is not visible, pick the "Fit View" button. This should make the model visible. From this view, it is
possible to use other commands such as zooming and panning to navigate around the drawing.
To view the properties of individual elements, pick the Element Information button or pick Edit > Information in
Bentley View or Review > Information in ProjectWise Navigator. The user can then select an element and its properties
will be displayed.
243
Creating Models
The user can collapse or expand any category in the window.

In Microstation and Navigator, it is also possible to view tabular element data for each element type by selecting File >
Item browser. This opens the Items browser for element types as shown below:
244
Creating Models
Double clicking on one of the element types or picking the "Show Details" button from the top of the dialog, opens a
table for that element type.
If the tree is expanded before selecting Show Details and an individual element is selected, the user will see properties
for the selected element.
245
Creating Models
Storage Chambers Dialog Box
This dialog allows you to create and reuse prefabricated storage chambers. You can construct complex arrays of storage
chambers which can be combined with other standard pond components to create a single storage entity to be used in
the routing analysis.
246
Creating Models
The dialog consists of a list pane on the left and a tabbed section on the right. The list pane displays all of the storage
chamber definitions associated with the project. Above the list pane are the following buttons:

New: Creates a new entry in the list pane.

Duplicate: Creates a copy of the entry that is currently highlighted in the list pane.

Delete: Removes the entry that is currently highlighted in the list pane.

Rename: Allows you to enter a new label for the entry that is highlighted in the list pane.

Report: Generates a preformatted report that details the data associated with the entry that is currently

Synchronization Options: Clicking this button opens a submenu containing the following commands:
Browse Engineering Library: Opens the Engineering Library manager dialog, allowing you to browse the
Storage Chamber Libraries.
Synchronize From Library: Lets you update a set of definitions previously imported from a Storage Chamber
Library. The updates reflect changes that have been made to the library since it was imported.
Synchronize To Library: Lets you update an existing Storage Chamber Library using current definitions that
were initially imported but have since been modified.
Import From Library: Lets you import a definition from an existing Storage Chamber Library.
Export To Library: Lets you export the current definition to an existing Storage Chamber Library.
Connect to LibraryOpens the Engineering Library, allowing you to select a library to synchronize with the
current entry.

Help: Opens the online help associated with this dialog.
The tabbed section on the right side of the dialog consists of the following tabs:
Storage Chambers: The attributes displayed in the property editor section of the Storage Chambers tab will change
depending on the type of storage chamber that is currently highlighted in the list pane. Depending on the node type,
the property grid allows you to define the following attributes:
Circular: The following attributes are used to define Circular storage chambers:
Default Spacing: Set the default edge-to-edge spacing for the storage chamber when organized into rows on
the Pond Element.
Effective Length: The length of the storage chamber when it is interlocked in a storage chamber row. If the
Section Length varies, then the effective length represents the length of the middle sections.
Section Length Varies?: If True, you can specify the effective lengths of the start and stop sections of a
storage chamber row.
Start Section Length: Specify the length of the storage chamber at the start of the storage chamber row.
End Section Length: Specify the length of the storage chamber at the end of the storage chamber row.
Storage Multiplier: Adjust the internal storage volume of the storage chamber.
Wall Thickness: Set the thickness of the wall of the storage structure.
Nominal Diameter: The internal diameter of the circular structure.
Box: The following attributes are used to define Box storage chambers:
the Pond Element.
247
Creating Models
Wall Thickness: Set the thickness of the wall of the storage structure.
Rise: The internal rise of the storage structure.
Span: The internal span of the storage structure.
Depth-Width Curve: The following attributes are used to define Depth-Width Curve storage chambers:
the Pond Element.
Depth-Width Curve: Opens the Depth-Width Curve dialog, allowing you to describe how the width of the
storage chamber varies with depth.
Pipe Arch: The following attributes are used to define Pipe Arch storage chambers:
the Pond Element.
Rise: The internal rise of the storage structure.
Span: The internal span of the storage structure.
Full Area: Set the internal full area of the storage structure.
Bottom Radius: Set the internal bottom radius of the pipe arch structure.
Corner Radius: Set the internal corner radius of the pipe arch structure.
Bottom Distance: Set the internal bottom distance of the pipe arch structure.
Top Radius: Set the internal top radius of the pipe arch structure.
Volume Per Unit Length: The following attributes are used to define Volume Per Unit Length storage
chambers:
the Pond Element.
248
Creating Models
Maximum Width: Set the maximum span that occurs within the structure. This value is used for setting the
spacing in the storage chamber system or pond element. It is not used for computing volumes.
Depth-Volume Per Unit Length Curve: Opens the Depth-Volume Per Unit Curve dialog, allowing you to
describe how the volume per unit length varies with depth.
Notes Tab: This text field that allows you to enter descriptive notes that will be associated with the currently
highlighted list pane entry.
Library Tab: This tab displays information about the template that is currently highlighted in the list pane. If the
template is derived from an engineering library, the synchronization details can be found here. If the template was
created manually for this project, the synchronization details will display the message Orphan (local), indicating that
the template was not derived from a library entry.
For more information about Storage Chambers, see Storage Chambers.
Depth-Width Curve Dialog Box
This dialog allows you to describe how the inner and outer width of the storage chamber vary with depth.
Click the New button to add a row. Click the Delete button to remove the currently highlighted row. Enter Depth vs
Inner/Outer Width points to describe how the width of the storage chamber varies with depth.
For more information about Depth-Width Curves, see Depth-Width Curve Type.
Depth-Incremental Volume Per Unit Length Curve Dialog Box
This dialog allows you to describe how the incremental volume per unit length of the storage chamber varies with
depth.
249
Using ModelBuilder to Transfer Existing Data
Click the New button to add a row. Click the Delete button to remove the currently highlighted row. Enter Depth vs
Incremental Volume points to describe how the incremental volume per unit length of the storage chamber varies with
depth.

ModelBuilder lets you use your existing GIS asset to construct a new WaterGEMS V8i model or update an existing
WaterGEMS V8i model. ModelBuilder supports a wide variety of data formats, from simple databases (such as Access
and DBase), spreadsheets (such as Excel), GIS data (such as shape files), Bentley Map data, to high end data stores
(such as Oracle, and SQL Server), and more.
Using ModelBuilder, you map the tables and fields contained within your data source to element types and attributes in
your WaterGEMS V8i model. The result is that a WaterGEMS V8i model is created. ModelBuilder can be used in any
of the WaterGEMS V8i platforms - Stand-Alone, MicroStation mode, AutoCAD mode, or ArcGIS mode.
Note: ModelBuilder lets you bring a wide range of data into your model. However, some data is better suited to
the use of the more specialized WaterGEMS V8i modules. For instance, LoadBuilder offers many powerful
options for incorporating loading data into your model.
ModelBuilder is the first tool you will use when constructing a model from GIS data. The steps that you take at the
outset will impact how the rest of the process goes. Take the time now to ensure that this process goes as smoothly and
efficiently as possible:
Preparing to Use ModelBuilder

Determine the purpose of your model--Once you establish the purpose of your model, you can start to make
decisions about how detailed the model should be.
Get familiar with your data--If you obtained your GIS data from an outside source, you should take the time to get
acquainted with it. Review spatial and attribute data directly in your GIS environment. Do the nodes have
coordinate information, and do the pipes have start and stop nodes specified? If not, the best method of specifying
network connectivity must be determined.
250
Contact those involved in the development of the GIS to learn more about the GIS tables and associated attributes.
Find out the purpose of any fields that may be of interest, ensure that data is of an acceptable accuracy, and
determine units associated with fields containing numeric data.
Ideally, there will be one GIS source data table for each WaterGEMS V8i element type. This isnt always the case,
and there are two other possible scenarios:
Many GIS tables for one element type--In this case, there may be several tables in the GIS/database corresponding
to a single modeling element . In this case each data source table must be individually mapped to the WaterGEMS
V8i element, or the tables must be combined into a single table in the GIS/database before running ModelBuilder.
One GIS table containing many element types--In this case, there may be entries that correspond to several
WaterGEMS V8i modeling elements in one GIS/database table. You should separate these into individual tables
before running ModelBuilder. The one case where a single table can work is when the features in the table are
ArcGIS subtypes. ModelBuilder handles these subtypes by treating them as separate tables when setting up
mappings. See Subtypes (on page 265) for more information. If you are working with an ArcGIS data source, see
Esri ArcGIS Geodatabase Support (on page 264) for additional information.
Preparing your data--When using ModelBuilder to get data from your GIS into your model, you will be associating
rows in your GIS to elements in WaterGEMS V8i. Your data source needs to contain a Key/Label field that can be
used to uniquely identify every element in your model. The data source tables should have identifying column
labels, or ModelBuilder will interpret the first row of data in the table as the column labels. Be sure data is in a
format suited for use in ModelBuilder. Use powerful GIS and Database tools to perform Database Joins, Spatial
Joins, and Update Joins to get data into the appropriate table, and in the desired format.
Note: When working with ID fields, the expected model input is the WaterGEMS V8i ID. After creating these
items in your WaterGEMS V8i model, you can obtain the assigned ID values directly from your WaterGEMS V8i
modeling file. Before synchronizing your model, get these WaterGEMS V8i IDs into your data source table (e.g.,
by performing a database join).
One area of difficulty in building a model from GIS data is the fact that unless the GIS was created solely to support
modeling, it most likely contains much more detailed information than is needed for modeling. This is especially true
with regard to the number of piping elements. It is not uncommon for the GIS to include every service line and hydrant
lateral. Such information is not needed for most modeling applications and should be removed to improve model run
time, reduce file size, and save costs.
ModelBuilder Connections Manager
ModelBuilder can be used in any of the WaterGEMS V8i platforms - Stand-Alone, MicroStation mode, AutoCAD
mode, or ArcGIS mode.
To access ModelBuilder: Click the Tools menu and select the ModelBuilder command, or click the ModelBuilder
button
The ModelBuilder Connections manager allows you to create, edit, and manage ModelBuilder connections to be used
in the model-building/model-synchronizing process. Each item in this manager represents a "connection" which
contains the set of directions for moving data between a source to a target. ModelBuilder connections are not stored in a
particular project, but are stored in an external xml file, with the following path:
Windows XP: C:\Documents and Settings\<username>\Application Data\Bentley\<productname>\<productversion>
\ModelBuilder.xml
251
Windows Vista: C:\Users\<username>\AppData\Roaming\Bentley\<productname>\<productversion>

\ModelBuilder.xml
At the center of this window is the Connections List which displays the list of connections that you have defined.
There is a toolbar located along the top of the Connections list.
The set of buttons on the left of the toolbar allow you to manage your connections:
Import/Export Click this button to import or export a

ModelBuilder Connection file (.mbc).
New Create a new connection using the

ModelBuilder Wizard.
Edit Edit the selected connection using the

ModelBuilder Wizard.
Rename Rename the selected connection.
Duplicate Create a copy of the selected

connection.
Delete Permanently Remove the selected

connection.
252
Build Model Starts the ModelBuilder build process

using the selected connection. This is
also referred to as "synching in" from
an external data source to a model.
Excluding some spatial option
overrides, a build operation will
update your model with new
elements, components, and
collections that already exist in the
model. Only table types and fields
that are mapped will be updated.
Depending upon the configuration of
synchronization options in the
selected connection, if an element in
your data source does not already
exist in your model, it may be created.
If the element exists, only the fields
mapped for that table type may be
updated. ModelBuilder will not
override element properties not
specifically associated with the
defined field mappings. A Build
Model operation will update existing
or newly created element values for
the current scenario/alternative, or
you can optionally create new child
scenario/alternatives to capture any
data difference.
Sync Out Starts the ModelBuilder synchronize

process using the selected connection.
Unless specifically overridden, a Sync
Out operation will only work for
existing and new elements. On a Sync
Out every element in your target data
source that also exists in your model
will be refreshed with the current
model values. If your model contains
elements that aren't contained in your
data source, those data rows can
optionally be added to your target
data file. Only those properties
specified with field mappings will be
synchronized out to the data source. A
Sync Out operation will refresh
element properties in the data source
with the current model values for the
current scenario/alternative.
253
Help Displays online help.
After initiating a Build or Sync command, ModelBuilder will perform the selected operation. During the process, a
progress-bar will be displayed indicating the step that ModelBuilder is currently working on.
When ModelBuilder completes, you will be presented with a summary window that outlines important information
about the build process. We recommend that you save this summary so that you can refer to it later.
Note: Because the connections are stored in a separate xml file rather than with the project file, ModelBuilder
connections are preserved even after WaterGEMS V8i is closed.
Specify Datasource Location

This dialog allows you to specify the datasource associated with the ModelBuilder connection that is currently
highlighted in the ModelBuilder connections manager. Click the Browse button and select the datasource file.
Microsoft Access Database Engine Version

The 64 bit version of this Bentley software requires the "64-bit Access Database Engine" (not included with this
Bentley software) to be able to support newer MSOffice file formats which can be used in ModelBuilder and
SCADAConnect. If you do not have a compatible version of the Access Database Engine installed and wish to connect
to these data sources, either download and install the 64-bit Access Database Engine from Microsoft using the
following link: http://www.microsoft.com/en-us/ download/details.aspx?id=13255 or alternatively, use the 32 bit
version of the software, which can be accessed from C:\Program Files (x86)\Bentley\<Product Name>\<Product
Name>\<Product Name>.exe, which supports these formats without requiring additional components.
ModelBuilder Wizard
The ModelBuilder Wizard assists in the creation of ModelBuilder connections. The Wizard will guide you through the
process of selecting your data source and mapping that data to the desired input of your model.
The ModelBuilder Wizard can be resized, making it easier to preview tables in your data source. In addition, Step 1 and
Step 3 of the wizard offer a vertical split bar, letting you adjust the size of the list located on the left side of these pages.
There are 6 steps involved; click the links below for more information.
Step 1-Specify Data Source

In this step, the data source type and location are specified. After selecting your data source, the desired database tables
can be chosen and previewed.
254
The following fields are available:

Data Source type (drop-down list)This field allows you to specify the type of data you would like to work with. If
your specific data source type is not listed in the Data Source type field, try using the OLE DB data source type.
OLE DB can be used to access many database systems (including ORACLE, and SQL Server, to name a few).
Data Source (text field)This read-only field displays the path to your data source.
Browse (button)This button opens a browse dialog box that allows you to interactively select your data source.
Some Data Source types expect you to choose more than one item in the Browse dialog box. For more information,
see Multi-select Data Source Types-190.
Table/Feature Class (list)This pane is located along the left side of the form and lists the tables/feature classes
that are contained within the data source. Use the check boxes (along the left side of the list) to specify the tables
you would like to include.
The list can be resized using the split bar (located on the right side of the list). Right-click to Select All or Clear the
current selection in the list.
Duplicate Table (button)
The duplicate table button is located along the top of the Table/Feature Class list. This button allows you to make
copies of a table, which can each be mapped to a different element type in your model. Use this in conjunction with
the WHERE clause.
Remove Table (button)
255
The remove table button can be used to remove a table from the list.
WHERE Clause (field)Allows you to create a SQL query to filter the tables. When the box is checked, only tables
that meet the criteria specified by the WHERE clause will be displayed. Click the
button to validate the query and to refresh the preview table.

Preview PaneA tabular preview of the highlighted table is displayed in this pane when the Show Preview check
box is enabled.
Note: If both nodes and pipes are imported in the same ModelBuilder connection, nodes will be imported first
regardless of the order they are listed here.
Note: When running within Bentley Map, a new entry will appear in the ModelBuilder Datasource combobox
called "Bentley Map". Select that to import and export any available data sets that live in the currently open
Bentley Map file.
Step 2-Specify Spatial Options

In this step you will specify the spatial options to be used during the ModelBuilder process. The spatial options will
determine the placement and connectivity of the model elements. The fields available in this step will vary depending
on the data source type.
256
Specify the Coordinate Unit of your data source (drop-down list)This field allows you to specify the coordinate
unit of the spatial data in your data source. The default unit is the unit used for coordinates.
Create nodes if none found at pipe endpoint (check box)When this box is checked, ModelBuilder will create a
pressure junction at any pipe endpoint that: a) doesnt have a connected node, and b) is not within the specified
tolerance of an existing node. This field is only active when the Establish connectivity using spatial data box is
checked. (This option is not available if the connection is bringing in only point type geometric data.)
ModelBuilder will not create pipes unless a valid start/stop node exists. Choose this option if you know that there
are nodes missing from your source data. If you expect your data to be complete, then leave this option off and if
this situation is detected ModelBuilder will report errors for your review. For more information see Specifying
Network Connectivity in ModelBuilder (on page 265).
Establish connectivity using spatial data (check box)When this box is checked, ModelBuilder will connect pipes
to nodes that fall within a specified tolerance of a pipe endpoint. (This option is available if the connection is
bringing in only polyline type geometric data.) Use this option, when the data source does not explicitly name the
nodes at the end of each pipe. For more information, see Specifying Network Connectivity in ModelBuilder (on
page 265).
Tolerance (numeric field)This field dictates how close a node must be to a pipe endpoint in order for connectivity
to be established. The Tolerance field is only available when the Establish connectivity using spatial data box is
checked. (This option is available if the connection is bringing in only polyline type geometric data.) Tolerances
should be set as low as possible so that unintended connections are not made. If you are not sure what tolerance to
use, try doing some test runs. Use the Network Review queries to evaluate the success of each trial import. Pipes
will be connected to the closest node within the specified tolerance.
The unit associated with the tolerance is dictated by the Specify the Coordinate Unit of your data source field. For
more information, see Specifying Network Connectivity in ModelBuilder (on page 265).
Step 3 - Specify Element Create/Remove/Update Options

Because of the variety of different data sources and they way those sources were created, the user has a wide variety of
options to control the behavior of ModelBuilder.
257
How would you like to handle synchronization between source and destination?:
Add objects to destination if present in source (check box)-When this box is checked, ModelBuilder will
automatically add new elements to the model for "new" records in the data source when synching in (or vice-versa
when synching out).
This is checked by default since a user generally wants to add elements to the model (especially if this is the initial
run of ModelBuilder). This should be unchecked if new elements have been added to the source file since the model
was created but the user does not want them in the model (e.g. proposed piping).
Remove objects from destination if missing from source (check box)-When this box is checked, ModelBuilder will
delete elements from the model if they do not exist in the data source when synching in (or vice-versa when
synching out). This option can be useful if you are importing a subset of elements.
This is used if abandoned pipes have been deleted from the source file and the user wants them to automatically be
removed from the model by ModelBuilder.
Update existing objects in destination if present in source (check box) - If checked, this option allows you to control
whether or not properties and geometry of existing model elements will be updated when synching in (or vice-versa
when synching out). Turning this option off can be useful if you want to synchronize newly added or removed
elements, while leaving existing elements untouched.
If an imported object refers to another object that does not yet exist in the model, should ModelBuilder:
Create referenced element automatically? (check box)-When this box is checked, ModelBuilder will create any
domain and/or support elements that are referenced during the import process.
Note: These options listed above apply to domain elements (pipes and nodes) as well as support elements (such
as Zones or Controls).
258
Step 4-Additional Options
How would you like to import incoming data? (drop-down list) - This refers to the scenario (and associated
alternatives) into which the data will be imported. The user can import the data into the Current Scenario or a new
child scenario. If the latter is selected, a new child scenario (and child alternatives) will be created for any data
difference between the source and the active scenario. If there is no data change for a particular alternative, no child
alternative will be created in that case.
New scenario and alternatives will be automatically labeled "Created by ModelBuilder" followed by the date and
time when they were created.
Specify key field used during object mapping (drop-down list) - The key field represents the field in the model and
data source that contains the unique identifier for associating domain elements in your model to records in your data
source. Refer to the "Key Field (Model)" topic in the next section for additional guidance on how this setting applies
to ModelBuilder. ModelBuilder provides three choices for Key Field:
The following options only apply when using the advanced GIS-IDs key field option.
If several elements share the same GIS-IDs, then apply updates to all of them? (check box) - When using the GIS-
IDs option, ModelBuilder allows you to maintain one-to-many, and many-to-one relationships between records in
your GIS and elements in your Model.
For example, you may have a single pipe in your GIS that you want to maintain as multiple elements in your Model
because you have split that pipe into two pipes elements in the model. You may accomplish this using the native
WaterGEMS layout tools to split the pipe with a node; the newly created pipe segment will be assigned the same
GIS-IDs as the original pipe (establishing a one-to-many relationship). By using this option, when you later
synchronize from the GIS into your model, any data changes to the single pipe record in your GIS can be cascaded
to both pipes elements in your model (e.g. so a diameter change to a single record in the GIS would be reflected in
both elements in the model).
259
How would you like to handle add/removes of elements with GIS-IDs mappings on subsequent imports? - These
options are useful for keeping your GIS and Model synchronized, while maintaining established differences.
Note: This setting only applies if the "Remove objects from destination if missing from source" option is checked.
When you do make connectivity changes to your model, it is often beneficial to make those same changes to the GIS.
However, this is not always possible; and in some cases is not desirable -- given the fact that Modeling often has highly
specialized needs that may not be met by a general purpose GIS.
Step 5-Specify Field mappings for each Table/Feature Class

In this step, data source tables are mapped to the desired modeling element types, and data source fields are mapped to
the desired model input properties. You will assign mappings for each Table/Feature Class that appears in the list; Step
1 of the wizard can be used to exclude tables, if you wish.
Tables (list)-This pane, located along the left side of the dialog box, lists the data source Tables/Feature Classes to
be used in the ModelBuilder process. Select an item in the list to specify the settings for that item. The tables list
can be resized using the splitter bar.
There are two toolbar buttons located directly above Tables list (these buttons can be a great time saver when setting
up multiple mappings with similar settings).
Settings Tab-The Settings tab allows you to specify mappings for the selected item in the Tables list.
The top section of the Settings tab allows you to specify the common data mappings:
Element Types-This category of Table Type includes geometric elements represented in the drawing view such as
conduits, catch basins, manholes, etc.
Components-This category of Table Type includes the supporting data items in your model that are potentially
shared among elements such as patterns, pump definitions, and controls.
260
Collections-This category of Table Type includes table types that are typically lists of 2-columned data. For
instance, if one table in your connection consists of a list of (Time From Start, Multiplier) pairs, use a Pattern
collection table type selection.
Key Field (Data Source) (drop-down list)-Choose the field in your data source that contains the unique identifier for
each record. If you plan to maintain synchronizations between your model and GIS, it is best to define a unique
identifier in your data source for this purpose. Using an identifier that is unique across all tables is critical if you
wish to maintain explicit pipe start/stop connectivity identifiers in your GIS.
When working with ArcGIS data sources, OBJECTID is not a good choice for Key field (because OBJECTID is
only unique for a particular Feature Class). For one-time model builds -- if you do not have a field that can be used
to uniquely identify each element -- you may use the <label> field (which is automatically generated by
ModelBuilder for this purpose).
Key Field (Model) (drop-down-list) - This field is only enabled if you specified <custom> in the "Specify key field
to be used in object mapping?" option in the previous step. If you specified "GIS-IDs' or "Label" the field will be
disabled.
If you specified <custom>, then you will be presented with a list of the available text fields for that element type.
Choose a field that represents the unique alphanumeric identifier for each element in your model. You can define a
text User Data Extensions property for use as your <custom> model key field.
The <custom> key field list is limited to read-write text fields. This is because during import, the value of this field
will be assigned as new elements in your model are created. Therefore, the models internal (read-only) element ID
field cannot be used for this purpose.
Start/Stop - Select the fields in a pipe table that contain the identifier of the start and stop nodes. Specify <none> if
you are using the spatial connectivity support in ModelBuilder (or if you want to keep connectivity unchanged on
update). For more information, see Specifying Network Connectivity in ModelBuilder. When working with an
ArcGIS Geometric Network data source, these fields will be set to <auto> (indicating that ModelBuilder will
automatically determine connectivity from the geometric network).
X/Y Field - These fields are used to specify the node X and Y coordinate data. This field only applies to point table
types. The Coordinate Unit setting in Step 2 of the wizard allows you to specify the units associated with these
fields.
When working with ArcGIS Geodatabase, shape file and CAD data sources, these fields will be set to <auto>
(indicating that ModelBuilder will automatically determine node geometry from the data source).
Suction Element (drop-down list)-For tables that define pump data, select a pipe label or other unique identifier to
set the suction element of the Pump.
Downstream Edge (drop-down list)-For tables that define pump or valve data, select a pipe label or other unique
identifier to set the direction of the pump or valve.
Field - Field refers to a field in the selected data source. The Field list displays the associations between fields in the
database to properties in the model.
Property (drop-down list)-Property refers to a Bentley WaterGEMS property. Use the Property drop-down list to
map the highlighted field to the desired property.
Unit (drop-down list)-This field allows you to specify the units of the values in the database (no conversion on your
part is required). This field only applies if the selected model property is unitized.
Preview Tab-The Preview tab displays a tabular preview of the currently highlighted source data table when the
Show Preview check box is checked.
To map a field in your table to a particular Bentley WaterGEMS property:
1. In the Field list, select the data source field you would like to define a mapping for.
2. In the Property drop-down list, select the desired Bentley WaterGEMS target model property.
3. If the property is unitized, specify the unit of this field in your data source in the Unit drop-down list.
To remove the mapping for a particular field:
261
1. Select the field you would like to update.

2. In the Property drop-down list, select <none>.
Step 6Build operation Confirmation

In this step, you are prompted to build a new model or update an existing model.
To build a new model, click the Yes radio button under Would you like to build the model now?.
If you choose No, you will be returned to the ModelBuilder Manager dialog. The connection you defined will appear in
the list pane. To build the model from the ModelBuilder Manager, highlight the connection and click the Build Model
button.
Create Selection Set options: Often a user wants to view the elements that have been affected by a ModelBuilder
operation. To do this, ModelBuilder can create selection sets which the user can view and use within the application.
To create a selection set containing the elements added during the ModelBuilder, check the box next to "Create
selection set with elements added."
To create a selection set containing the elements for which the properties or geometry were modified during the
ModelBuilder, check the box next to "Create selection set with elements modified".
Only show a subset of messages when synchronizing: Depending on the ModelBuilder configuration and the external
data, there are situations when a very large number of messages may be generated during the ModelBuilder
synchronization. Generating these messages adds some overhead and can use up a large amount of memory. Checking
this box will limit the number of messages that are generated for each specific message type.
Note: Selection sets created as a result of these options will include the word "ModelBuilder" in their name,
along with the date and time (e.g. "Elements added via ModelBuilder - mm/dd/yyyy hh:mm:ss am/pm")
Reviewing Your Results
At the end of the model building process, you will be presented with statistics, and a list of any warning/error messages
reported during the process. You should closely review this information, and be sure to save this data to disk where you
can refer to it later.
Note: Refer to the section titled ModelBuilder Warnings and Error Messages (on page 263) to determine the
nature of any messages that were reported.
Refer to the Using the Network Navigator (on page 200) and Manipulating Elements (on page 180) topics for
information about reviewing and correcting model connectivity issues.
Multi-select Data Source Types
When certain Data Source types are chosen in Step 1 of the ModelBuilder Wizard (see Step 1Specify Data Source
(on page 254)), multiple items can be selected for inclusion in your ModelBuilder connection.
After clicking the Browse button to interactively specify your data source, use standard Windows selection techniques
to select all items you would like to include in the connection (e.g., Ctrl+click each item you would like to include).
The following are multi-select Data Source types:
ArcGIS Geodatabase Features
262
Shape files
DBase and HTML Export.
ModelBuilder Warnings and Error Messages
Errors and warnings that are encountered during the ModelBuilder process will be reported in the ModelBuilder
Summary.
ModelBuilder Error Messages
Note: If you encounter these errors or warnings, we recommend that you correct the problems in your original
data source and re-run ModelBuilder (when applicable).
Error messages include:

Unable to assign <attribute> for element <element>. Be sure that the data in your source table is compatible with
the expected WaterGEMS V8i format.
Unable to create <element type> <element>. This message indicates that an unexpected error occurred when
attempting to create a node element.
Unable to create pipe <element> possibly due to start or stop connectivity constraints. This message indicates
that this pipe could not be created, because the pump or valve already has an incoming and outgoing pipe. Adding a
third pipe to a pump or valve is not allowed.
Unable to update pipe <element> topology; possibly due to start element connectivity constraints. This error
occurs when synchronizing. See above.
Operation terminated by user. You pressed the Cancel button during the ModelBuilder process.
Unable to create < element>; pipe start and stop must be different. This message indicates that the start and stop
specified for this pipe refer to the same node element.
Unable to update <element> topology; pipe start and stop must be different. This message indicates that the
start and stop specified for this pipe refer to the same node element.
Unable to update the downstream edge for <element>. An unexpected error occurred attempting to set the
downstream edge for this pump or valve.
Nothing to do. Some previously referenced tables may be missing from your data source. This data source has
changed since this connection was created. Verify that tables/feature-classes in your data source have not been
renamed or deleted.
One or more input features fall outside of the XYDomain. This error occurs when model elements have been
imported into a new geodatabase that has a different spatial reference from the elements being created. Elements
cannot be created in ArcMAP if they are outside the spatial bounds of the geodatabase. The solution is to assign the
correct X/Y Domain to the new geodatabase when it is being created:
1. In the Attach Geodatabase dialog that appears after you initialize the Create New Project command, click the
Change button.
2. In the Spatial Reference Properties dialog that appears, click the Import button.
3. Browse to the datasource you will be using in ModelBuilder and click Add.
4. Back in the Spatial Reference Properties dialog, click the X/Y Domain tab. The settings should match those of
the datasource.
5. Use ModelBuilder to create the model from the datasource.
263
Warnings
Warning messages include:
1. Some rows were ignored due to missing key-field values. - ModelBuilder encountered missing data (e.g., null or
blank) in the specified Key/Label field for rows in your data source table. Without a key, ModelBuilder is unable to
associate this source row with a target element, and must skip these items. This can commonly occur when using a
spreadsheet data source. To determine where and how often this error occurred, check the Statistics page for the
message <x> row(s) ignored due to missing key-field values.
2. Unable to create pipe <element>; start and/or stop node could not be found. - Pipes can only be created if its start
and stop nodes can be established. If you are using Explicit connectivity, a node element with the referenced start or
stop label could not be found. If you are using implicit connectivity, a node element could not be located within the
specified tolerance. For more information, see Specifying Network Connectivity in ModelBuilder-195.
3. Unable to update pipe <element> topology; (start or stop) node could not be found. - This error occurs when
synchronizing an existing model, and indicates that the pipe connectivity could not be updated. For more
information, see warning message #2 (above).
4. The downstream edge for <element> could not be found. - ModelBuilder was unable to set a Pump direction
because a pipe with the referenced label could not be found.
5. Directed Node <element> direction is ambiguous.
6. ModelBuilder was unable to set the direction of the referenced pump or valve because direction could not be
implied based on the adjacent pipes (e.g. there should be one incoming and one outgoing pipe).
ESRI ArcGIS Geodatabase Support
ModelBuilder was built using ArcObjects, and supports the following ESRI ArcGIS Geodatabase functionality. See
your ArcGIS documentation for more information about ArcObjects. For more information, see:
Geodatabase Features
ModelBuilder provides direct support for working with Geodatabase features. A feature class is much like a shapefile,
but with added functionality (such as subtypes).
The geodatabase stores objects. These objects may represent nonspatial real-world entities, such as manufacturers, or
they may represent spatial objects, such as pipes in a network. Objects in the geodatabase are stored in feature classes
(spatial) and tables (nonspatial).
The objects stored in a feature class or table can be organized into subtypes and may have a set of validation rules
associated with them. The ArcInfo system uses these validation rules to help you maintain a geodatabase that
contains valid objects.
Tables and feature classes store objects of the same typethat is, objects that have the same behavior and attributes.
For example, a feature class called WaterMains may store pressurized water mains. All water mains have the same
behavior and have the attributes ReferenceID, Depth, Material, GroundSurfaceType, Size, and PressureRating.
Geometric Networks
ModelBuilder has support for Geometric Networks, and a new network element type known as Complex Edge. When
you specify a Geometric Network data source, ModelBuilder automatically determines the feature classes that make up
264
the network. In addition, ModelBuilder can automatically establish model connectivity based on information in the
Geometric Network.
ArcGIS Geodatabase Features versus ArcGIS Geometric Network
Note: See your ArcGIS documentation for more information about Geometric Networks and Complex Edges.
When working with a Geometric Network, you have two options for constructing your modelif your model contains
Complex Edges, then there is a distinct difference. A Complex Edge can represent a single feature in the Geodatabase,
but multiple elements in the Geometric Network.
For example, when defining your Geometric Network, you can connect a lateral to a main without splitting the main
line. In this case, the main line will be represented as a single feature in the Geodatabase but as multiple edges in the
Geometric Network.
Depending on the data source type that you choose, ModelBuilder can see either representation. If you want to include
every element in your system, choose ArcGIS Geometric Network as your data source type. If you want to leave out
laterals and you want your main lines to be represented by single pipes in the model, choose ArcGIS Geodatabase
Features as your data source type.
Subtypes
Shapefiles can be converted into Geodatabase Feature Classes if you would like to make use of Subtypes. See your
ArcGIS documentation for more information.
If multiple types of WaterGEMS elements have their data stored in a single geodatabase table, then each element must
be a separate ArcGIS subtype. For example, in a valve table PRVs may be subtype 1, PSVs may be subtype 2, FCVs
may be subtype 3, and so on. With subtypes, it is not necessary to follow the rule that each GIS/database feature type
must be associated with a single type of GEMS model element. Note that the subtype field must be of the integer type
(e.g., 1, 2) and not an alphanumeric field (e.g., PRV). For more information about subtypes, see ArcGIS Help.
ModelBuilder has built in support for subtypes. After selecting your data source, feature classes will automatically be
categorized by subtype. This gives you the ability to assign mappings at the subtype level. For example, ModelBuilder
allows you to exclude a particular subtype within a feature class, or associate each subtype with a different element
type.
SDE (Spatial Database Engine)

ModelBuilder lets you specify an SDE Geodatabase as your data source. See your ESRI documentation for more
information about SDE.
Specifying Network Connectivity in ModelBuilder

When importing spatial data (ArcGIS Geodatabases or shapefile data contain spatial geometry data that ModelBuilder
can use to establish network connectivity by connecting pipe ends to nodes, creating nodes at pipe endpoints if none are
found.), ModelBuilder provides two ways to specify network connectivity:
Explicit connectivity--based on pipe Start node and Stop node (see Step 4--Additional Options (on page 259)).
Implicit connectivity--based on spatial data. When using implicit connectivity, ModelBuilder allows you to specify
a Tolerance, and provides a second option allowing you to Create nodes if none found (see Step 2--Specify Spatial
Options (on page 256)).
265
The method that you use will vary depending on the quality of your data. The possible situations include (in order from
best case to worst case):
You have pipe start and stop information--Explicit connectivity is definitely the preferred option.
You have some start and stop information--Use a combination of explicit and implicit connectivity (use the Spatial
Data option, and specify pipe Start/Stop fields). If the start or stop data is missing (blank) for a particular pipe,
ModelBuilder will then attempt to use spatial data to establish connectivity.
You do not have start and stop information--Implicit connectivity is your only option. If your spatial data is good,
then you should reduce your Tolerance accordingly.
You do not have start and stop information, and you do not have any node data (e.g., you have GIS data that defines
your pipes, but you do not have data for nodes)--Use implicit connectivity and specify the Create nodes if none
found option; otherwise, the pipes cannot be created.
Note: If pipes do not have explicit Start/Stop nodes and Establish connectivity using spatial data is not
checked, the pipes will not be connected to the nodes and a valid model will not be produced.
Other considerations include what happens when the coordinates of the pipe ends do not match up with the node
coordinates. This problem can be one of a few different varieties:
1. Both nodes and pipe ends have coordinates, and pipes have explicit Start/Stop nodes--In this case, the node
coordinates are used, and the pipe ends are moved to connect with the nodes.
2. Nodes have coordinates but pipes do not have explicit Start/Stop nodes--The nodes will be created, and the
specified tolerance will be used to connect pipe ends within this tolerance to the appropriate nodes. If a pipe end
does not fall within any nodes specified tolerance, a new node can be created using the Create nodes if none found
option.
3. Pipe ends have coordinates but there are no junctions--New nodes must be created using the Create nodes if none
found option. Pipe ends are then connected using the tolerance that is specified.
Another situation of interest occurs when two pipes cross but arent connected. If, at the point where the pipes cross,
there are no pipe ends or nodes within the specified tolerance, then the pipes will not be connected in the model. If you
intend for the pipes to connect, then pipe ends or junctions must exist within the specified tolerance.
Sample Spreadsheet Data Source
Note: Database formats (such as MS Access) are preferable to simple spreadsheet data sources. The sample
below is intended only to illustrate the importance of using expected data formats.
Here are two examples of possible data source tables. The first represents data that is in the correct format for an easy
transition into ModelBuilder, with no modification. The second table will require adjustments before all of the data can
be used by ModelBuilder.
Label Roughness_C Diam_in Length_ft Material_ID Subtype
P-1 120 6 120 3 2
P-2 110 8 75 2 1
P-3 130 6 356 2 3
P-4 100 10 729 1 1
266
P-1 120 .5 120 PVC Phase2
P-2 110 .66 75 DuctIron Lateral
P-3 130 .5 356 PVC Phase1
P-4 100 .83 729 DuctIron Main
P-5 100 1 1029 DuctIron Main
In the 2nd table, no column labels have been specified. ModelBuilder will interpret the first row of data in the table as
the column labels, which can make the attribute mapping step of the ModelBuilder Wizard more difficult unless you
are very familiar with your data source setup.
The 1st table is also superior to the 2nd in that it clearly identifies the units that are used for unitized attribute values,
such as length and diameter. Again, unless you are very familiar with your data source, unspecified units can lead to
errors and confusion.
Finally, the 2nd table is storing the Material and Subtype attributes as alphanumeric values, while ModelBuilder uses
integer ID values to access this input. This data is unusable by ModelBuilder in alphanumeric format, and must be
translated to an integer ID system in order to read this data.
GIS-IDs
All domain elements in WaterGEMS V8i have an editable GIS-IDs property which can be used for maintaining
associations between records in your source file and elements in your model. These associations can be one-to-one,
one-to-many, or many-to-one.
ModelBuilder can take advantage of this GIS-IDs property, and has advanced logic for keeping your model and GIS
source file synchronized across the various model to GIS associations.
The GIS-IDs is a unique field in the source file which the user selects when ModelBuilder is being set up. In contrast to
using Label (which is adequate if model building is a one time operation) as the key field between the model and the
source file, a GIS-IDs has some special properties which are very helpful in maintaining long term updating of the
model as the data source evolves over time.
In addition, WaterGEMS V8i will intelligently maintain GIS-IDs as you use the various tools to manipulate elements
(Delete, Morph, Split, Merge Nodes in Close Proximity).
When an element with one or more GIS-IDss is deleted, ModelBuilder will not recreate it the next time a
synchronization from your GIS occurs if the "Recreate elements associated with a GIS-IDs that was previously
deleted from the model" option is left unchecked.
When an element with one or more GIS-IDss is morphed, the new element will preserve those GIS-IDss. The
original element will be considered as "deleted with GIS-IDss", which means that it will not be recreated by default
(see above).
When a link is split, the two links will preserve the same GIS-IDss the original pipe had. On subsequent
ModelBuilder synchronizations, any data-change occurring for the associated record in the GIS can be cascaded
into all the split link segments (see Step 4--Additional Options (on page 259)).
When nodes in close proximity are merged, the resulting node will preserve the GIS-IDss of all the nodes that were
removed. On subsequent ModelBuilder synchronizations into the model, if there are data-update conflicts between
the records in the GIS associated with the merged node in the model, updates from the first GIS-IDs listed for the
merged node will be preserved in the model. Note that in this case, the geometry of the merged node can't be
267
updated in the model. For synchronizations going from the model to the GIS, data-updates affecting merged-nodes
can be cascaded into all the associated records in the GIS (see Step 4--Additional Options (on page 259)).
To support these relationship (specifically one to many), GIS-IDs are managed as a collection property (capable of
holding any number of GIS identifiers).
A variety of model element(s) to GIS record(s) associations can be specified:
If the GIS-IDs collection is empty, there is no association between the GIS and this element.
If there is a single entry, this element is associated with one record in the GIS.
If there are multiple entries, this element is associated with multiple records in the GIS.
More than one element in the model can have the same GIS-IDs, meaning multiple records on the model are
associated with a single record in the GIS.
Note: You can also manually edit the GIS-IDs property to review or modify the element to GIS association(s).
GIS-IDs Collection Dialog Box
This dialog box allows you to assign one or more GIS-IDs to the currently selected element.
Specifying a SQL WHERE clause in ModelBuilder
The simplest form of a WHERE clause consists of "Column name - comparison operator - value". For example, if you
want to process only pipes in your data source that are ductile iron, you would enter something like this:
Material = 'Ductile Iron'
String values must be enclosed in single quotes.
Column names are not case sensitive. Column names that contain a space must be enclosed in brackets:
[Pipe Material] = 'Ductile Iron'
268
Brackets are optional for columns names that do not contain a space.
Supported comparison operators are: <, >, <=, >=, <>, =, IN and LIKE.
Multiple logical statements can be combined by using AND, OR and NOT operators. Parentheses can be used to group
statements and enforce precedence.
The * and % wildcard can be used interchangeably in a LIKE statement. A wildcard is allowed at the beginning and/or
end of a pattern. Wildcards are not allowed in the middle of a pattern. For example:
PipeKey LIKE 'P-1*'
is valid, while:
PipeKey LIKE 'P*1'
is not.
Modelbuilder Import Procedures
You can use ModelBuilder to import pump definitions, pump curves, and patterns.
Importing Pump Definitions Using ModelBuilder

Pump definition information can be extracted from an external data source using ModelBuilder.
Most of this importing is accomplished by setting up mappings under the Pump Definition Table Type. However, to
import multipoint head, efficiency or speed vs. efficiency curves, the tabular values must be imported under Table
Types: Pump Definition - Pump Curves, Pump Definition - Flow-Efficiency Curve, and Pump Definition - Speed-
Efficiency Curve respectively.
The list of properties that can be imported under Pump Definition is given below. The only property in the list that is
required is a Key or Label. Most of the properties are numerical values.
BEP Efficiency
BEP Flow
Define BEP Max Flow?
Design Flow
Design Head
GemsID (imported)
Is Variable Speed Drive?
Max Extended Flow
Max Operating Flow
Max Operating Head
Motor Efficiency
Notes
Pump Definition Type (ID)
Pump Definition type (Label)
Pump Efficiency
Pump Efficiency (ID)
Pump Efficiency (Label)
Pump Power
269
Shutoff Head
User Defined BEP Max Flow
Those properties that are text such as Pump Efficiency and Pump Definition Type are alphanumeric and must be
spelled correctly. For example Standard (3 Point) must be spelled exactly as shown in the Pump Definition drop down.
Properties with a question mark above, require a TRUE or FALSE value. Those with ID next to the name are internal
IDs and are usually only useful when syncing out from a model.
To import data, create a table in a data source (e.g. spreadsheet, data base), and then create columns/fields for each of
the properties to be imported. In Excel for example, the columns are created by entering column headings in the first
row of a sheet for each of the properties. Starting with the second row in the table, there will be one row for each pump
definition to be imported.
Once the table is created in the source file, the file must be saved before it can be imported.
In the Specify you data source step in the wizard, the user indicates the source file name and the sheet or table
corresponding to the pump definition data. In the Specify field mappings for each table step, the user selects Pump
Definition as the table type, indicates the name of the pump definition in the Key>Label field and then maps each of the
fields to be imported with the appropriate property in the Attribute drop down.
When syncing out from the model to a data table, the table must contain column headings for each of the properties to
be exported. The names of the columns in the source table do not need to be identical to the property names in the
model.
Importing can best be illustrated with an example. Given the data and graphs for three pump definitions shown in the
graph below, the table below the graph shows the format for the pump curve definition import assuming that a standard
3 point curve is to be used for the head curve and a best efficiency curve is to be used for the efficiency curve. All three
pumps are rated at 120 ft of TDH at 200 gpm.
270
Q, gpm H (red) H (green) H (blue)
0 180 200 160
200 120 120 120
400 40 0 20
BEPe 70 69 65
All three pumps have 95% motor efficiency and a BEP flow of 200.
The data source is created in an Excel spreadsheet.
Label Type Notor Design Design Shutoff Max Q H@ BEP Eff BEP Q Eff Type Variabl
Eff Q H Head Max Q e Speed
Red Standar 95 200 120 180 400 40 70 200 Best False

d (3 Efficien
point) cy Point
Green Standar 95 200 120 200 400 0 69 200 Best False

d (3 Efficien
point) cy Point
Blue Standar 95 200 120 160 400 20 65 200 Best False

d (3 Efficien
point) cy Point
The data source step in ModelBuilder wizard looks like this:
The field mappings should look like the screen below:
271
After the import, the three pumps are listed in the Pump Definitions. The curve for the "Red" pump is shown below:
272
Using ModelBuilder to Import Pump Curves

While most pump definition information can be imported using the Pump Definition Table Type, tabular data
including:
Multipoint pump-head curves,
Multipoint pump-efficiency curves,
and Multipoint speed-efficiency curves
must be imported in their own table types.
To import these curves, first set up the pump definition type either manually in the Pump Definition dialog or by
importing the pump definition through ModelBuilder. The Pump definition type would be Multiple Point, the efficiency
type would be Multiple Efficiency Points or the Is variable speed drive? box would be checked.
In the field mapping step of the ModelBuilder wizard, the user the Table Type, Pump Definition - Pump Curve and
would use the mappings shown below:
273
The example below shows an example of importing a Pump Head Curve. The process and format are analogous for
flow-efficiency and speed-efficiency curves.
For the pump curves shown in the figure below, the data table needed is given. Several pump definitions can be
included in the single table as long as they have different labels.
274
Upon running ModelBuilder to import the table above, three pump definitions would be created. The one called
"Small" is shown below:
275
Using ModelBuilder to Import Patterns

Patterns can be imported into the model from external tables using ModelBuilder. This is a two step process:
1. Description of the pattern
2. Import tabular data
In general, the steps of the import are the same as described in the ModelBuilder documentation. The only steps unique
to patterns are described below. All the fields except the Key/Label fields are optional.
The source data files can be any type of tabular data including spreadsheets and data base tables.
Alphanumeric fields such as those which describe the month or day of the week must be spelled exactly as used in the
model (e.g. January not Jan, Saturday not Sat).
The list of model attributes which can be imported are given below:
Label
MONTH [January, February, etc]
Day [Sunday, Monday, etc]
Pattern category type (Label) [Hydraulic, Reservoir, etc]
Pattern format (Label) [Stepwise - Continuous]
Start time
Starting multiplier
The month and day are the actual month or day of week, not the word "MONTH". Labels must be spelled correctly.
To import patterns, start ModelBuilder, create a new set of instructions, pick the file type, browse to the data file and
pick the tables in that file to be imported. Checking the Show Preview button enables you to view the data before
importing.
276
Then proceed to the Field Mapping step of ModelBuilder to set up the mappings for the Pattern in the Pattern Table
Type. Fields refers to the name in the source table, Attributes refers to the name in the model.
277
And the actual Pattern Curve in the Pattern Curve table type.
The tables below show the pattern definition data and the pattern curve for two stepwise curves labeled Commercial
and Residential. These data must be stored in two different tables although they may be and ideally should be in the
same file.)
278
One of the resulting patterns from this import is shown below:
279
Using ModelBuilder to Import Time Series Data

Time Series data maps onto the following two table types in ModelBuilder: Time Series, and Time Series Collection.
The "Time Series" mapping represents entries in the TreeView along the left of the form (including the simple "Start
Date Time", "Element", and "Notes" values shown on the right). The "Time Series Collection" mapping represents the
tabular data shown in the table at the bottom right of the form.
Export Sample Time Series Data
To automatically determine the appropriate values for handling Pipe Flow time series data, we're going to first export a
sample from WaterGEMS to Excel.
Note: We recommend that you choose MSAccess over MSExcel if possible; there is no explicit way to specify the
data-type of a column in Excel, which can result in some problems.
1. First, create a sample Pipe Flow time series in WaterGEMS .

2. Next, create a new Excel .xls file. We'll need two "sheets" to receive the data (the default "Sheet1" and "Sheet2"
will do).
280
3. Time Series: This is the more difficult of the two Excel sheets we need to set up. To determine the columns to
define in Excel, create a temporary ModelBuilder connection and get to the "Specify Field Mappings" step (you
won't be saving this connection, so to get past Step 1 of the Wizard, just pick any data source). Navigate to this step,
choose the Time Series table type, and click on the "Property" drop-down field.
4. Click on the Sheet1 tab in Excel to define the necessary columns for the "Time Series" table (You don't need all of
these columns for Flow Data, but go ahead and define them all to be sure we don't miss any that are required for
your use-case).
5. Time Series Collection: Again, get to the "Specify Field Mappings" step in ModelBuilder, choose the "Time Series
Collection" table type, and click on the "Property" drop-down field to determine the columns to define.
6. Click on the Sheet2 tab in Excel and define the necessary columns for the "Time Series Collection" table.
7. Save and close your spreadsheet
Define the ModelBuilder Connection
Now we're ready to create the ModelBuilder connection to this spreadsheet
1. Open ModelBuilder and create a new Connection. In step 1 of the Wizard, choose "Excel" as the data source type,
browse to the Excel spreadsheet that you created to select it. You should see Sheet1 and Sheet2 in the list of
available tables, select those (and unselect any others that appear).
2. Navigate through the next few steps, just use the defaults there.
3. When you reach the Mapping Step, set things up for Sheet1 and Sheet2.
4. Navigate to the end of the Wizard.
5. On the last step, click "No" for the "Would you like to build a model now?" prompt and click [Finish].
Synchronize Out from ModelBuilder
1. Choose the connection you just defined (be sure to close the Excel spreadsheet you just defined), and click the Sync
Out toolbar button.
2. The sample time series data from WaterGEMS will now be available in the Excel spreadsheet you created. Using
that as a go-by, you should be able to enter the data in the appropriate format to import in to WaterGEMS .
Oracle as a Data Source for ModelBuilder
WaterGEMS V8i makes it possible to import data to create a model from an Oracle database. To use this database, the
user must have Oracle 11g Client software installed on the same computer in which WaterGEMS V8i is running and it
must be connected t the Oracle Server.
The user needs to understand the nature of the data stored in Oracle and the way it is stored. For example, the user must
know if the data are stored as simple tabular data or whether the data are spatial data associated with polygons, lines,
and points. The user needs to decide which fields in the database are to be imported into WaterGEMS V8i.
It is possible to connect to an Oracle database from WaterGEMS V8i using any supported CAD/GIS platform. Start
ModelBuilder the same as with any other data source (see ModelBuilder Connections Manager (on page 251)).
However, when the user browses for a data source some additional information is required.
When the user Browses for an Oracle datasource, ModelBuilder opens an Oracle login form. The user can enter just a
service name if they have setup an alias on their system for the Oracle datasource. The user should contact their
administrator for details on how to setup this alias. Otherwise, the user must enter all of the connection information,
which includes the computer/host that Oracle is running on, the network port number that Oracle is using, and the raw
Oracle service name. Again, the user should contact their administrator for those details. The user must also supply a
valid Oracle username and password to log into the data source.
281
Applying Elevation Data with TRex
On the mapping form in ModelBuilder, there is a Generator (Sync out) combo-box. The user only needs to select a
sequence generator in this box if they plan to sync out to Oracle and have ModelBuilder create new records in Oracle.
The Oracle sequence generator is an object that is created in Oracle by the administrator. It allows Oracle to create
records with unique Oracle identifiers, which is may be required when creating new records. ModelBuilder will display
the available sequence generators that are available for use.
Oracle/ArcSDE Behavior
If creating a ModelBuilder connection to an ArcSDE data source, you can always use the Geodatabase and/or
Geometric Network connection types when running in the ArcGIS platform. If the ArcSDE has an Oracle database as
the back end data store, and ArcSDE has been configured to use Oracle's native geometry type (i.e.
SDO_GEOMETRY), you can also use the Oracle connection in ModelBuilder to interact directly with the Oracle data,
which has the benefit of being an option in any platform, such as Microstation. However you should not synchronize
data from the model out to the Oracle connection if it's the back end of an ArcSDE data source, as that may cause
problems for the ArcSDE.

To learn more about applying elevation data using TRex, click the links below:
The Importance of Accurate Elevation Data
Obtaining node elevation data for input into a water distribution model can be an expensive, time-consuming process.
In some cases, very accurate elevation data may be critical to the models utility; in other cases it can represent a
significant resource expenditure. In order to decide on the appropriate level of quality of elevation data to be gathered,
it is important to understand how a model uses this data.
Elevation data for nodes is not directly used in solving the network equations in hydraulic models. Instead, the models
solve for hydraulic grade line (HGL). Once the HGL is calculated and the numerical solution process is essentially
completed, the elevations are then used to determine pressure using the following relationship:
282
p = pressure (lb./ft. 2 , N/m 2 )
HGL = hydraulic grade line (ft., m)
z = node elevation (ft., m)
= density of water (slugs/ft.

3 , kg/m 3 )
g = gravitational acceleration
(ft./sec. 2 , m/sec. 2 )
If the modeler is only interested in calculating flows, velocities, and HGL values, then elevation need not be specified.
In this case, the pressures at the nodes will be computed assuming an elevation of zero, thus resulting in pressures
relative to a zero elevation.
If the modeler specifies pump controls or pressure valve settings in pressure units, then the model needs to compute
pressures relative to the elevation of the nodes being tested. In this case, the elevation at the control node or valve
would need to be specified (or else the model will assume zero elevation). Therefore, an accurate elevation value is
required at each key node where pressure is of importance.
Numerical Value of Elevation
The correct elevation of a node is the elevation at which the modeler wants to know the pressure. The relationship
between pressure and elevation is illustrated as follows:
Notice that an HGL of 400 ft. calculated at the hydrant is independent of elevation. However, depending on which
elevation the modeler entered for that node, the pressure can vary as shown. Usually modelers use ground elevation as
the elevation for the node.
Accuracy and Precision
283
How accurate must the elevation data be? The answer depends on the accuracy desired in pressure calculations vs. the
amount of labor and cost allotted for data collection. For example, the HGL calculated by the model is significantly
more precise than any of the elevation data. Since 2.31 ft.of elevation translates into 1 psi of pressure (for water),
calculating pressure to 1 psi precision requires elevation data that is accurate to roughly 2 ft. Elevation data that is
accurate to the nearest 10 ft. will result in pressure that is accurate to roughly 4 psi.
The lack of precision in elevation data (and pressure results) also leads to questions regarding water distribution design.
If design criteria state that pressure must exceed 20 psi and the model gives a pressure of 21 (+/- 4) psi or 19 (+/-4) psi,
the engineer relying on the model will have to decide if this design is acceptable.
Obtaining Elevation Data
In building the large models that are used today, collecting elevation data is often a time-consuming process. A good
modeler wants to devote the appropriate level of effort to data collection that will yield the desired accuracy at a
minimum cost. Some of the data collection options are:
USGS Topographic Maps
Surveying from known benchmarks
Digital Elevation Models (DEMs)
SDTS Digital Elevation Models
Digital Ortho-Rectified Photogrammetry
Contour Maps (contour shapefiles)
As-built Plans
Global Positioning Systems (GPS).
The data type used by the Elevation Extractor is Digital Elevation Models (DEMs). Digital Elevation Models, available
from the USGS, are computer files that contain elevation data and routines for interpolating that data to arrive at
elevations at nearby points. DEM data are recorded in a raster format, which means that they are represented by a
uniform grid of cells of a specified resolution (typically 100 ft.). The accuracy of points interpolated from the grid
depends on the distance from known benchmarks and is highly site-specific. However, it is usually on the order of 5 to
10 ft. when the ground slopes continuously. If there are abrupt breaks in elevation corresponding to road cuts, levees,
and cliffs, the elevations taken from the DEMs can be inaccurate.
DEMs are raster files containing evenly spaced elevation data referenced to a horizontal coordinate system. In the
United States, the most commonly used DEMs are prepared by the U.S. Geological Survey (USGS). Horizontal
position is determined based on the Universal Transverse Mercator coordinate system referenced to the North
American Datum of 1927 (NAD 27) or 1983 (NAD 83), with distances given in meters. In the continental U.S.,
elevation values are given in meters (or in some cases feet) relative to the National Geodetic Vertical Datum (NGVD)
of 1929.
DEMs are available at several scales. For water distribution, it is best to use the 30-meter DEMs with the same spatial
extents as the 7.5-minute USGS topographic map series. These files are referred to as large-scale DEMs. The raster
grids for the 7.5-minute quads are 30 by 30 meters. There is a single elevation value for each 900 square meters. (Some
maps are now available with grid spacing as small as 10 by 10 meters, and more are being developed.) Ideally, some
interpolation is performed to determine the elevation value at a given point. The DEMs produce the best accuracy in
terms of point elevations in areas that are relatively flat with smooth slopes but have poorer accuracy in areas with
large, abrupt changes in elevation, such as cliffs and road cuts.
The Spatial Data Transfer Standard, or SDTS, is a standard for the transfer of earth-referenced spatial data between
dissimilar computer systems. The SDTS provides a solution to the problem of spatial data transfer from the conceptual
level to the details of physical file encoding. Transfer of spatial data involves modeling spatial data concepts, data
284
structures, and logical and physical file structures. In order to be useful, the data to be transferred must also be
meaningful in terms of data content and data quality. SDTS addresses all of these aspects for both vector and raster data
structures.
The SDTS spatial data model can be made up of more than one spatial object (referred to as aggregated spatial objects),
which can be thought of as data layers in the Point or Topological Vector profiles. A Raster Profile can contain multiple
raster object record numbers, which are part of the RSDF module of a Raster Profile data set. Multiple raster object
record numbers must be converted into separate grids by converting each raster object record number one at a time into
an Output grid.
LIDAR is relatively new technology which determines elevation using a light signal from an airplane. LIDAR elevation
data is collected using an aerial transmitter and sensor and is significantly more accurate and expensive than traditional
DEM data. LIDAR data can be produced in a DEM format and is becoming more widely available.
Record Types
USGS DEM files are organized into these record types:

Type A records contain information about the DEM, including name, boundaries, and units of measure.
Type B records contain elevation data arranged in profiles from south to north, with the profiles organized from
west to east.
Type C records contain statistical information on the accuracy of the DEM.
There is one Type A and one Type C record for each DEM. There is one Type B record for each south-north profile.
DEMs are classified by the method with which they were prepared and the corresponding accuracy standard. Accuracy
is measured as the root mean square error (RMSE) of linearly interpolated elevations from the DEM compared to
known elevations. The levels of accuracy, from least accurate to most accurate, are described as follows:
Level One DEMs are based on high altitude photography and have a vertical RMSE of 7 meters and a maximum
permitted RMSE of 15 meters.
Level Two DEMs are based on hypsographic and hydrographic digitizing with editing to remove identifiable errors.
The maximum permitted RMSE is one-half of the contour interval.
Level Three DEMs are based on digital line graphs (DLG) and have a maximum RMSE of one-third of the contour
interval.
DEMs will not replace elevation data obtained from field-run surveys, high-quality global positioning systems, or even
well-calibrated altimeters. They can be used to avoid potential for error which can be involved in manually
interpolating points.
Calibration Nodes
An elevation accuracy of 5 ft. is adequate for most nodes; therefore, a USGS topographic map is typically acceptable.
However, for nodes to be used for model calibration, a higher level of accuracy is desirable. Consider a situation where
both the model and the actual system have exactly the same HGL of 800 ft. at a node (see figure below). The elevation
of the ground (and model node) is 661.2 ft. while the elevation of the pressure gage used in calibration is 667.1 ft. The
model would predict a pressure of 60.1 psi while the gage would read 57.5 psi even though the model is correct.
285
A similar error could occur in the opposite direction with an incorrect pressure appearing accurate because an incorrect
elevation is used. This is one reason why model calibration should be done by comparing modeled and observed HGL
values and not pressures.
TRex Terrain Extractor
The TRex Terrain Extractor was designed to expedite the elevation assignment process by automatically assigning
elevations to the model features according to the elevation data stored within Digital Elevation Models.
Digital Elevation Models were chosen because of their wide availability and since a reasonable level of accuracy can be
obtained by using this data type depending on the accuracy of the DEM/DTM.
The TRex Terrain Extractor can quickly and easily assign elevations to any or all of the nodes in the water distribution
model. All that is required is a valid Digital Elevation Model. Data input for TRex consists of:
1. Specify the GIS layer that contains the DEM from which elevation data will be extracted.
2. Specify the measurement unit associated with the DEM (feet, meters, etc.).
3. Select the model features to which elevations should be applied; all model features or a selection set of features can
be chosen.
TRex then interpolates an elevation value for each specific point occupied by a model feature. The final step of the
wizard displays a list of all of the features to which an elevation was applied, along with the elevation values for those
features. These elevation values can then be applied to a new physical properties alternative, or an existing one. In some
cases, you might have more accurate information for some nodes (e.g., survey elevation from a pump station). In those
cases, you should create the elevation data using DEM data and manually overwrite the more accurate data for those
nodes.
The TRex Terrain Extractor simplifies the process of applying accurate elevation data to water distribution models. As
was shown previously, accurate elevation data is vital when accurate pressure calculations and/or pressure-based
controls are required for the water distribution model in question. All elevation data for even large distribution
networks can be applied by completing a few steps.
In the US, DEM data is usually available in files corresponding to a single USGS 7.5 minute quadrangle map. If the
model covers an area involving several maps, it is best to mosaic the maps into a single map using the appropriate GIS
functions as opposed to applying TRex separately for each map.
When using TRex, it is necessary that the model and the DEM be in the same coordinate system. Usually the USGS
DEMs are in the UTM (Universal Transverse Mercator) with North American Datum 1983 (NAD83) in meters,
although some may use NAD27. Models are often constructed using a state plane coordinate system in feet. Either the
286
model or DEM must be converted so that the two are in the same coordinate system for TRex to work. Similarly, the
vertical datum for USGS is based on national Vertical Geodetic Datum of 1929. If the utility has used some other
datum for vertical control, then these differences need to be reconciled.
The TRex Terrain Extractor can read the USGS DEM raster data in SDTS format. Raster profiles provide a flexible
way to encode raster data. The SDTS standard contains small limited subsets called profiles. In a raster transfer, there
should be one RSDF module, one LDEF module and one or more cell modules. Each record in the RSDF module
denotes one raster object. Each raster object can have multiple layers. Each layer is encoded as one record in the LDEF
module. The actual grid data is stored in the cell module which is referenced by the layer record. A typical USGS DEM
data set contains one RSDF record, one LDEF record and one cell file.
TRex Wizard
The TRex Wizard steps you through the process of automatically assigning elevations to specified nodes based on data
from a Digital Elevation Model or a Digital Terrain Model.
TRex can load elevation data into model point features (nodes) from a variety of file types including both vector and
raster files. To use raster files as the data source, the ArcGIS platform must be used. With a vector data source, it is
possible to use any platform. Vector data must consist of either points with an elevation or contours with an elevation.
It is important to understand the resolution, projection, datum, units and accuracy of any source file that will be used to
load elevation data for nodes.
In the United States, elevation data can be obtained at the USGS National Map Seamless Server. The vertical accuracy
may only be +/- 7 to 15 m.
Step 1: File Selection
The elevation data source and features to which elevations will be assigned are specified in the File Selection dialog of
the TRex wizard. Valid elevation data sources include:
Vector files such as DXF and SHP files
LandXML files
InRoads .dtm (Microstation platform only)
Geopack .tin (32-bit version only)
Bentley MX .fil
Bentley .dgn (Microstation platform only)
DXF files are able to contain both points and lines, therefore the user must indicate whether the node elevations should
be built based on the points in the DXF, or based on the contour lines in the DXF.
Shapefiles are not allowed to contain mixed geometric data, so TRex can safely determine whether to build the
elevation map based on either elevation point data or elevation contour lines. The Model Spot Elevation data source
type uses existing spot elevation nodes in the model, which must already have correct elevation values assigned. Using
these as the data source, TRex can determine the elevations for the other nodes in the model.
Bentley MX (.fil) files can contain multiple terrain models; you must select a single model to use as the elevation data
source.
When running under the ArcGIS platform, additional raster data sources are also available for direct use in TRex,
including TIN, Rasters(grid), USGS(DEM), and SDTS(DDF) files.
These data sources are often created in a specific spatial reference, meaning that the coordinates in the data source will
be transformed to a real geographic location using this spatial reference. Care must be taken when laying out the model
to ensure that the model coordinates, when transformed by the model's spatial reference (if applicable), will overlay the
287
elevation data source in this 'global' coordinate system. If the model and elevation data source's data don't overlay each
other, TRex will be unable to interpolate elevation data. GIS products such as Bentley Map and ArcGIS can be used to
transform raster source data into a spatial reference that matches that of the model.
If you are unable to run TRex under ArcGIS (i.e. you are using stand-alone or a CAD platform), ArcGIS can generally
be used to convert the raster data to a point shapefile that approximates the raster data source. Shapefiles can be always
be used in TRex, regardless of the platform that TRex is running.
Data Source TypeThis menu allows you to choose the type of file that contains the input data you will use.
FileThis field displays the path where the data file is located. Use the browse button to find and select the desired
file.
Spatial Reference (ArcGIS Mode Only)Click the Ellipsis (...) next to this field to open the Spatial Reference
Properties dialog box, allowing you to specify the spatial reference being used by the elevation data file.
Select Elevation FieldSelect the elevation unit.
X-Y UnitsThis menu allows the selection of the measurement unit type associated with the X and Y coordinates
of the elevation data file.
288
Z UnitsThis menu allows the selection of the measurement unit type associated with the Z coordinates of the
elevation data file.
Clip Dataset to ModelIn some cases, the data source contains elevation data for an area that exceeds the
dimensions of the area being modeled. When this box is checked, TRex will calculate the models bounding box,
find the larger dimension (width or height), calculate the Buffering Percentage of that dimension, and increase both
the width and height of the model bounding box by that amount. Then any data point that falls outside of the new
bounding box will not be used to generate the elevation mesh. If this box isnt checked, all the source data points are
used to generate the elevation mesh. Checking this box should result in faster calculation speed and use less
memory.
Buffering PercentageThis field is only active when the Clip Dataset to Model box is checked. The percentage
entered here is the percentage of the larger dimension (width or height) of the models bounding box that will be
added to both the bounding box width and height to find the area within which the source data points will be used to
build the elevation mesh.
Spatial Reference (ArcGIS Mode Only)Click the Ellipsis (...) next to this field to open the Spatial Reference
Properties dialog box, allowing you to specify the spatial reference being used by the WaterGEMS V8i model file.
Also update inactive elementsCheck this box to include inactive elements in the elevation assignment operation.
When this box is unchecked, elements that are marked Inactive will be ignored by TRex.
AllWhen this button is selected, TRex will attempt to assign elevations to all nodes within the WaterGEMS V8i
model.
SelectionWhen this button is selected, TRex will attempt to assign elevations to all currently highlighted nodes.
Selection SetWhen this is selected, the Selection Set menu is activated. When the Selection Set button is selected,
TRex will assign elevations to all nodes within the selection set that is specified in this menu.
Note: If the WaterGEMS V8i model (which may or may not have a spatial reference explicitly associated with it)
is in a different spatial reference than the DEM/DTM (which does have a spatial reference explicitly associated
with it), then the features of the model will be projected from the models spatial reference to the spatial
reference used by the DEM/DTM.
Step 2: Completing the TRex Wizard

The results of the elevation extraction process are displayed and the results can be applied to a new or existing physical
alternative.
289
Results Preview PaneThis tabular pane displays the elevations that were calculated by TRex. The table can be
sorted by label by clicking the Label column heading and by elevation by clicking the Elevation column heading.
You can filter the table by right-clicking a column in the table and selecting the Filter...Custom command. You can
also right-click any of the values in the elevation column to change the display options.
Use Existing AlternativeWhen this is selected, the results will be applied to the physical alternative that is
selected in the Use Existing Alternative menu. This menu allows the selection of the physical alternative to which
the results will be applied.
New Alternative When this is selected, the results will be applied to a new physical alternative. First, the
currently active physical alternative will be duplicated, then the results generated by TRex will be applied to the
newly created alternative. The name of this new alternative must be supplied in the New Alternative text field.
Parent AlternativeSelect an alternative to duplicate from the menu, or select <None> to create a new Base
alternative.
Export ResultsThis exports the results generated by TRex to a tab or comma-delimited text file (.TXT). These
files can then be re-used by WaterGEMS V8i or imported into other programs.
Click Finish when complete, or Cancel to close without making any changes.
290
Allocating Demands using LoadBuilder
TRex Supported Terrain Models

TRex can import terrain models created in InRoads, MXROAD or GEOPAK, however not all terrain model types are
currently supported on all platforms. The following table shows which terrain models are supported in each
WaterGEMS/WaterCAD/HAMMER platform.:
Table 1: Table 6-1: TRex Supported Terrain Models
Platform InRoads GEOPAK Bentley MX
Stand Alone x86 No Yes Yes
Stand Alone x64 No Partial No
Microstation Yes Yes Yes
AutoCAD x86 No Yes Yes
AutoCAD x64 No Partial No
ArcGIS No Yes Yes

To learn more about allocating demands using LoadBuilder, click the links below:
Using GIS for Demand Allocation
The consumption of water is the driving force behind the hydraulic dynamics occurring in water distribution systems.
When simulating these dynamics in your water distribution model, an accurate representation of system demands is as
critical as precisely modeling the physical components of the model.
To realize the full potential of the model as a master planning and decision support tool, you must accurately allocate
demands while anticipating future demands. Collecting the necessary data and translating it to model loading data must
be performed regularly to account for changes to the network conditions. Due to the difficulties involved in manually
loading the model, automated techniques have been developed to assist the modeler with this task.
Spatial allocation of demands is the most common approach to loading a water distribution model. The spatial analysis
capabilities of GIS make these applications a logical tool for the automation of the demand allocation process.
LoadBuilder leverages the spatial analysis abilities of your GIS software to distribute demands according to geocoded
meter data, demand density information, and coverage polygon intersections.
LoadBuilder greatly facilitates the tasks of demand allocation and projection. Every step of the loading process is
enhanced, from the initial gathering and analysis of data from disparate sources and formats to the employment of
various allocation strategies.
The following are descriptions of the types of allocation strategies that can be applied using LoadBuilder.
291
Allocation
This uses the spatial analysis capabilities of GIS to assign geocoded (possessing coordinate data based on physical
location, such as an x-y coordinate) customer meters to the nearest demand node or pipe. Assigning metered demands
to nodes is a point-to-point demand allocation technique, meaning that known point demands (customer meters) are
assigned to network demand points (demand nodes). Assigning metered demands to pipes is also a point-to-point
assignment technique, since demands must still be assigned to node elements, but there is an additional step involved.
When using the Nearest Pipe meter assignment strategy, the demands at a meter are assigned to the nearest pipe. From
the pipe, the demand is then distributed to the nodes at the ends of the pipe by utilizing a distribution strategy. Meter
assignment is the simplest technique in terms of required data, because there is no need for service polygons to be
applied (see Figure below).
Meter assignment can prove less accurate than the more complex allocation strategies because the nearest node is
determined by straight-line proximity between the demand node and the consumption meter. Piping routes are not
considered, so the nearest demand node may not be the location from which the meter actually receives its flow. In
addition, the actual location of the service meter may not be known.
The geographic location of the meter in the GIS is not necessarily the point from which water is taken from the system,
but may be the centroid of the land parcel, the centroid of building footprint, or a point along the frontage of the
building. Ideally, these meter points should be placed at the location of the tap, but the centroid of the building or land
parcel may be all that is known about a customer account.
Note: In LoadBuilder, the Nearest Node and Nearest Pipe strategies are also in the Allocation loading method.
292
Billing Meter Aggregation

Billing Meter aggregation is the technique of assigning all meters within a service polygon to a specified demand node
(see Figure below). Service polygons define the service area for each of the demand nodes.
Meter Aggregation is a polygon-to-point allocation technique, because the service areas are contained in a GIS polygon
layer, while again, the demand nodes are contained in a point layer. The demands associated with the meters within
each of the service area polygons is assigned to the respective demand node points.
Due to the need for service polygons, the initial setup for this approach is more involved than the meter assignment
strategy, the trade-off being greater control over the assignment of meters to demand nodes. Automated construction of
the service polygons may not produce the desired results, so it may be necessary to manually adjust the polygon
boundaries, especially at the edges of the drawing.
Note: In LoadBuilder, the Billing Meter Aggregation strategy falls into the meter aggregation category of loading
methods.
Distribution
This strategy involves distributing lump-sum area water use data among a number of service polygons (service areas)
and, by extension, their associated demand nodes. The lump-sum area is a polygon for which the total (lump-sum)
water use of all of the service areas (and their demand nodes) within it is known (metered), but the distribution of the
total water use among the individual nodes is not. The water use data for these lump-sum areas can be based on system
293
meter data from pump stations, treatment plants or flow control valves, meter routes, pressure zones, and traffic
analysis zones (TAZ). The lump sum area for which a flow is known must be a GIS polygon. There is one flow rate per
polygon, and there can be no overlap of or open space between the polygons.
The known flow within the lump-sum area is generally divided among the service polygons within the area using one
of two techniques: equal distribution or proportional distribution:
The equal flow distribution option simply divides the known flow evenly between the demand nodes. The equal
flow distribution strategy is illustrated in the diagram below. The lump-sum area in this case is a polygon layer that
represents meter route areas. For each of these meter route polygons, the total flow is known. The total flow is then
equally divided among the demand nodes within each of the meter route polygons (See Figure).
The proportional distribution option (by area or by population) divides the lump-sum flow among the service
polygons based upon one of two attributes of the service polygons-the area or the population. The greater the
percentage of the lump-sum area or population that a service polygon contains, the greater the percentage of total
flow that will be assigned to that service polygon.
Note: In addition to the distribution options listed above, LoadBuilder allows Nearest node and Farthest node
strategies as well.
Each service polygon has an associated demand node, and the flow that is calculated for each service polygon is
assigned to this demand node. For example, if a service polygon consists of 50 percent of the lump-sum polygon's area,
then 50 percent of the flow associated with the lump-sum polygon will be assigned to the demand node associated with
that service polygon. This strategy requires the definition of lump-sum area or population polygons in the GIS, service
polygons in the model, and their related demand nodes. Sometimes the flow distribution technique must be used to
assign unaccounted-for-water to nodes, and when any method that uses customer metering data as opposed to system
metering data is implemented. For instance, when the flow is metered at the well, unaccounted-for-water is included;
when the customer meters are added together, unaccounted-for-water is not included.
Note: In LoadBuilder, the Equal Flow Distribution, Proportional Distribution by Area, and Proportional
Distribution by Population strategies fall within the flow distribution category of loading methods.
In the following figure, the total demand in meter route A may be 55 gpm (3.48 L/s) while in meter route B the demand
is 72 gpm (4.55 L/s). Since there are 11 nodes in meter route A, if equal distribution is used, the demand at each node
would be 5 gpm (0.32 L/s), while in meter route B, with 8 nodes, the demand at each node would be 9 gpm (0.57 L/s).
294
Point Demand Assignment

A point demand assignment technique is used to directly assign a demand to a demand node. This strategy is primarily
a manual operation, and is used to assign large (generally industrial or commercial) water users to the demand node that
serves the consumer in question. This technique is unnecessary if all demands are accounted for using one of the other
allocation strategies
Projection
Automated techniques have also been developed to assist in the estimation of demands using land use and population
density data. These are similar to the Flow Distribution allocation methods except that the type of base layer that is
used to intersect with the service layer may contain information other than flow, such as land use or population.
This type of demand estimation can be used in the projection of future demands; in this case, the demand allocation
relies on a polygon layer that contains data regarding expected future conditions. A variety of data types can be used
with this technique, including future land use, projected population, or demand density (in polygon form), with the
polygons based upon traffic analysis zones, census tracts, planning districts, or another classification. Note that these
data sources can also be used to assign current demands; the difference between the two being the data that is contained
within the source. If the data relates to projected values, it can be used for demand projections.
Many of these data types do not include demand information, so further data conversion is required to translate the
information contained in the future condition polygons into projected demand values. This entails translating the data
contained within your data source to flow, which can then be applied using LoadBuilder.
After an appropriate conversion method is in place, the service layer containing the service areas and demand nodes is
overlaid with the future condition polygon layer(s). A projected demand for each of the service areas can then be
determined and assigned to the demand nodes associated with each service polygon. The conversion that is required
295
will depend on the source data that is being used. It could be a matter of translating the data contained within the
source, such as population, land area, etc. to flow, which can then be used by LoadBuilder to assign demands.
Depending on how the layers intersect, service areas may contain multiple demand types (land uses) that are added and
applied to the demand node for that service polygon.
Using LoadBuilder to Assign Loading Data
LoadBuilder simplifies and expedites the process of assigning loading data to your model, using a variety of source
data types.
Note: The loading output data generated by LoadBuilder is a Base Flow, i.e., a single value that remains constant
over time. After running LoadBuilder and exporting the results, you may need to modify your data to reflect
changes over time by applying patterns to the base flow values.
LoadBuilder Manager
The LoadBuilder manager provides a central location for the creation, storage, and management of Load Build
templates.
To open the Loadbuilder manager, go to Tools > Loadbuilder or click
The following controls are available in this dialog box:
296
Opens the LoadBuilder Wizard.

New
Deletes an existing LoadBuilder template.

Delete
Renames an existing LoadBuilder template.

Rename
Opens the LoadBuilder Wizard with the settings

associated with the currently highlighted definition
Edit
loaded.
Opens the context-sensitive online help.

Help
LoadBuilder Wizard
The LoadBuilder wizard assists you in the creation of a new load build template by stepping you through the procedure
of creating a new load build template. Depending on the load build method you choose, the specific steps presented in
the wizard will vary.
Note: The loading output data generated by LoadBuilder is a Base Flow, i.e., a single value that remains constant
over time.
After running LoadBuilder and exporting the results, you may need to modify your data to reflect changes over time by
applying patterns to the base flow values.
LoadBuilder wizard includes:
Step 1: Load Method to Use (on page 297)
Step 2: Input Data (on page 299)
Step 3: Calculation Summary (on page 303)
Step 4: Results Preview (on page 303)
Step 5: Completing the LoadBuilder Wizard (on page 303)
Step 1: Load Method to Use

In this step, the Load Method to be used is specified. The next steps will vary according to the load method that is
chosen. The load methods are divided into three categories; the desired category is selected by clicking the
corresponding button. Then the method is chosen from the Load Demand types pane.
The available load methods are as follows:
Allocation
Billing Meter AggregationThis loading method assigns all meters within a service polygon to the specified
loading node for that service polygon.
297
Nearest NodeThis loading method assigns customer meter loads to the closest loading junction.
Nearest PipeThis loading method assigns customer meter loads to the closest pipe, then distributes loads using
user-defined criteria.

Flow Monitoring DistributionThis loading method asigns loading data from a point load monitoring layer to
upstream loading nodes. This method automatically identifies all the upstream manholes up to its adjacent next
upstream load monitor, works out the sub-total load contribution of the manhole between the load monitors (the
load difference between the monitors) and then equally distributes the effective load to all the contributing
manholes.

Distribution
Equal Flow DistributionThis loading method equally divides the total flow contained in a flow boundary polygon
and assigns it to the nodes that fall within the flow boundary polygon.
298
Proportional Distribution by AreaThis load method proportionally distributes a lump-sum load among a number
of loading nodes based upon the ratio of total service area to the area of the nodes corresponding service polygon.
Proportional Distribution by PopulationThis load method proportionally distributes a lump-sum load among a
number of loading nodes based upon the ratio of total population contained within the nodes corresponding service
polygon.
Projection
Projection by Land UseThis method allocates loads based upon the density per land use type of each service
polygon.
Load Estimation by PopulationThis method allocates loads based upon user-defined relationships between load
per capita and population data.
In addition to the controls described above, there is also a check box and a menu near the bottom of the dialog box,
entitled Initialize From Previous Run. If a previously created LoadBuilder template exists in the LoadBuilder Manager
display, the settings for this template can be applied to a new LoadBuild of the same type.
Step 2: Input Data

This step will vary according to the load method type that was specified in Step 1, as follows:
299
Billing Meter AggregationInput DataThe following fields require data to be specified:

Service Area LayerThis field allows you to specify the polygon feature class or shapefile that defines the service
area for each demand node.
Manhole ID FieldThis field allows you to specify the source database field that contains identifying label data.
ElementID is the preferred Junction ID value because it is always unique to any given element.
Billing Meter LayerThis field allows you to specify the point feature class or shapefile that contains the geocoded
billing meter data.
Load Type FieldThis field allows you to specify the source database field that contains load type data. Load Type
is an optional classification that can be used to assign composite loads to nodes, which enables different behaviors,
multipliers, and patterns to be applied in various situations. For example, possible load types may include
Residential, Commercial, Industrial, etc. To make use of the Load Type classification, your source database must
include a column that contains this data.
Usage FieldThis field allows you to specify the source database field that contains usage data. The usage field in
the source database must contain flow data.
Usage Field UnitsThis drop-down list allows you to select the unit associated with the usage field value.
Nearest NodeInput DataThe following fields require data to be specified:
Node LayerThis field allows you to specify the feature class or shapefile that contains the nodes that the loads
will be assigned to.
Node ID FieldThis field allows you to specify the feature class database field that contains the unique identifying
label data. ElementID is the preferred node ID value because it is always unique to any given element.
Billing Meter LayerThis field allows you to specify the feature class or shapefile that contains the geocoded
billing meter data.
Usage FieldThis field allows you to specify the source database field that contains usage data.
Use Previous RunLoadBuilders most time-consuming calculation when using the Nearest Node strategy is the
spatial calculations that are performed to determine proximity between the meter elements and the node elements.
When this box is checked, the proximity calculations that were generated from a previous run are used, thereby
increasing the overall calculation performance.
Nearest PipeInput DataThe following fields require data to be specified:
Pipe LayerThis field allows you to specify the line feature class or shapefile that contains the pipes that will be
used to determine meter-to-pipe proximity. Note that the pipes in this layer must connect to the nodes contained in
the Node Layer.
Pipe ID FieldThis field allows you to specify the source database field that contains the unique identifying label
data. ElementID is the preferred Pipe ID value because it is always unique to any given element.
Load AssignmentThis field allows you to specify the method that will be used to distribute the metered loads that
are assigned to the nearest pipe to the end nodes of said pipe. Options include:
Distance WeightedThis method assigns a portion of the total load assigned to a pipe based on the distance
between the meter(s) and the nodes at the pipe ends. The closer a meter is to the node at the end of the pipe, the
more load will be assigned to it.
Closest NodeThis method assigns the entire total load assigned to the pipe end node that is closest to the meter.
Farthest NodeThis method assigns the entire total load assigned to the pipe end node that is farthest from the
meter.
Equal DistributionThis method assigns an equal portion of the total load assigned to a pipe to each of the pipes
end nodes.
300
Node LayerThis field allows you to specify the point feature class or shapefile that contains the nodes that will be
used to determine node-to-pipe proximity. Note that the nodes in this layer must connect to the pipes contained in
the Pipes Layer.
Node ID FieldThis field allows you to specify the source database field that contains the unique identifying label
data. ElementID is the preferred Junction ID value because it is always unique to any given element.
Use Previous RunLoadBuilders most time-consuming calculation when using the Nearest Pipe strategy is the
spatial calculations that are performed to determine proximity between the meter elements, the pipe elements, and
the node elements. When this box is checked, the proximity calculations that were calculated from a previous runs
are used, thereby increasing the overall calculation performance.
Billing Meter LayerThis field allows you to specify the point or polyline feature class or shapefile that contains
the geocoded billing meter data.
Meter Assignment TypeWhen a polyline meter layer is selected, this field will be activated. When multiple pipes
are associated with (overlapped by) a polyline meter, the option chosen in this field determines the method that will
be used to divide the polyline meter load among them. The available options are:
Equal DistributionThis option will distribute the load equally among the pipes associated with (overlapping) the
meter.
Proportional DistributionThis option will divide the load proportionally according to the ratio of the length of
pipe that is associated with (overlapping) the meter to the total length of the meter.
Billing Meter ID FieldBilling Meter ID is used to identify the unique meter. When polylines are used to represent
water consumption meters, multiple polylines (multiple records) may designate one actual meter, but each (record in
the attribute Table) of the polylines contains the same consumption data with the same billing meter ID.
Usage FieldThis field allows you to specify the source database field that contains usage data.
Flow Monitoring DistributionInput DataThe following fields require data to be specified:
Node LayerThis field allows you to specify the point feature class or shapefile that contains the nodes that the
flow will be assigned to.
Node ID FieldThis field allows you to specify the source database field that contains identifying label data.
ElementID is the preferred Node ID value because it is always unique to any given element.
Flow Monitoring LayerThis field allows you to specify the point feature class that contains the flow monitoring
meter data.
Usage FieldThis field allows you to specify the source database field that contains usage data. The usage field in
the source database must contain flow data.
Equal Flow DistributionInput DataThe following fields require data to be specified:
Manhole LayerThis field allows you to specify the point feature class or shapefile that contains the manhole data.
Flow Boundary LayerThis field allows you to specify the polygon feature class or shapefile that contains the flow
boundary data.
Load Type FieldThis field allows you to specify the source database field that contains the Load Type data.
Load Type Field UnitsThis drop-down list allows you to select the unit associated with the flow field value.
Proportional Distribution by AreaInput DataThe following fields require data to be specified:
301
area for each node.
Manhole ID FieldThis field allows you to specify the source database field that contains the unique identifying
label data. ElementID is the preferred Junction ID value because it is always unique to any given element.
boundary data.
Boundary FieldThis field allows you to specify the source database field that contains the boundary label.
Flow FieldThis field allows you to specify the source database field that contains the load type data.
Flow Field UnitsThis drop-down list allows you to select the unit associated with the Load Type Field value.
Proportional Distribution by PopulationInput DataThe following fields require data to be specified:
area for each node.
boundary data.
Boundary FieldThis field allows you to specify the source database field that contains the boundary label.
Load Type FieldThis field allows you to specify the source database field that contains the load data.
Load Type Field UnitsThis drop-down list allows you to select the unit associated with the load type field value.
Population LayerThis field allows you to specify the polygon feature class or shapefile that contains population
data.
Population ID FieldThis field allows you to specify the source database field that contains population data.
Land Type FieldThis field is optional. It allows you to specify the source database field that contains land use
type.
Projection by Land UseInput DataThe following fields require data to be specified:
area for each node.
Land Use LayerThis field allows you to specify the polygon feature class or shapefile that contains the land use
data.
Land Type FieldThis field is optional. It allows you to specify the source database field that contains land use
type.
Load Densities Per AreaThis table allows you to assign load density values to the various load types contained
within your land use layer.
Load Estimation by PopulationInput DataThe following fields require data to be specified:
area for each node.
Population LayerThis field allows you to specify the polygon feature class or shapefile that contains the
population data.
Population Density Type FieldThis field is optional. It allows you to specify the source database field that
contains the population density type data.
Population Density FieldThis field allows you to specify the source database field that contains population
density data.
Load Densities Per CapitaThis table allows you to assign load density values to the various load types contained
within your population density layer.
302
Step 3: Calculation Summary

This step displays the Results Summary pane, which displays the total load, load multiplier, and hydraulic pattern
associated with each load type in a tabular format. The number of entries listed will depend on the load build method
and data types selected in Step 1. The Results Summary pane contains the following columns:
Load TypeThis column contains an entry for each load type contained within the database column specified in
step one. (Examples include residential, commercial, industrial, etc.)
ConsumptionThis column displays the total load associated with each load type entry.
MultiplierThis column displays the multiplier that is applied to each load type entry. Multipliers can be used to
account for peak loads, expected future loads, or to reflect unaccounted-for-loads. This field is editable.
PatternThis column displays the hydraulic pattern associated with each demand type entry. A different pattern
can be specified using the menu contained within each cell of this column. New patterns cannot be created from this
dialog box; see the Pattern manager help topic for more information regarding the creation of new patterns.
In addition to the functionality provided by the tabular summary pane, the following controls are also available in this
step:
Global MultiplierThis field allows you to apply a multiplier to all of the entries contained within the Results
Summary Pane. Any changes are automatically reflected in the Total Load text field. Multipliers can be used to
account for peak loads, expected future loads, or to reflect unaccounted-for-loads. The Global Multiplier should be
used when the conditions relating to these considerations are identical for all usage types and elements.
Total LoadThis field displays an updated total of all of the entries contained within the Results Summary Pane, as
modified by the local and global multipliers that are in effect.
Step 4: Results Preview

This step displays the calculated results in a tabular format. The table consists of the following information:
ElementIDElementID is the unique identifying label assigned to all geodatabase elements by the GIS.
LabelLabel is the unique identifying label assigned by WaterGEMS Modeler.
Load TypeLoad Type is an optional classification that can be used to assign different behaviors, multipliers, and
patterns in various situations. For example, possible load types may include Residential, Commercial, Industrial,
etc. To make use of the Load Type classification, your source database must include a column that contains this
data.
PatternAllows you to assign a previously created pattern to each load type in the table.
Step 5: Completing the LoadBuilder Wizard

In this step, the load build template is given a label and the results are exported to an existing or new load alternative.
This step contains the following controls:
LabelThis field allows a unique label to be assigned to the load build template.
Override an Existing AlternativeChoosing this option will cause the calculated loads to overwrite the loads
contained within the existing load alternative that is selected.
Append to an Existing AlternativeChoosing this option will cause the calculated loads to be appended to the loads
contained within the existing load alternative that is selected. Loads within the existing alternative that are assigned
to a specific node will not be overwritten by newly generated loads assigned to the same node; the new loads will
simply be added to them.
New AlternativeChoosing this option will cause the calculated loads to be applied to a new load alternative. The
text field next to this button lets you enter a label for the new load alternative. The Parent Alternative field will only
be active when this option is selected.
303
LoadBuilder Run Summary

The LoadBuilder Run Summary dialog box details important statistics about the results of a completed LoadBuilder
run, including the number of successfully added loads, file information, and informational and/or warning messages.
Unit Line Method

A Thiessen polygon is a Voronoi Diagram that is also referred to as the Dirichlet Tessellation. Given a set of points, it
defines a region around each point. A Thiessen polygon divides a plane such that each point is enclosed within a
polygon and assigns the area to a point in the point set. Any location within a particular Thiessen polygon is nearer to
that polygons point than to any other point. Mathematically, a Thiessen is constructed by intersecting perpendicular
bisector lines between all points.
Thiessen polygon has many applications in different location-related disciplines such as business planning, community
services, transportation and hydraulic/hydrological modeling. For water distribution modeling, the Thiessen Polygon
Creator was developed to quickly and easily define the service areas of demand nodes. Since each customer within a
Thiessen polygon for a junction is nearer to that node than any others, it is assumed that the customers within a
particular Thiessen polygon are supplied by the same demand node.
The following diagrams illustrate how Thiessen polygons would be generated manually. The Thiessen Polygon Creator
does not use this method, although the results produced by the generator are consistent with those that would be
obtained using this method.
The first diagram shows a pipe and junction network.
304
In the second diagram, the circles are drawn around each junction.
305
In the third diagram, bisector lines are added by drawing a line where the circles interjoin.
In the final diagram, the network is overlaid with the polygons that are created by connecting the bisector lines.
306
Generating Thiessen Polygons
A Thiessen polygon is a Voronoi Diagram that is also referred to as the Dirichlet Tessellation. Given a set of points, it
defines a region around each point. A Thiessen polygon divides a plane such that each point is enclosed within a
polygon and assigns the area to a point in the point set. Any location within a particular Thiessen polygon is nearer to
that polygons point than to any other point. Mathematically, a Thiessen is constructed by intersecting perpendicular
bisector lines between all points.
Thiessen polygon has many applications in different location-related disciplines such as business planning, community
services, transportation and hydraulic/hydrological modeling. For water distribution modeling, the Thiessen Polygon
Creator was developed to quickly and easily define the service areas of demand nodes. Since each customer within a
Thiessen polygon for a junction is nearer to that node than any others, it is assumed that the customers within a
particular Thiessen polygon are supplied by the same demand node.
The following diagrams illustrate how Thiessen polygons would be generated manually. The Thiessen Polygon Creator
does not use this method, although the results produced by the generator are consistent with those that would be
obtained using this method.
The first diagram shows a pipe and junction network.
307
In the second diagram, the circles are drawn around each junction.
In the third diagram, bisector lines are added by drawing a line where the circles interjoin.
308
In the final diagram, the network is overlaid with the polygons that are created by connecting the bisector lines.
Thiessen Polygon Input Dialog Box

The Thiessen Polygon Creator allows you to quickly create polygon layers for use with the LoadBuilder demand
allocation module. This utility creates polygon layers that can be used as service area layers for the following
LoadBuilder loading strategies:
Billing Meter Aggregation
309
Proportional Distribution By Area

Proportional Distribution By Population
Projection by Land Use
Load Estimation by Population.
The Thiessen Polygon Creator dialog box consists of the following steps:
Step 1: Node Data Source
Node Data SourceSelect the data source to use.
Node LayerThis lists the valid point feature classes and shapefiles that Thiessen Polygon Creator can use.
Current SelectionClick if the current feature data set contains a previously created selection set.
Include active elements onlyClick to activate.
SelectionThis option allows you to create a selection on the fly for use with the Thiessen Polygon Creator. To use
this option, use the ArcMap Select Features tool to select the point features that you want before opening the
Thiessen Polygon Creator.
Step 2: Boundary Layer
Buffering PercentageThis percentage value is used for calculating the boundary for a collection of points. In order
to make the buffer boundary big enough to cover all the points, the boundary is enlarged based upon the value
entered in this field as it relates to the percentage of the area enclosed by drawing a polygon that connects the
outermost nodes of the model.
Polygon Boundary LayerSelect the boundary polygon feature class or shapefile, if one has already been created.
A boundary is specified so that the outermost polygons do not extend to infinity. For more information about
boundary layers, see Creating Boundary Polygon Feature Classes (on page 311).
Step 3: Output Layer
Output FileSpecify the name of the shapefile that will be created.
310
Note: The Thiessen Polygon Creator is flexible enough to generate Thiessen polygons for unusual boundary
shapes, such as borders with cutouts or holes that Thiessen polygons should not be created inside. To
accomplish this, the boundary polygon must be created as one complex (multi-part) polygon. For more
information about creating boundary polygon feature classes, see your ArcGIS documentation.
Creating Boundary Polygon Feature Classes

The Thiessen polygon generator requires a boundary to be specified around the area in which Thiessen Polygons will
be created. This is to prevent the outside edge of the polygons along the perimeter of this area from extending to
infinity. The generator can automatically create a boundary using the Buffering Point Area Percentage value, or it can
use a previously created polygon feature class as the boundary.
A border polygon feature class can be created in ArcCatalog, and edited in ArcMap.
To create a border feature class, you will need a WaterGEMS V8i model that has had at least one scenario published as
an Esri feature dataset. Then, follow these steps:
1. In the directory structure pane of ArcCatalog, right-click the WaterGEMS V8i feature dataset and select
New...Feature Class.
2. A dialog box will open, prompting you to name the new feature class. Enter a name and click Next.
3. In the second step, you are prompted to select the database storage configuration. Do so, and click Next.
4. In the third step, click the Shape cell under the Field Name column, and ensure that the Geometry Type is Polygon.
Click Finish.
5. In ArcMap, click the Add Data button and select your WaterGEMS V8i feature dataset.
6. Click the Editor button and select Start Editing. Ensure that the border feature class is selected in the Target drop-
down list.
7. Draw a polygon around the point features (generally manholes) that you wish to be used to generate the polygons.
When you are finished drawing the polygon, click Editor...Stop Editing. Choose Yes when prompted to save your
edits.
The polygon feature class you just created can now be used as the boundary during Thiessen polygon generation. For
more information about creating and editing feature classes, see your ArcGIS documentation.
Demand Control Center
The Demand Control Center is an editor for manipulating all the demands in your water model. Using the Demand
Control Center, you can add new demands, delete existing demands, or modify the values for existing demands using
standard SQL select and update queries.
The Demand Control Center provides demand editing capabilities which can:
open on all demand nodes, or subset of demand nodes,
sort and filter based on demand criteria or zone,
add, edit, and delete individual demands,
global edit demands,
provides access to statistics for the demands listed in the table,
and filter elements based on selection set, attribute, predefined query, or zone.
In order to access the Demand Control Center go to Tools > Demand Control Center or click Demand Control. The
Demand Control Center opens.
311
The Demand Control Center toolbar includes the following:
Clicking this button opens a submenu containing the

following commands: Add Demand to Element Adds a
New row to the table, allowing you to assign a demand and
demand pattern to the element that is currently
highlighted in the list. Add Demand Opens the Domain
Element Search box, allowing you to select elements in
the drawing pane and assign a demand and demand
pattern to them. Initialize Demands for All Elements
Adds a row to the table for each element (each junction if
executed on the Junction tab, each hydrant if executed on
the Hydrant tab, etc.) in the model that does not currently
have a demand assigned to it. The initialized rows will
assign a Base Flow of 0 and a Fixed demand pattern to
the associated elements.
Deletes an existing demand.

Delete
Generates a demand report based on the contents of the

table.
Report
312
Creates a new selection set containing the currently

selected elements, adds currently selected elements to an
Create or Add to a Selection Set existing selection set, or removes currently selected
elements from a selection set.
Zooms to a specific element.

Zoom
Opens the Domain Element Search editor.
Find
Provides access to global sort and filter capabilities.

Options
Opens a submenu allowing you to filter the table

Query according to one of the following: Selection Set : The
submenu contains a list of previously created selection
sets. If you choose a selection set only those elements
contained in that selection set will be displayed.
Attribute : If this command is selected, the Query Builder
opens, allowing you to diaply only those elements that
meet the criteria of the query you create. Predefined
Queries : The submenu contains a number of predefined
queries grouped categorically. For more information
about these queries, see Using the Network Navigator (on
page 200).
Note: To view statistics for the demands listed in the Demand Control Center, right-click the Demand column
heading and select Statistics from the context menu.
Apply Demand and Pattern to Selection Dialog Box

This dialog allows you to assign a demand and demand pattern to the currently selected element or elements. The
dialog appears after you have used the Add Demands command in the Demand Control Center or the Unit Demand
Control Center and then selected one or more elements in the drawing pane. The dialog itself will vary depending on
whether it was accessed from the Demand Control Center or the Unit Demand Control Center.
From the Demand Control Center
Enter a demand value in the Demand field, then choose a previously created pattern in the Pattern list, create a new
pattern by clicking the ellipsis button to open the Patterns dialog, or leave the default value of Fixed if the demand does
not vary over time.
From the Unit Demand Control Center
Enter the number of individual unit demands in the Unit Demands <Count> field. Choose a previously defined unit
load from the Unit Load list, or create a new one in the Unit Demands dialog by clicking the ellipsis button. Choose a
previously created pattern in the Pattern list, create a new pattern by clicking the ellipsis button to open the Patterns
dialog, or leave the default value of Fixed if the demand does not vary over time.
313
Unit Demands Dialog Box
The Unit Demands dialog box allows you to create unit-based demands that can later be added to model nodes.
A unit demand consists of a unit (person, area) multiplied by a unit demand (gal/capita/day, liters/sq m/day, cfs/acre).
The units are assigned to node elements (like junctions) while the unit demands are created using the Unit Demands
dialog box. If the unit demands are not assigned to nodes but to polygons in a GIS, then it is best to use LoadBuilder to
import the loads.
There are two sections of the Unit Demands dialog box: the Unit Demands Pane on the left and the tab section on the
right. The Unit Demands Pane is used to create, edit, and delete unit demands. This section contains the following
controls:
Creates a new unit demand. When you click the new

New button, a submenu opens containing the following
choices: AreaCreates a new Area-based unit demand.
CountCreates a new Count-based unit demand.
PopulationCreates a new Population-based unit
demand.
Copies the currently selected unit demand.
Duplicate
314
Deletes the currently highlighted unit demand. You can

Delete hold down the Ctrl key while clicking on items in the list
to select multiple entries at once.
Renames the currently highlighted unit demand.

Rename
Generates a detailed report on the selected unit demand.

Report

Synchronization Options the library, imports from the library or exports to the
library.
The tab section is used to define the settings for the unit demand that is currently highlighted in the unit demands list
pane.
Unit Demand Tab This tab consists of input data fields that allow you to
define the unit demand. The available controls will vary
depending on the type of unit demand being defined.
Population Unit Demand Unit Demand Lets you specify the amount of demand
required per population unit. Population Unit Lets you
specify the base unit used to define the population-based
demand.
Count Unit Demand Unit Demand Lets you specify the amount of demand
required per count unit. Count Unit Lets you specify
the base unit used to define the unit-based demand.
Report Population Equivalent Checking this box
enables the Population Equivalent field, letting you
specify the equivalent population count per demand unit.
Population Equivalent When the Report Population
Equivalent box is checked, this field lets you specify the
equivalent population count per demand unit. For area
based demands, this is essentially a population density, or
population per unit area.
Area Unit Demand Unit Demand Lets you specify the amount of demand
required per area unit. Area Unit Lets you specify the
base unit used to define the area-based demand. Report
Population Equivalent Checking this box enables the
Population Equivalent field, letting you specify the
equivalent population count per demand unit. Population
Equivalent When the Report Population Equivalent box
is checked, this field lets you specify the equivalent
population count per demand unit. For area based
demands, this is essentially a population density, or
population per unit area.
315
Library Tab This tab displays information about the unit demand that
is currently highlighted in the Unit Demand list pane. If
the unit demand is derived from an engineering library,
the synchronization details can be found here. If the unit
demand was created manually for this project, the
synchronization details will display the message Orphan
(local), indicating that the unit demand was not derived
from a library entry.
descriptive notes that will be associated with the unit
demand that is currently highlighted in the Unit Demand
list pane.
Unit Demand Control Center
The Unit Demand Control Center is an editor for manipulating all the unit demands in your water model. Using the
Unit Demand Control Center, you can add new unit demands, delete existing unit demands, or modify the values for
existing unit demands. You can also and filter elements based on demand criteria, pattern, or zone.
In order to access the Unit Demand Control Center go to Tools > Unit Demand Control Center or click the Unit
Demand Control Center icon. The Unit Demand Control Center opens.
The Unit Demand Control Center toolbar includes the following:
Add Demands opens the Domain Element Search dialog

box, allowing you to search for the element to include.
New Once youve added an element, you can choose to Add
Demand to Element, and the element that is selected is
duplicated. Initialize Demands for All Elements adds all
the demand elements to the control center.
316
Deletes an existing unit demand.

Delete
Generates a unit demand report based on the contents of

the table.
Report
Creates a new selection set containing the currently

selected elements, adds currently selected elements to an
Create or Add to a Selection Set existing selection set, or removes currently selected
elements from a selection set.
Zooms to a specific element.

Zoom
Opens the Domain Element Search editor.
Find
Provides access to global sort and filter capabilities.

Options
Opens a submenu allowing you to filter the elements

Query
displayed based on a number of predefined queries. For
more information about the .available queries, see Using
the Network Navigator (on page 200).
Note: To view statistics for the demands listed in the Unit Demand Control Center, right-click the Unit Demand
or Demand (Base) column headings and select Statistics from the context menu.
Pressure Dependent Demands
Pressure Dependent Demands (PDD) allows you to perform hydraulic simulation by treating the nodal demand as a
variable of nodal pressure. Using PDD you can perform hydraulic simulation for:
Pressure dependent demand at a node or a set of nodes
Combination of PDD and volume based demand
Calculate the actual supplied demand at a PDD node and demand shortfall
Present the calculated PDD and the associated results in a table and graph.
In order to access PDD choose Components > Pressure Dependent Demand Functions or click Pressure Dependent
Demand Functions to open the Pressure Dependent Demand Functions dialog box.
317
Creates a new pressure dependent demand function.

New
Copies the currently selected demand.
Duplicate
Deletes an existing demand. You can hold down the Ctrl

Delete key while clicking on items in the list to select multiple
entries at once.
Renames an existing pressure dependent demand

Rename function.
Generates a pressure dependent demand report based on

the selected demand.
Report

Synchronization Options the library, imports from the library or exports to the
library.
Properties tab
318
Function Type - Either Power Function or Piecewise Linear. Power Function is used to define the exponential
relationship between the nodal pressure and demand. The ratio of actual supplied demand to reference demand is
defined as a power function of the ratio of actual pressure to reference pressure.
Power Function Exponent - The coefficient that defines the power function relationship between the demand ratio and
pressure ratio.
Has Threshold Pressure? - Turn on to specify if a threshold pressure is to be input.
Pressure Threshold is the maximum pressure above which the demand is kept constant.
319
If the function type chosen is Piecewise Linear then the following opens.
Piecewise Linear is a table of reference pressure percentage vs. reference demand percentage. The last entry value of
reference pressure is the greatest that defines the threshold pressure. If the last pressure percentage is less than 100%,
the threshold pressure is equal to the reference pressure. If the last pressure percentage is greater than 100%, the
threshold pressure is the multiplication of the reference pressure with the greatest pressure percentage.
Percent of Reference Pressure % - defines the percentage of a nodal pressure to reference pressure.
Percent of Reference Demand - defines the percentage of a nodal demand to reference demand.
320
The Reference Pressure is the pressure at which the demands are fully met at a node. In the graph below, the demand
assigned to the node is 18 gpm and the reference pressure is 40 psi. As the pressure deviates from 40 psi, the actual
demand at the node changes in response to the pressure dependent demand curve (blue line).
In some cases, there is an upper limit to the amount of water that will be used as pressure increases (users will throttle
back their faucets). In this case the pressure at which demand is no longer a function of pressure is called the Pressure
Threshold. In the graph below the pressure threshold is 50 psi.
The pressure threshold must be equal to or greater than the reference pressure. A reference pressure must be specified
to use pressure dependent demand. The threshold pressure is optional. The user can optionally set the reference
pressure to the threshold pressure. These values can be set globally or the global value can be overridden on a node by
node basis.
Piecewise Linear Dialog Box

This dialog allows you define engineering library entries for Piecewise Linear Curves.
321
Reducing Model Complexity with Skelebrator
The following buttons are located above the curve points table on the left:

New-Creates a new row in the curve points table.

Delete-Deletes the currently highlighted row from the curve points table.
Percent of Pressure Threshold-defines the percentage of a nodal pressure to reference pressure.
Percent of Reference Demand- defines the percentage of a nodal demand to reference demand.
Piecewise Linear is a table of reference pressure percentage vs. reference demand percentage. The last entry value of
reference pressure is the greatest that defines the threshold pressure. If the last pressure percentage is less than 100%,
the threshold pressure is equal to the reference pressure. If the last pressure percentage is greater than 100%, the
threshold pressure is the multiplication of the reference pressure with the greatest pressure percentage.

To learn about reducing model complexity using Skelebrator, click the clinks below:
Skeletonization
Skeletonization is the process of selecting only the parts of the hydraulic network that have a significant impact on the
behavior of the system for inclusion in a water distribution model. For example, including each individual service
connection, valve, and every one of the numerous other elements that make up the actual network would be a huge
undertaking for larger systems. The portions of the network that are not modeled are not ignored; rather, the effects of
these elements are accounted for within the parts of the system that are included in the model.
A fully realized water distribution model can be an enormously complex network consisting of thousands of discrete
elements, and not all of these elements are necessary for every application of the model. When elements that are
322
extraneous to the desired purpose are present, the efficiency, usability, and focus of the model can be substantially
affected, and calculation and display refresh times can be seriously impaired. In addition to the logistics of creating and
maintaining a model that employs little or no skeletonization, a high level of detail might be unnecessary when
incorporating all of these elements in the model and has no significant effect on the accuracy of the results that are
generated.
Different levels of skeletonization are appropriate depending on the intended use of the model. For an energy cost
analysis, a higher degree of skeletonization is preferable and for fire flow and water quality analysis, minimal
skeletonization is necessary. This means that multiple models are required for different applications. Due to this
necessity, various automated skeletonization techniques have been developed to assist with the skeletonization process.
Automated Skeletonization includes:
A generic skeletonization example
What automated skeletonizers generally do
How Skelebrator approaches skeletonization
Using the Skelebrator software
Skeletonization Example
The following series of diagrams illustrate various levels of skeletonization that can be applied. The diagram below
shows a network subdivision before any skeletonization has been performed.
There is a junction at each service tap and a pipe and node at each house for a total of 48 junctions and 47 pipes within
this subdivision.
To perform a low level of skeletonization, the nodes at each house could be removed along with the connecting pipes
that tie in to the service line. The demands at each house would be moved to the corresponding service tap. The
resulting network would now look like this:
There are now 19 junctions and 18 pipes in the subdivision. The demands that were assigned to the junctions that were
removed are moved to the nearest upstream junction. The only information that has been lost is the data at the service
connections that were removed.
323
A further level of skeletonization is possible if you remove the service taps and model only the ends and intersections
of the main pipes. In this case, re-allocating the demands is a bit more complex. The most accurate approximation can
be obtained by associating the demands with the junction that is closest to the original demand junction (as determined
by following the service pipe). In the following diagram, these service areas are marked with a dotted line.
To fully skeletonize this subdivision, the pipes and junctions that serve the subdivision can be removed, and the
demands can be assigned to the point where the branch connects to the rest of the network, as shown in the following
diagram.
As can be seen by this example, numerous levels of skeletonization can be applied; determining the extent of the
skeletonization depends on the purpose of the model. At each progressive level of skeletonization, more elements are
removed, thus the amount of available information is decreased. Deciding whether this information is necessary to the
intended use of the model dictates the point at which the model is optimally skeletonized.
Common Automated Skeletonization Techniques
The following are descriptions of the skeletonization techniques that have been employed to achieve a level of
automation of the skeletonization process. Generally, a combination of these techniques proves to be more effective
than any one on its own.
GenericData Scrubbing
Data scrubbing is usually the first step of the skeletonization process. Some automated skeletonizers rely entirely on
this reduction technique. (Data scrubbing is called Smart Pipe Removal in Skelebrator.) Data scrubbing consists of
removing all pipes that meet user-specified criteria, such as diameter, roughness, or other attributes. Criteria
combinations can also be applied, for example: Remove all 2-inch pipes that are less than 200 feet in length.
This step of skeletonization is especially useful when the model has been created from GIS data, since GIS maps
generally contain much more information than is necessary for the hydraulic model. Examples of elements that are
commonly included in GIS maps, but not necessarily in the distribution model, are service connections and isolation
324
valves. Removing these elements generally has a negligible impact on the accuracy of the model, depending on the
application for which the model is being used.
The primary drawback of this type of skeletonization is that there is generally no network awareness involved. No
consideration of the hydraulic effects of a pipes removal is taken into account, so there is a large potential for errors to
be made by inadvertent pipe removal or by causing network disconnections. (Bentley Systems Skelebrator does account
for hydraulic effect.)
GenericBranch Trimming
Branch trimming, also referred to as Branch Collapsing, is the process of removing short dead-end links and their
corresponding junctions. Since pipes and junctions are removed by this process, you specify the criteria for both types
of element. An important element of this skeletonization type is the reallocation of demands that are associated with
junctions that are removed. The demand associated with a dead-end junction is assigned to the junction at the beginning
of the branch.
Branch trimming is a recursive process; as dead-end pipes and junctions are removed, other junctions and pipes can
become the new dead-endsif they meet the trimming criteria, these elements may also be removed. You specify
whether this process continues until all applicable branches have been trimmed or if the process should stop after a
specified number of trimming levels.
Branch trimming is an effective skeletonization technique; dead-end junctions with no loading have no effect on the
model, and dead end junctions that do have demands are accounted for at the point through which this flow would pass
anyway (without skeletonization), so the hydraulic behavior of the network as a whole is unaffected.
A drawback to this type of skeletonization is that information and results cannot be obtained from non-existent
elements. During water quality or fire flow analysis, information on these trimmed elements may be desired but
unavailable. Having multiple models utilizing various levels of skeletonization is the solution to this potential issue.
GenericSeries Pipe Removal

This section discusses the advantages and approach to performing skeletonization using Skelebrator.
Series pipe removal, also known as intermediate node removal or pipe merging, is the next skeletonization technique. It
works by removing nodes that have only two adjacent pipes and merging these pipes into a single one. As with Branch
trimming, any demands associated with the junctions being removed must be reallocated to nearby nodes, and generally
a number of strategies for this allocation can be specified.
An evenly-distributed strategy divides the demand equally between the two end nodes of the newly merged pipe. A
distance-weighted technique divides the demands between the two end nodes based on their proximity to the node
being removed. These strategies can be somewhat limiting, and maintaining an acceptable level of network hydraulic
precision while removing nodes and merging pipes is made more difficult with this restrictive range of choices.
Other criteria are also used to set the allowable tolerances for relative differences in the attributes of adjacent pipes and
nodes. For example, an important consideration is the elevation difference between nodes along a pipe-merge
candidate. If the junctions mark critical elevation information, this elevation (and by extension, pressure) data would be
lost if this node attribute is not accounted for when the pipes are merged.
Another set of criteria would include pipe attributes. This information is needed to prevent pipes that are too different
(as defined by the tolerance settings) hydraulically from being merged. It is important to compare certain pipe attributes
before merging them to ensure that the hydraulic behavior will approximate the conditions before the merge. However,
requiring that pipes have exactly matching criteria limits the number of elements that could potentially be removed,
thus reducing the level of skeletonization that is possible.
325
In other words, although it is desirable for potential pipe merge candidates to have similar hydraulic attributes,
substantial skeletonization is difficult to achieve if there are even very slight variances between the hydraulic attributes
of the pipes, since an exact match is required. This process is, however, very good at merging pipes whose adjacent
nodes have no demand and that have exactly the same attributes. Removing these zero-demand junctions and merging
the corresponding pipes has no effect on the model's hydraulics, except for loss of pressure information at the removed
junctions.
Series pipe removal is called Series Pipe Merging in Skelebrator.
Skeletonization Using Skelebrator
This section discusses the advantages and approach to performing skeletonization using Skelebrator.
Skelebrator-Smart Pipe Removal

The first step that Skelebrator performs is Smart Pipe Removal, which is an improved version of the data scrubbing
technique. The main drawback of standard data scrubbing procedures is that they have no awareness of the effects that
removing elements from the model will have on the calculated hydraulics. This can easily cause network
disconnections and lead to a decrease in the accuracy of the simulated network behavior.
Skelebrator eliminates the possibility of inadvertent network disconnections caused by the data scrubbing technique.
This is accomplished by utilizing a sophisticated network-walking algorithm. This algorithm marks pipes as safe to be
removed if the removal of the pipe so marked would not invalidate, or disconnect, the network. For a pipe to be
removed, it must:
Meet the user-specified removal criteria
Be marked safe for removal
Not be marked as non-removable
Not be connected to a non-removable junction (to prevent orphaning).
This added intelligence protects the models integrity by eliminating the possibility of inadvertently introducing
catastrophic errors during the model reduction process.
This innovation is not available in other automated skeletonization applications; a likely result of performing
skeletonization without this intelligent safety net is the invalidation of the network caused by the removal of elements
that are critical to the performance and accuracy of the model. At the very least, verifying that no important elements
have been removed during this skeletonization step and re-creating any elements that have been erroneously removed
can be a lengthy and error-prone process. These considerations are addressed automatically and transparently by the
Skelebrators advanced network traversal algorithm.
Skelebrator-Branch Collapsing
Branch Collapsing is a fundamental skeletonization technique; the improvements over the branch trimming that
Skelebrator brings to the table are primarily a matter of flexibility, efficiency, and usability. The branch trimming
method utilized by other automated skeletonization applications allows a limited range of removal criteria; in some
cases, just elevation and length. Workarounds are required if another removal criteria is desired, resulting in more steps
to obtain the desired results.
Conversely, Skelebrator innately provides a wide range of removal criteria, increasing the scope of this skeletonization
step and eliminating the need for inefficient manual workarounds.
The following diagrams illustrate the results of Branch Collapsing;
326
Skelebrator-Series Pipe Merging

The Skelebrator Series Pipe Merging technique overcomes the basic drawbacks to series pipe removal that were
mentioned previously in two ways:
First, the demand reallocation strategies normally available for this step are not comprehensive enough, limiting you to
choosing from an even demand distribution or a distance-weighted one. This limitation can hinder your ability to
maintain an acceptable level of hydraulic parity.
To overcome this limitation, Skelebrator provides a greater range of demand reallocation strategies, including: Equally
Distributed, Proportional to Existing Load (at the ends of the new pipe), Proportional to Dominant Criteria, and User
Defined Ratio. Evenly Distributed divides the demand equally between the two end nodes of the newly merged pipe.
The Proportional to Existing Load divides demand based on the amount of demand already associated with the end
nodes. The Proportional to Dominant Criteria strategy can supply the distance-weighted option and allows other pipe
attributes to be weighting factors as well (for example, roughness or diameter). The User-Defined Ratio option assigns
327
the specified proportion of demand to the upstream junction and the remainder of the demand to the downstream one.
These additional choices allow the proper simulation of a wider range of hydraulic behaviors.
Second, and more importantly, this technique is effective because it allows you to specify tolerances that determine if
the pipes to be merged are similar enough that combining them into a single pipe will not significantly impact the
hydraulic behavior of the network. This increases the number of potential merge candidates over requiring exact
matches, thereby increasing the scope of skeletonization but affecting hydraulics, since differences in hydraulic
properties are ignored.
To counter the hydraulic effects of merging pipes with different hydraulic attributes, a unique hydraulic equivalency
feature has been developed. This feature works by determining the combination of pipe attributes that will most closely
mimic the hydraulic behavior of the pipes to be merged and applying these attributes to the newly merged pipe. By
generating an equivalent pipe from two non-identical pipes, the number of possible removal candidates (and thus, the
potential level of skeletonization) is greatly increased.
This hydraulic equivalency feature is integral to the application of a high degree of effective skeletonization, the goal of
which is the removal of as many elements as possible without significantly impacting the accuracy of the model. Only
Skelebrator implements this concept of hydraulic equivalency, breaking the barrier that is raised by other skeletonizers
that only allow exactly matched pipes to be merged by this process.
328
Note: If you want to combine only pipes with the same hydraulic characteristics (i.e., diameter and roughness)
then to a series pipe removal operation, add a pipe tolerance of 0.0 and a roughness tolerance of 0.0. Also make
sure to deselect the Use Equivalent Pipes option.
Skelebrator-Parallel Pipe Merging

Parallel Pipe Merging is the process of combining pipes that share the same two end nodes into a single hydraulically
equivalent pipe. This skeletonization strategy relies on the hydraulic equivalency feature.
To merge parallel pipes, you specify which of the two pipes is the "dominant" one. The length of the dominant pipe
becomes the length of the merged pipe, as does either the diameter or the roughness value of the dominant pipe. You
specify which of the two attributes to retain (diameter or roughness) and the program determines what the value of the
other attribute should be in order to maintain hydraulic equivalence.
For example, the dominant pipe has a diameter of 10 inches and a C factor of 120; one of these values is retained. The
pipe that will be removed has a diameter of 6 inches and a C factor of 120. If the 10-inch diameter value is retained, the
program performs hydraulic equivalence calculations to determine what the roughness of the new pipe should be in
order to account for the additional carrying capacity of the parallel pipe that is being removed.
Because this skeletonization method removes only pipes and accounts for the effect of the pipes that are removed, the
network hydraulics remain intact while increasing the overall potential for a higher level of skeletonization.
329
Skelebrator-Inline Isolation Valve Replacement

In building a model from an external source such as a GIS, the GIS may be set up such that isolation valves split a pipe
into two separate pipes. These isolation valves are usually imported into WaterGEMS as throttling control valves
(TCV) or general purpose valves (GPV) with ModelBuilder. This is due to the fact that WaterGEMS isolation valves
are attached to pipes and do not split them.
While models that split pipes with a TCV or GPV will run, they are usually about twice as large as one that models
isolation valves as attached to a single pipe and not splitting pipes. In Skelebrator, it is possible to automatically convert
all or a selection of valves into WaterGEMS isolation valves, and merge the pipes on either side of the valve into a
single pipe element. This process is shown graphically below. The pipes that are merged are treated the same as they
are under the series pipe merging option except that the isolation valve element is maintained at its original location and
can be used for segmentation.
330
See Inline Isolating Valve Replacement (on page 346) for details on using this option.
Skelebrator-Other Skelebrator Features

Skelebrator offers numerous other features that improve the flexibility and ease-of-use of the skeletonization process.
The Skeletonization Preview option allows you to preview the effects that a given skeletonization step, or method, will
have on the model. This important tool can assist the modeler in finding potential problems with the reduced model
before a single element is removed from it.
Before skeletonization is begun or between steps, you can use Skelebrators protected element feature to manually
mark any junctions or pipes as non-removable. Any pipes marked in this way will always be preserved by the
Skelebrator, even if the elements meet the removal criteria of the skeletonization process in question. This option
provides the modeler with an additional level of control as well as improving the flexibility of the process.
The ability of the Skelebrator to preserve network integrity by not removing elements that would cause the network to
be invalidated is an important timesaving feature that can prevent this common error from happening. There may be
circumstances, however, when you do not want or need this additional check, so this option can be switched off.
For the utmost control over the skeletonization process, you can perform a manual skeletonization. This feature allows
you to step through each individual removal candidate. The element can then be removed or marked to be excluded
from the skeletonization. You can save this process and choices you made and reuse them in an automatic
skeletonization of the same model.
331
Skelebrator-Conclusion
With the overwhelming amount of data now available to the water distribution modeler, some degree of skeletonization
is appropriate for practically every model, although the extent of the skeletonization varies widely depending on the
intended purpose of the model. In light of this, it has become desirable to maintain multiple models of the same system,
each for use in different types of analysis and design.
A model that has been minimally skeletonized serves as a water quality and fire flow analysis model, while energy cost
estimating is performed using a model with a higher degree of skeletonization.
Creating a number of reduced models with varying levels of skeletonization can be a lengthy and tedious process,
which is where the automated techniques described above demonstrate their value. To ensure that the skeletonization
process produces a reduced model with the minimum number of elements necessary for the intended application while
simultaneously maintaining an accurate simulation of network behavior, the automated skeletonization routine must be
flexible enough to accommodate a wide variety of conditions.
Skelebrator provides an unmatched level of flexibility, providing numerous demand reallocation and element removal
strategies. It alone, amongst automated skeletonizers, maximizes the potential level of skeletonization by introducing
the concept of Hydraulic Equivalence, eliminating the limitation posed by exact attribute matching requirements.
Another distinction is the advanced network walking algorithm employed by Skelebrator, which ensures that your
model remains connected and valid, thereby greatly reducing the possibility for inadvertent element removal errors.
These features, and others such as the Skeletonization Preview and Manual Skeletonization, greatly expedite and
simplify the process of generating multiple, special-purpose water distribution models, each skeletonized to the optimal
level for their intended purpose.
Using the Skelebrator Software
Skelebrator is available for use in Stand-Alone, MicroStation, ArcGIS, and AutoCAD modes. Skelebrator has slightly
different behavior and features in some environments. This section describes using the Skelebrator software.
When using Skelebrator, please note:
We strongly recommended that you first make a copy of your model as a safe guard before proceeding with
Skelebration. In ArcGIS (ArcCatalog or ArcMap), there is no ability to undo your changes after they have been
made.
We strongly recommended that you eliminate all scenarios other than the one to be skeletonized from a model prior
to skeletonization.
Skelebrator reduces a WaterGEMS V8i model and applies its changes to the models WaterGEMS V8i datastore,
which is contained within an .sqlite file. Skelebrator cannot view or make changes to a standard GIS geodatabase.
To use Skelebrator with a GIS geodatabase, you must first use ModelBuilder to create a WaterGEMS V8i datastore
from the GIS data.
To use Skelebrator with a CAD drawing, you must first use ModelBuilder to create a WaterGEMS V8i datastore
from the CAD file.
Skeletonization
Skeletonization is the process of selecting only the parts of the hydraulic network that have a significant impact on the
behavior of the system for inclusion in a water distribution model. For example, including each individual service
connection, valve, and every one of the numerous other elements that make up the actual network would be a huge
332
undertaking for larger systems. The portions of the network that are not modeled are not ignored; rather, the effects of
these elements are accounted for within the parts of the system that are included in the model.
A fully realized water distribution model can be an enormously complex network consisting of thousands of discrete
elements, and not all of these elements are necessary for every application of the model. When elements that are
extraneous to the desired purpose are present, the efficiency, usability, and focus of the model can be substantially
affected, and calculation and display refresh times can be seriously impaired. In addition to the logistics of creating and
maintaining a model that employs little or no skeletonization, a high level of detail might be unnecessary when
incorporating all of these elements in the model and has no significant effect on the accuracy of the results that are
generated.
Different levels of skeletonization are appropriate depending on the intended use of the model. For an energy cost
analysis, a higher degree of skeletonization is preferable and for fire flow and water quality analysis, minimal
skeletonization is necessary. This means that multiple models are required for different applications. Due to this
necessity, various automated skeletonization techniques have been developed to assist with the skeletonization process.
Automated Skeletonization includes:
A generic skeletonization example
What automated skeletonizers generally do
How Skelebrator approaches skeletonization
Using the Skelebrator software
Batch Run
When Default Skelebrator Group is highlighted, the Batch Run tab is opened with the Batch Run Manager in view. Use
the Batch Run Manager to select the skeletonization strategies you want to use and the order to run them.
333
Operations appearing in the top window are the operations you have defined and which are available for use in a batch
run. Any operations in this window may be selected for a batch run. The same operation can be selected multiple times.
To Use Batch Run:
1. Select Default Skelebrator Group.
2. Select the Skeletonization strategies.
3. Click Add to add selected operations to the lower window. Any operations in the lower window are selected as part
of the batch run. Use Remove, Move Up, and Move Down to manage the makeup and order of the operations in the
batch run list.
4. Click Batch Run to start an automatic skeletonization using the operations you have defined in your batch run or
click Preview to preview the results of the operations you have defined in your batch run prior to running it.
334
5.
The following message opens:

6. Click Yes to continue.
7. Results of the batch run show in the drawing pane.
Note: The batch run manager does not become available until at least one Skelebrator operation is added. All
operations selected into the lower window of the batch run manager dialog box will be executed during a batch
run. There is no need to select (highlight) the operations before running them. Conversely, selecting only some
operations in this window does not mean only those operations will be run.
Protected Elements Manager

The Protected Elements Manager provides a way of making certain elements in your model immune to skeletonization.
Use this feature to mark important elements in your model as not skeletonizable. Note that only pipes and junctions
may be protected from skeletonization since all other node elements (valves, pumps, tanks, reservoirs, and all
WaterGEMS V8i elements) are already immune to skeletonization. (TCVs are the noted exception to this rule and may
be treated as junctions, if selected, during Series Pipe Merging.)
335
Manual Skeletonization
If you click the Manual Skeletonization button, the Manual Skeletonization Review dialog box opens. The manual
skeletonization review dialog box lists the proposed skeletonization actions for the particular skeletonization process
selected. The contents of the action list window (to the left of the buttons) will vary depending on the type of operation
being run. For Smart Pipe Removal and Branch Collapsing, each Skelebrator action will have one pipe associated with
it, whereas Series and Parallel Pipe Merging will have two pipes associated with each action. For Smart Pipe Removal,
when network integrity is enforced, the contents of the action list are updated, after every executed action, to reflect
only valid actions, after each action is performed.
336
Go ToSelect an element in the element window and click Go To to jump to the element in WaterGEMS V8i.
WaterGEMS V8i displays the element at the level of zoom you selected in the Zoom drop-down list.
NextClick Next to preview the next element in the Manual Skeletonization Review dialog box.
PreviousClick Previous to preview the previous element to the one you have selected in the Manual
Skeletonization Review dialog box.
ProtectClick Protect to protect the selected element. Protected elements cannot be deleted from the network by
skeletonization. In a Series or Parallel Pipe Merging operation, protecting one pipe in an action will mean that the
action will not be able to be executed. The remaining un-protected pipe will not be skeletonized during this
skeletonization level; however, it is not precluded from subsequent skeletonization levels unless it also is protected.
ExecuteClick Execute to run Skelebrator only for the selected Skelebrator action. In the case of Smart Pipe
Removal and Branch Collapsing, the associated pipe will be removed from the model and associated loads
redistributed as specified. Additionally, for branch collapsing, one junction will be removed. For Series Pipe
Merging, two pipes and one junction will be removed, associated loads redistributed as specified and an equivalent
pipe added as a replacement, if the option is selected. Otherwise, the properties of the dominant pipe will be used to
create a new pipe. For Parallel Pipe Merging, one pipe will be removed and the remaining pipe will be updated to
the hydraulic equivalent, if you selected hydraulic equivalency.
Auto Next?Select this check box if you wish for Skelebrator to immediately advance to the next pipe element in
the action list. This is the equivalent of clicking Execute then clicking Next immediately afterwards.
CloseClick Close to exit the Manual Skeletonization Review dialog box. Any remaining actions listed will not be
executed.
ZoomSelect a Zoom at which you want to display elements you preview using Go To, Previous, and Next.
Branch Collapsing Operations

When you add or edit a Branch Collapsing operation, the Branch Collapsing Operation Editor dialog box opens. Branch
Collapsing operations have two sets of parameters, Settings and Conditions.
337
1. Click the Settings tab to edit settings.
Maximum Number of Trimming LevelsSet the maximum number of trimming levels you want to allow. In
Branch Collapsing, a single trimming level run to completion would trim every valid branch in the model back
by one pipe link. Two trimming levels would trim every valid branch back two pipe links and so on.
Load Distribution StrategySelect what you want to do with the hydraulic load on the sections you trim. The
choices are Don't Move Load, which means that the demands are no longer included in the model, or Move
Load, which means transfer the demands to the upstream node
338
2. Click Conditions to edit or create conditions.
3. Click Add to add conditions. You can add pipe and/or junction conditions. You can add more than one condition.
4. Or, select an existing condition and click Edit to modify a selected condition. You can add and edit Junction and
Pipe Conditions. You can set select parameters that determine which pipes are included in the skeletonizing process
in the Conditions tab. In Branch Collapsing, the junctions referred to (in junction conditions) are the two end
junctions of the pipe being trimmed. Tolerances can also be defined for junctions. Tolerances work by limiting the
pipes skeletonized only to the ones that have the specified attribute within the specified tolerance. For example, in
Branch Collapsing a tolerance on junction elevation of 3 feet would limit skeletonization to pipes that had both end
junctions with an elevation within three feet of each other.
Parallel Pipe Merging Operations
Note: In Stand-Alone mode, you can assign prefixes and/or suffixes to pipes and junctions created during
Parallel Pipe Merging operations by using the Element Labeling feature. For instance, to assign a prefix of "sk" to
all pipes that are merged using the Parallel Pipe Merging operation, open the Element Labeling dialog box and
enter "sk" before the "P-" in the Prefix field of the Pressure Pipe row. Any pipes merged during the Parallel Pipe
Merging will now be labeled "skP-1"," skP-2", etc.
When you add or edit a Parallel Pipe Merging operation, the Parallel Pipe Merging Operation Editor controls become
active in the control pane on the right.
339
Operations have two sets of parameters, Settings and Conditions.

1. Click Settings to edit or create settings.
2. Click Add to add a new pipe condition.
3. Or, select a condition and click Edit to change its parameters.
The condition editor allows you to set select parameters that determine which pipes are included in the skeletonization
process.
Maximum Number of Removal LevelsSet the maximum number of removal levels you want to allow. In the context
of Parallel Pipe Merging a single removal level will merge two parallel pipes. Consider a case where there exists 4
pipes in parallel. It would take 3 removal levels to merge all 4 pipes into a single pipe. In the first removal level, two
pipes are merged leaving three pipes. In the second level another two pipes are merged leaving only two pipes. The last
340
two pipes are merged into a single pipe in the third removal level. Unless you have a large degree of parallel pipes in
your model, one or two levels of Parallel Pipe Merging will generally be all that is necessary to merge the majority of
parallel pipes in your system.
Dominant Pipe CriteriaSelect the criteria by which Skelebrator determines the dominant pipe. The dominant pipe is
the pipe whose properties are retained as appropriate. For example, when merging a 6-in. pipe and an 8-in. pipe, if
diameter is selected as the dominant pipe criteria then the larger diameter pipe (e.g., 8-in.) will provide the properties
for the new pipe. That is, the 8-in. pipe's diameter, roughness, bulk reaction rate, etc., will be used for the new pipe.
Use Equivalent PipesSelect Use Equivalent Pipe if you want Skelebrator to adjust remaining pipes to accommodate
the removal of other pipes in series.
Equivalent Pipe MethodSelect whether you wish to modify the dominant pipe roughness or the dominant pipe
diameter for the equivalent pipe calculations.
Modify Diameter
Modify Roughness
If modify diameter is selected, the new pipe's roughness is kept constant and the diameter adjusted such that the head
loss through the pipe remains constant. Conversely, if modify roughness is selected, the new pipe's diameter is kept
constant and the roughness adjusted such that the head loss through the pipe remains constant.
Note: When using Darcy-Weisbach for the friction method, Modify Diameter is the only available selection since
calculated equivalent roughness can be invalid (negative) in some circumstances.
Minor Loss StrategyIf your network models minor losses, select what you want Skelebrator to do with them.
Use Ignore Minor Losses if you want to ignore any minor losses in parallel pipes. Resulting merged pipes will have
a minor loss of 0.
Use Skip Pipe if Minor Loss > Max to protect from skeletonization any pipes that have a higher minor loss than a
value you set for the Maximum Minor Loss.
Use 50/50 Split to apply 50% of the sum of the minor losses from the parallel pipes to the replacement pipe that
Skeletonizer uses.
Maximum Minor LossIf you select Skip Pipe if Minor Loss > Max from the Minor Loss Strategy drop-down list, any
pipes with a minor loss value greater than the value you set will not be removed by Skelebrator.
Series Pipe Merging Operations
Note: In Stand-Alone mode, you can assign prefixes and/or suffixes to pipes and junctions created during Series
Pipe Merging operations by using the Element Labeling feature. For instance, to assign a prefix of "sk" to all pipes
that are merged using the Series Pipe Merging operation, open the Element Labeling dialog box and enter "sk"
before the "P-" in the Prefix field of the Pressure Pipe row. Any pipes merged during the Series Pipe Merging will
now be labeled "skP-1"," skP-2", etc. Remember to reinstate the original prefixes/suffixes after skeletonization
has been performed.
When you add or edit a Series Pipe Merging operation, the Series Pipe Merging Operation Editor dialog box opens.
Operations have two sets of parameters, Settings and Conditions.
341
Maximum Number of Removal LevelsSelect the number of levels of pipes that get removed per iteration of
the Series Pipe Merging operation. The maximum number of removal levels is 50. This is because in the absence
of any other limiting factors (conditions, protected elements, non-removable nodes, etc.) one series pipe removal
iteration will effectively halve the number of pipes. A second iteration will again halve the number of pipes, and
so on. Therefore, 50 is the practical limit for removal levels.
Dominant Pipe CriteriaSelect the criteria by which Skelebrator determines the dominant pipe. The dominant
pipe is the pipe whose properties are retained as appropriate. For example, when merging a 6-in. pipe and an 8-
in. pipe, if diameter is selected as the dominant pipe criteria then the larger diameter pipe (e.g., 8-in.) will
provide the properties for the new pipe. That is, the 8-in. pipe's diameter, roughness, bulk reaction rate, etc. will
be used for the new pipe.
Use Equivalent PipesSelect Use Equivalent Pipe if you want Skelebrator to adjust the merged pipe properties
as such to attain equivalent hydraulics as the two merged pipes.
Equivalent Pipe MethodSelect whether you wish to modify the dominant pipe roughness or the dominant pipe
Modify Diameter - If modify diameter is selected, the new pipe's roughness is kept constant and the diameter
adjusted such that the head loss through the pipe remains constant.
Modify Roughness - If modify roughness is selected the new pipe's diameter is kept constant and the
roughness adjusted such that the head loss through the pipe remains constant.
Note: When using Darcy-Weisbach for the friction method, Modify Diameter is the only available
selection since calculated equivalent roughness can be invalid (negative) in some circumstances.
Load Distribution StrategySelect how you want the load distributed from junctions that are removed.
Equally Distributed puts 50% of the load on the starting and ending junctions of the post-skeletonized pipe.
342
Proportional to Dominant Criteria assigns loads proportional to the attribute used to select the dominant pipe.
For example, if diameter is the dominant attribute and one pipe is 6-in., while the other is 8-in. (14-in. total
length), 8/14 of the load will go to the upstream node, while 6/14 will go to the downstream node.
Note: For the length attribute, load assignment is inversely proportional, such that the closest junction
gets the majority of the demand.
Proportional to Existing Load maintains the pre-skeletonization load proportions.
User-Defined Ratio allows you to specify the percentage of the load applied to the upstream node in the post-
skeletonized pipe.
Note: If either of the uncommon nodes of the two pipes being merged are not junction nodes, then the
selected load distribution strategy is ignored and all load is moved to the junction node. If both
uncommon nodes are not junctions, then skeletonization is only carried out if the common junction
node has zero demand.
Upstream Node Demand ProportionSet a user-defined load distribution percentage. Set the percentage of the
node demand that you want applied to the upstream node adjacent to the removed sections. This parameter is
only available if you select User Defined in the Load Distribution Strategy drop-down list. Upstream in this
context relates to the physical topology of the pipe and its nodes and may not correspond to the direction of flow
in either the pre-skeletonized or post-skeletonized pipe.
Note: The resulting pipe from a Series Pipe Merging operation is routed in the same direction as the
dominant pipe. Therefore, upstream and downstream nodes relate to the topological direction of the
dominant pipe. If check valves are present, then the resulting pipe is routed in the direction of the pipe
that contains the check valve. If check valves are present in both pipes and those pipes oppose each other
then skeletonization is not performed.
Apply Minor LossesSelect Apply Minor Losses if you wish for Skelebrator to preserve any minor losses
attached to the pipes in your network. For Series Pipe Merging the minor losses for the original pipes are
summed and added to the resulting pipe. If this option is not selected then the minor loss of the resulting pipe
will be set to zero.
Note: To combine only pipes with the same hydraulic characteristics (i.e., diameter and roughness), create
a Series Pipe Removal Operation and click the Conditions tab. Then, add a pipe tolerance condition of 0.0
and a roughness tolerance condition of 0.0. Also, make sure to deselect the Use Equivalent Pipes check
box.
Allow Removal of TCVsActivate this option by checking the box to allow Skelebrator to remove TCVs
during the Series Pipe Merging operation.
343
2. Click Conditions to edit or create conditions.
a. Click Add to add conditions. You can add pipe and/or junction conditions. You can add more than one
condition.
b. Or, select an existing condition and click Edit to modify a selected condition. You can add and edit Junction and
Pipe Conditions.
Note: In the case where not all nodes connected to the two pipes are junctions, tolerances are only
evaluated based upon the junction type nodes. For example, if a tolerance of 5gpm was defined this would
not invalidate the merging of two pipes that had one uncommon node that was a pump, for example. The
tolerance condition would be evaluated based only upon the two junction type nodes.
The Pipe Condition Editor allows you to set select parameters that determine which pipes are included in the
skeletonizing process. Tolerances can also be specified for both pipe and junction conditions.
In the context of series pipe merging, pipe tolerances are calculated between the specified attribute of the two pipes to
be merged. For example, a tolerance on diameter of 2-in. means that only pipes within a range of 2-in. diameter of each
other will be merged (i.e., a 6-in. and an 8-in. pipe would be merged, an 8-in. and a 12-in. pipe would not).
In the context of series pipe merging, junction tolerances are calculated on all present junctions. If all three nodes are
junctions, then all three junctions will be used to evaluate the tolerance. For example, a tolerance of 10 ft. on elevation
would mean that the two pipes would not be merged unless all of the three junctions had an elevation within 10 ft. of
each other.
Smart Pipe Removal Operations

When you add or edit a removal operation, the Smart Pipe Removal Operation Editor dialog box opens. Removal
operations have two sets of parameters, Settings and Conditions.
344
Note: We recommend that Smart Pipe Removal be performed with conditions defined. At the very least, a
limiting condition placed on pipe diameter should be used. Smart Pipe Removal is designed to allow removal of
small diameter pipes (including those that form parts of loops) and thus it is recommended that smart pipe
removal be used with a condition that limits the scope to only remove small diameter pipes.

Preserve Network IntegritySelect Preserve Network Integrity if you want Skelebrator to ensure the
topological integrity of your network will not be broken by a removal operation. All non-junction node elements
(valves, tanks, pumps and reservoirs) will remain connected to the network, and the network will not be
disconnected by Skelebrator. Total system demand will be preserved. Any junctions marked as non-removable
will also remain connected to the network.
Remove Orphaned NodesSelect Remove Orphaned Nodes if you want Skelebrator to find and automatically
remove any nodes left disconnected from the network after removal operations. (Orphaned or disconnected
nodes are solitary nodes no longer connected to any pipes. By virtue of the nature of pipe removal, junctions can
be left disconnected.) Note that Skelebrator does not remove any orphaned nodes that were orphaned prior to
skeletonization. This option is not available if the preserve network integrity is not selected. If you leave this
option unchecked, your model will contain junctions not physically connected to the hydraulic network, which
will result in warning messages when you run your model.
Loop Retaining SensitivityAdjust the loop retaining sensitivity in order to control how sensitive the pipe
removal algorithm is to retaining loops in your model. The lower the setting is, and in the absence of any other
limiting conditions, the higher number of loops will be retained in your model (i.e., loops are less likely to be
broken). Conversely, a higher setting will favor retaining less loops in your model. Use this setting in tandem
with Skelebrator's preview feature to get a feel for the effect of the various settings. This option is only available
if you have selected the Preserve Network Integrity option.
2. Click Conditions to edit or create pipe conditions. You can add more than one condition.
345
3. Click Add to add pipe conditions. You can add more than one condition.
4. Or, select an existing condition and click Edit to modify a selected condition.
The condition editor allows you to define pipe conditions that determine which pipes are included in the Smart Pipe
Removal process. It is acceptable to define an operation that has no conditions (the default). In this case no pipes will
be excluded from the skeletonization based on any of their physical attributes alone.
Inline Isolating Valve Replacement

In many GIS models, isolating valves split pipes into two segments, creating large numbers of redundant pipes that
affect model performance and unnecessarily increase model complexity. This feature allows you easily remove the
isoation valves, merge the adjacent pipe segments, and assign new isolation valve elements to the newly created pipes.
When you add or edit an Inline Isolating Valve Replacement operation, the Inline Isolating Valve Replacement
Operation Editor dialog box opens. Operations have two sets of parameters, Settings and Conditions.
The Settings tab consists of the following controls:

Allow Isolation Valve replacement of the following valve types: Check the boxes for each of the valve types
(TCV, PBV, GPV) that you want Skelebrator to replace with isolation valves.
Maximum Number of Removal Levels: Set the maximum number of pipe segments to remove for each isolation
valve in the original model.
Dominant Pipe Criteria: Select the criteria by which Skelebrator determines the dominant pipe (the one that will
be kept after the operation). The dominant pipe is the pipe whose properties are retained as appropriate. For
example, when merging a 6-in. pipe and an 8-in. pipe, if diameter is selected as the dominant pipe criteria then the
346
larger diameter pipe (e.g., 8-in.) will provide the properties for the new pipe. That is, the 8-in. pipe's diameter,
roughness, bulk reaction rate, etc., will be used for the new pipe
Use Equivalent Pipes: Select Use Equivalent Pipe if you want Skelebrator to adjust remaining pipes to
accommodate the removal of other pipes in series.
Equivalent Pipe Method: Select whether you wish to modify the dominant pipe roughness or the dominant pipe
Apply Minor Losses: When this box is checked minor losses associated with the newly created valve will be
applied.
Conditions and Tolerances

Conditions and Tolerances are used in Skelebrator to define the scope of Skelebrator operations. They consist of an
attribute (e.g., diameter), an operator (e.g., less than) and a unitized value (e.g., 6 inches). These values together define
the effect of the condition. The examples just listed when combined into a condition would reduce the scope of an
operation to only skeletonizing pipes with a diameter less than 6 inches.
A condition is able to be assessed based on a single element type, regardless of topology. It is possible to assess
whether pipes meet the specified condition of diameter less than 6 inches without knowing the pipes location in the
hydraulic model. Tolerances, however, are different. They are assessed based on the ensuing topology, and thus, the
meaning of a tolerance varies depending on Skelebrator operation type. Additionally, the tolerance operator is not
available when it doesnt make sense. For example, it does not make sense to define a pipe tolerance for Smart Pipe
Removal since only a single pipe is being considered at a time. An example of a valid tolerance is for Branch
Collapsing where a junction tolerance can be specified between the two end junctions of the pipe.
Conditions and tolerances are cumulative. That is with every additional condition, the number of pipes able to be
skeletonized will be reduced. Setting conflicting conditions such as diameter < 6-in. and diameter > 8-in. will result in
no pipes being able to be skeletonized since conditions are joined with the logical AND operator. It is not possible to
specify OR conditions or tolerances.
It is possible to specify no conditions for a particular operation. In that case all pipes are valid for skeletonization based
on their physical attributes.
However, conditions and tolerances are not the only elements that determine whether a pipe will be skeletonized. For a
pipe to be skeletonized it has to meet all of the following criteria:
Be valid in terms of the network topology with respect to the particular skeletonization operation. That is, during
Branch Reduction the pipe has to be part of a branch. Any pipes whose topology dictates they are not part of a
branch will not be skeletonized.
Must not be an element that is inactive as part of a topological alternative. All inactive topological elements are
immune to skeletonization.
Must not be referenced by a logical control, simple control, or calibration observed data set.
Must not be connected to a VSP control node or the trace node for WQ analysis.
Must not be a user-protected element.
Must meet all user defined conditional and tolerance criteria.
Pipe Conditions and Tolerances

Click Add to add conditions. You can add more than one condition.
AttributeSelect the Attribute that you want to use to determine which pipes to skeletonize. These include:
Bulk Reaction Rate
347
Diameter
Has Check Valve
Installation Year
Length
Material
Minor Loss Coefficient
Roughness
Wall Reaction Rate.
OperatorSelect an operator that defines the relationship between the attribute you select and the value you select for
that attribute. For example, if you select an attribute of Diameter, an operator of Less Than, and a value of 6 in., then
any pipes with less than a 6-in. diameter are valid for skeletonization. Depending on operation type, Tolerance may also
be an option for operator. When using a tolerance, a tolerance (as opposed to a condition) is defined. For example, in
the context of Series Pipe Merging where two pipes are being merged, a tolerance of 2-in. diameter means that those
pipes will only be merged if their diameters are within 2-in. of each other.
ValueThe label, units, and appropriate value range depend on the attribute you select.
Junction Conditions and Tolerances

You can set selective parameters that determine which junctions are included in Branch Collapsing, Parallel Pipe
Merging and Series Pipe Merging operations. Click Add to activate.
AttributeSelect the Attribute that you want to use to determine which junctions to trim. These include:
Base Flow
Elevation
Emitter Coefficient.
OperatorSelect an operator that defines the relationship between the attribute you select and the value you select for
that attribute. For example, if you select an attribute of Base Demand, an operator of Less Than, and a value of 50 gpm,
any pipes with end nodes with a base demand less than 50 gpm are valid for skeletonization.
ValueThe label, units, and appropriate value range depend on the attribute you select.
Junction tolerances are only evaluated against junctions. For example, if two series pipes are to be merged but their
common node is a pump, any defined junction tolerance is evaluated based on the two end nodes only.
Where only one junction exists, as may be the case when allowing skeletonization of TCVs, tolerance conditions are
not evaluated and do not limit the scope of the skeletonization.
Skelebrator Progress Summary Dialog Box

This dialog box opens following the successful completion of an automatic skeletonization operation. The text pane
provides information concerning the operation that was performed, including the model name, date, the length of time
the operation took to run, and the number of elements that were modified.
348
Click the Save Statistics button on the Statistics tab to save the summary to a text file. Click the Copy Statistics button
to copy the summary to the Windows clipboard. The Messages tab displays warning, error, and success messages as
applicable.
Backing Up Your Model
In ArcGIS (ArcCatalog or ArcMap), there is no ability to undo your changes after they have been made. Skelebrator
makes transactions against the GEMS database without the ability to rollback those changes. From within WaterGEMS
V8i, changes can be undone on a global level by not saving the model after skeletonizing. However, any changes made
prior to skelebration will also be lost if this method of avoiding committing skeletonization changes is used.
Making a copy of your model up front will ensure that you can always get back to your original model if problems
occur.
Note: We strongly recommended that you first make a copy of your model as a safe guard before proceeding
with Skelebration.
Skeletonization and Scenarios

Skelebrator is designed to skeletonize a single scenario at a time. Specifically, skelebrator modifies information in the
set of alternatives (topological, demand, physical etc.) that are referred to by the currently selected scenario. It follows
that any other scenarios that refer to these alternatives in some way can also potentially be modified by skeletonization
but most likely in an undesirable and inconsistent way, since skeletonization only works on the data in the alternatives
referenced by the currently active scenario.
349
For example, a second scenario that references all the same alternatives as the scenario being skeletonized except for,
say, the demand alternative, will itself be seemingly skeletonized (its topological and physical alternatives, etc. are
modified) except that the values of demands in its local demand records have no way of being factored into the
skeletonization process. Due to this, demands may actually be lost since pipes that were deleted (e.g., dead ends) did
not have their local demands relocated upstream. Relocated demands will represent the result of merging the demands
in the parent alternative and not those of the child alternative where local records are present.
Due to the behavior of skeletonization with respect to scenarios and alternatives and to save possible confusion after
skeletonization, it is very strongly recommended that you eliminate all other scenarios (other than the one to be
skeletonized) from the model prior to skeletonization. Some exceptions, however, exist to this recommendation and
may provide some additional flexibility to those users who have a strong desire to skeletonize multiple scenarios. In
general, it is strongly recommended that multiple scenario skeletonization be avoided.
A multiple scenario model can be successfully skeletonized only if all of the following conditions are met:
All scenarios all belong to the same parent-child hierarchy
The scenario being selected for skeletonization must contain only parent (base) alternatives
All elements that reference local records in any child alternative are protected from skeletonization.
As a simple example, consider a model with two scenarios, Base and Fire Flow. The Base scenario references a set of
parent (base) alternatives, and the Fire Flow scenario references all the same alternatives, except for the demand
alternative, where it references a child alternative of the Base scenario demand alternative, with local records at
junctions A-90 and A-100 which are to model the additional flow at the fire flow junctions. This model meets all of the
above 3 conditions and thus skeletonization of this model can be conducted successfully for all scenarios in the model,
but only if all of the following skeletonization rules are adhered to:
The Base scenario is always selected for skeletonization
The elements associated with local demand records (i.e., junctions A-90 and A-100 in our example) are protected
from skeletonization using the Skelebrator element protection feature.
The reason the base scenario (a) must be selected for skeletonization is so that only parent (base) alternatives are
modified by skeletonization. This is so that changes made to alternatives propagate down the parent-child hierarchy. If
skeletonization was to occur on a scenario that referenced child alternatives, then the changes made to the scenario will
not propagate back up the parent-child hierarchy and would result in incorrect results.
The reason for the element protections (b) is to limit the scope of skeletonization to the data common to both scenarios.
That is, any model elements that possess any local records in any referenced child alternative are excluded from the
skeletonization since the differences in properties between the child and parent alternatives cannot be resolved in a
skeletonization process that acts for all intents and purposes on a single scenario. This idiom can be extended to other
alternative types besides the demand alternative.
Note: Before you use Skelebrator, we strongly recommended that you eliminate from your model all scenarios
other than the one to be skeletonized.
Importing and Exporting Skelebrator Settings

Skeletonization settings can be saved and restored by using Skelebrator's import/export feature. This feature allows all
skeletonization settings to be retained and reused later on the same computer or on different computers as required.
In addition to saving skelebrator operations and batch run settings, protected element information is saved. Ideally, this
information should be stored only with the model that it pertains to, because it only makes sense for that model, but that
limitation would prevent skelebrator settings to be shared between different projects or users. The caveat of allowing
protected element information to be saved in a file that is separate to the original model and thus be able to be shared
350
between users, is that the situation is created whereby importing a .SKE file that was created with another model can
result in meaningless protected element information being imported in the context of the new model.
However, your protected element information will probably be valid if you import a skelebrator .SKE file that was
created using the same original model, or a model that is closely related to the original. The reason for this is that
protected element information is stored in a .SKE file by recording the element's GEMS IDs from the GEMS database.
For the same or closely related models, the same pipes and junctions will still have the same GEMS IDs and so, will
remain correctly protected.
Protected element behavior for imported files is not guaranteed because a potential problem arises when elements that
were deleted from the model were previously marked as protected and where the following three things have happened
in order:
1. Modeling elements (pipes, junctions) have been deleted from the model.
2. The model database is compacted (thus making available the IDs of deleted elements for new ones).
3. New elements (pipes, junctions) have been added to the model after compaction, potentially using IDs of elements
that have been deleted earlier.
From the above steps, it is possible that the IDs of new pipe or junction elements are the same as previously protected
and deleted elements, thereby causing the new elements to be protected from skeletonization when they should not
necessarily be protected.
Even though the above protected-element behavior is conservative by nature, it is recommended that you review
protected element information after importing a .SKE file to make sure that it is correct for your intended
skeletonization purposes.
Note: We strongly recommended that you review protected element settings when importing a .SKE file that was
created using a different model.
Skeletonization and Active Topology

Skeletonization occurs on only active topology but considers all topology. That is, any inactive topology of a model is
unable to be skeletonized but is not outright ignored for skeletonization purposes. This fact can be used to perform
spatial skeletonization. For example, if you only wish to skeletonize a portion of your model, you can temporarily
deactivate the topology you wish to be immune to skeletonization, remembering of course, to reactivate it after you
have completed the skeletonization process. Any points where inactive topology ties in to the active topology will not
be compromised. To better explain this, consider two series pipes that are not merged by series pipe removal. Under
most circumstances two series pipes that meet the following conditions will be skeletonized:
Meet topological criteria (e.g., that the two pipes are in series and have a common node that is legal to remove, i.e.,
not a tank, reservoir, valve or pump)
Meet all conditional and tolerance based criteria
Are not protected from skeletonization
Have a common node that is not protected from skeletonization
Have no simple control or logical control references
Have no calibration references including to the junctions they are routed between
Are routed between nodes that are free of references from variable speed pumps (VSPs)
Are routed between nodes that are free from Water Quality (WQ) trace analysis references
Are routed between nodes that represent at least one junction, if the common node is a loaded junction (so the load
can be distributed)
Do not have opposing check valves.
351
Scenarios and Alternatives
The two series pipes still may not be skeletonized if any inactive topology could be affected by the execution of the
skeletonization action. For example, if the two series pipes have an additional but inactive pipe connected to their
common node, and if the series pipe removal action was allowed to proceed, the common node would be removed from
the model, and the inactive topology would become invalid. This is prevented from occurring in Skelebrator.

To learn more about scenarios and alternatives, click the links below:
Understanding Scenarios and Alternatives
Scenarios and alternatives allow you to create, analyze, and recall an unlimited number of variations of your model. In
WaterGEMS V8i, scenarios contain alternatives to give you precise control over changes to the model.
Scenario management can dramatically increase your productivity in the "What If?" areas of modeling, including
calibration, operations analysis, and planning.
Advantages of Automated Scenario Management

In contrast to editing or copying data, automated scenario management using inheritance gives you significant
advantages:
A single project file makes it possible to generate an unlimited number of "What If?" conditions without becoming
overwhelmed with numerous modeling files and separate results.
The software maintains the data for all the scenarios in a single project so it can provide you with powerful
automated tools for directly comparing scenario results where any set is available at any time.
The Scenario/Alternative relationship empowers you to mix and match groups of data from existing scenarios
without having to re-declare any data.
You do not have to re-enter data if it remains unchanged in a new alternative or scenario, avoiding redundant copies
of the same data. It also enables you to correct a data input error in a parent scenario and automatically update the
corrected attribute in all child scenarios.
These advantages may not seem compelling for small projects, however, as projects grow to hundreds or thousands of
network elements, the advantages of true scenario inheritance become clear. On a large project, being able to maintain a
collection of base and modified alternatives accurately and efficiently can be the difference between evaluating optional
improvements or ignoring them.
A History of What-If Analyses

The history of what-if analyses can be divided into two periods: Distributed Scenarios and Self Contained Scenarios.
Distributed Scenarios
Traditionally, there have only been two possible ways of analyzing the effects of change on a software model:
Change the model, recalculate, and review the results
Create a copy of the model, edit that copy, calculate, and review the results.
352
Although either of these methods may be adequate for a relatively small system, the data duplication, editing, and re-
editing become very time-consuming and error-prone as the size of the system and the number of possible conditions
increase. Also, comparing conditions requires manual data manipulation, because all output must be stored in
physically separate data files.
Distributed Scenarios
Self-Contained Scenarios
Effective scenario management tools need to meet these objectives:
Minimize the number of project files the modeler needs to maintain.
Maximize the usefulness of scenarios through easy access to things such as input and output data, and direct
comparisons.
Maximize the number of scenarios you can simulate by mixing and matching data from existing scenarios (data
reuse).
353
Minimize the amount of data that needs to be duplicated to consider conditions that have a lot in common.
The scenario management feature in WaterGEMS V8i successfully meets all of these objectives. A single project file
enables you to generate an unlimited number of What If? conditions; edit only the data that needs to be changed and
quickly generate direct comparisons of input and results for desired scenarios.
Scenario Cycle
The process of working with scenarios is similar to the process of manually copying and editing data, but without the
disadvantages of data duplication and troublesome file management. This process lets you cycle through any number of
changes to the model, without fear of overwriting critical data or duplicating important information. Of course, it is
possible to directly change data for any scenario, but an audit trail of scenarios can be useful for retracing the steps of a
calibration series or for understanding a group of master plan updates.
Before Haestad Methods: Manual Scenarios
Scenario Attributes and Alternatives
354
AttributeAn attribute is a fundamental property of an object and is often a single numeric quantity. For example,
the attributes of a pipe include diameter, length, and roughness.
AlternativeAn alternative holds a family of related attributes so pieces of data that you are most likely to change
together are grouped for easy referencing and editing. For example, a physical properties alternative groups physical
data for the network's elements, such as elevations, sizes, and roughness coefficients.
ScenarioA scenario has a list of referenced alternatives (which hold the attributes) and combines these
alternatives to form an overall set of system conditions that can be analyzed. This referencing of alternatives enables
you to easily generate system conditions that mix and match groups of data that have been previously created.
Scenarios do not actually hold any attribute datathe referenced alternatives do.
A Familiar Parallel
Although the structure of scenarios may seem a bit difficult at first, if you have ever eaten at a restaurant, you should be
able to understand the concept. A meal (scenario) is comprised of several courses (alternatives), which might include a
salad, an entre, and a dessert. Each course has its own attributes. For example, the entre may have a meat, a
vegetable, and a starch. Examining the choices, we could present a menu as in the following figure:
The restaurant does not have to create a new recipe for every possible meal (combination of courses) that could be
ordered. They can just assemble any meal based on what the customer orders for each alternative course. Salad 1,
Entre 1, and Dessert 2 might then be combined to define a complete meal.
Generalizing this concept, we see that any scenario references one alternative from each category to create a big picture
that can be analyzed. Different types of alternatives may have different numbers and types of attributes, and any
category can have an unlimited number of alternatives to choose from.
Generic Scenario Anatomy
355
Inheritance
The separation of scenarios into distinct alternatives (groups of data) meets one of the basic goals of scenario
management: maximizing the number of scenarios you can develop by mixing and matching existing alternatives. Two
other primary goals have also been addressed: a single project file is used, and easy access to input data and calculated
results is provided in numerous formats through the intuitive graphical interface.
In order to meet the objective of minimizing the amount of data that needs to be duplicated, and in order to consider
conditions that have a lot of common input, you use inheritance.
In the natural world, a child inherits characteristics from a parent. This may include such traits as eye-color, hair color,
and bone structure.
Overriding Inheritance
A child can override inherited characteristics by specifying a new value for that characteristic. These overriding values
do not affect the parent and are therefore considered local to the child. Local values can also be removed at any time,
reverting the characteristic to its inherited state. The child has no choice in the value of his inherited attributes, only in
local attributes.
For example, a child has inherited the attribute of blue eyes from his parent. If the child puts on a pair of green tinted
contact lenses to hide his natural eye color, his natural eye color is overridden locally, and his eye color is green. When
the tinted lenses are removed, the eye color reverts to blue, as inherited from the parent.
Dynamic Inheritance
Dynamic inheritance does not have a parallel in the genetic world. When a parent's characteristic is changed, existing
children also reflect the change. Using the eye-color example, this would be the equivalent of the parent changing eye
color from blue to brown and the children's eyes instantly inheriting the brown color also. Of course, if the child has
already overridden a characteristic locally, as with the green lenses, his eyes will remain green until the lenses are
removed. At this point, his eye color will revert to the inherited color, now brown.
356
This dynamic inheritance has remarkable benefits for applying wide-scale changes to a model, fixing an error, and so
on. If rippling changes are not desired, the child can override all of the parent's values, or a copy of the parent can be
made instead of a child.
Local and Inherited Values

Any changes that are made to the model belong to the currently active scenario and the alternatives that it references. If
the alternatives happen to have children, those children will also inherit the changes unless they have specifically
overridden that attribute. The following figure demonstrates the effects of a change to a mid-level alternative. Inherited
values are shown as gray text, local values are shown as black text.
A Mid-level Hierarchy Alternative Change
Minimizing Effort through Attribute Inheritance

Inheritance has an application every time you hear the phrase, "just like x except for y." Rather than specifying all of
the data from x again to form this new condition, we can create a child from x and change y appropriately. Now we
have both conditions, with no duplicated effort.
We can even apply this inheritance to our restaurant analogy as follows. Inherited values are shown as gray text, local
values are shown as black text.
Note: Salad 3 could inherit from Salad 2, if we prefer: "Salad 3 is just like Salad 2, except for the dressing."
"Salad 2 is just like Salad 1, except for the dressing."

"Salad 3 is just like Salad 1, except for the dressing."If the vegetable of the day changes (say from green beans to
peas), only Entre 1 needs to be updated, and the other entres will automatically inherit the vegetable attribute of
357
"Peas" instead of "Green Beans."
"Entre 2 is just like Entre 1, except for the meat and the starch."
"Dessert 2 is just like Dessert 1, except for the topping."
Minimizing Effort through Scenario Inheritance

Just as a child alternative can inherit attributes from its parent, a child scenario can inherit which alternatives it
references from its parent. This is essentially still the phrase just like x except for y, but on a larger scale.
Carrying through on our meal example, consider a situation where you go out to dinner with three friends. The first
friend places his order, and the second friend orders the same thing except for the dessert. The third friend orders
something totally different, and you order the same meal as hers except for the salad.
The four meal scenarios could then be presented as follows (inherited values are shown as gray text, local values are
shown as black text.
"Meal 2 is just like Meal 1, except for the dessert." The salad and entre alternatives are inherited from Meal 1.
"Meal 3 is nothing like Meal 1 or Meal 2." A totally new base or root is created.
"Meal 4 is just like Meal 3, except for the salad." The entre and dessert alternatives are inherited from Meal 3.
Scenario Example - A Water Distribution System
A water distribution system where a single reservoir supplies water by gravity to three junction nodes.
Example Water Distribution System
358
Although true water distribution scenarios include such alternative categories as initial settings, operational controls,
water quality, and fire flow, the focus here is on the two most commonly changed sets of alternatives: demands and
physical properties. Within these alternatives, the concentration will be on junction baseline demands and pipe
diameters.
Building the Model (Average Day Conditions)

During model construction, only one alternative from each category is going to be considered. This model is built with
average demand calculations and preliminary pipe diameter estimates. You can name the scenario and alternatives, and
the hierarchies look like the following (showing only the items of interest):
Analyzing Different Demands (Maximum Day Conditions)

In this example, the local planning board also requires analysis of maximum day demands, so a new demand alternative
is required. No variation in demand is expected at J-2, which is an industrial site. As a result, the new demand
alternative can inherit J-2s demand from Average Day while the other two demands are overridden.
359
Now we can create a child scenario from Average Day that inherits the physical alternative but overrides the selected
demand alternative. As a result, we get the following scenario hierarchy:
Since no physical data (pipe diameters) have been changed, the physical alternative hierarchy remains the same as
before.
Another Set of Demands (Peak Hour Conditions)

Based on pressure requirements, the system is adequate to supply maximum day demands. Another local regulation
requires analysis of peak hour demands with slightly lower allowable pressures. Since the peak hour demands also
share the industrial load from the Average Day condition, Peak Hour can be inherited from Average Day. In this
instance, Peak Hour could also inherit from Maximum Day.
Another scenario is also created to reference these new demands, as shown below:
No physical data was changed, so the physical alternatives remain the same.
Correcting an Error
This analysis results in acceptable pressures until it is discovered that the industrial demand is not actually 500 gpmit
is 1,500 gpm. However, due to the inheritance within the demand alternatives, only the Average Day demand for J-2
360
needs to be updated. The changes effect the children. After the single change is made, the demand hierarchy is as
follows:
Notice that no changes need to be made to the scenarios to reflect these corrections. The three scenarios can now be
calculated as a batch to update the results.
When these results are reviewed, it is determined that the system does not have the ability to adequately supply the
system as it was originally thought. The pressure at J-2 is too low under peak hour demand conditions.
Analyzing Improvement Suggestions

To counter the headloss from the increased demand load, two possible improvements are suggested:
A much larger diameter is proposed for P-1 (the pipe from the reservoir). This physical alternative is created as a
child of the Preliminary Pipes alternative, inheriting all the diameters except P-1s, which is overridden.
Slightly larger diameters are proposed for all pipes. Since there are no commonalities between this recommendation
and either of the other physical alternatives, this can be created as a base (root) alternative.
These changes are then incorporated to arrive at the following hierarchies:
This time the demand alternative hierarchy remains the same since no demands were changed. The two new scenarios
(Peak, Big P-1, Peak, All Big Pipes) can be batch run to provide results for these proposed improvements.
Finalizing the Project

It is decided that enlarging P-1 is the optimum solution, so new scenarios are created to check the results for average
day and maximum day demands. Notice that this step does not require handling any new data. All of the information
we want to model is present in the alternatives we already have!
361
Also note that it would be equally effective in this case to inherit the Avg. Day, Big P-1 scenario from Avg. Day
(changing the physical alternative) or to inherit from Peak, Big P-1 (changing the demand alternative). Likewise, Max.
Day, Big P-1 could inherit from either Max. Day or Peak, Big P-1.
Neither the demand nor physical alternative hierarchies were changed in order to run the last set of scenarios, so they
remain as they were.
Scenarios
A Scenario contains all the input data (in the form of Alternatives), calculation options, results, and notes associated
with a set of calculations. Scenarios let you set up an unlimited number of What If? situations for your model, and
then modify, compute, and review your system under those conditions.
You can create an unlimited number of scenarios that reuse or share data in existing alternatives, submit multiple
scenarios for calculation in a batch run, switch between scenarios, and compare scenario resultsall with a few mouse
clicks.
Scenarios Manager
The Scenario Manager allows you to create, edit, and manage an unlimited number of scenarios. There is one built-in
default scenariothe Base scenario. If you want, you only have to use this one scenario. However, you can save
yourself time by creating additional scenarios that reference the alternatives needed to perform and recall the results of
each of your calculations.
362
The Scenario Manager consists of a hierarchical tree view and a toolbar. The tree view displays all of the scenarios in
the project. If the Property Editor is open, clicking a scenario in the list causes the alternatives that make up the
scenario to open. If the Property Editor is not open, you can display the alternatives and scenario information by
selecting the desired scenario and right-clicking on Properties.
Opens a submenu containing the following commands:

Child Scenario creates a new Child scenario from the
New Scenario currently selected Base scenario. Base Scenario creates
a new Base scenario.
Removes the currently selected scenario, greyed out on

the menu bar when Base Scenario is active.
Delete
Renames the currently selected scenario.

Rename
Opens a submenu containing the following command:

Scenario calculates the currently selected scenario.
Compute Scenario
Causes the currently selected scenario to become the

active one and displays it in the drawing pane.
Make Current
Opens all scenarios within all folders in the list.

Expand All
Closes all of the folders in the list.

Collapse All
363
Displays online help for the Scenario Manager.

Help
Note: When you delete a scenario, you are not losing data records because scenarios never actually hold
calculation data records (alternatives do). The alternatives and data records referenced by that scenario exist
until you explicitly delete them. By accessing the Alternative Manager, you can delete the referenced alternatives
and data records.
Base and Child Scenarios

There are two types of scenarios:
Base ScenariosContain all of your working data. When you start a new project, you begin with a default base
scenario. As you enter data and calculate your model, you are working with this default base scenario and the
alternatives it references.
Child ScenariosInherit data from a base scenario or other child scenarios. Child scenarios allow you to freely
change data for one or more elements in your system. Child scenarios can reflect some or all of the values contained
in their parent. This is a very powerful concept, giving you the ability to make changes in a parent scenario that will
trickle down through child scenarios, while also giving you the ability to override values for some or all of the
elements in child scenarios.
Creating Scenarios
You create new scenarios in the Scenario Manager. A new scenario can be a Base scenario or a Child scenario. For
information about the differences between the two types of scenarios, see Base and Child Scenarios .
To create a new scenario:
1. Select Analysis > Scenarios to open the Scenario Manager, or click the Scenario Manager tab.
2. Click the New button and select whether you want to create a Base scenario or a Child Scenario. When creating a
Child scenario, you must first highlight the scenario from which the child is derived in the Scenario Manager tree
view. By default, a new scenario comprises the Base Alternatives associated with each alternative type.
3. Double-click the new scenario to edit its properties in the Property Editor.
Related Topics
Running Multiple Scenarios at Once (Batch Runs) (on page 365)
Scenario Manager
Editing Scenarios
You edit scenarios in two places in WaterGEMS :
The Scenario Manager lists all of the projects scenarios in a hierarchical tree format, and displays the Base/Child
relationship between them.
The Property Editor displays the alternatives that make up the scenario that is currently highlighted in the Scenario
Manager, along with the scenario label, any notes associated with the scenario, and the calculation options profile
that is used when the scenario is calculated.
To edit a scenario:
364
1. Select Analysis > Scenarios to open the Scenario Manager, or click the Scenario Manager tab.
2. Double-click the scenario you want to edit to display its properties in the Property Editor.
3. Edit any of the following properties as desired:
Related Topics
Running Multiple Scenarios at Once (Batch Runs) (on page 365)
Scenario Manager
Running Multiple Scenarios at Once (Batch Runs)

Performing a batch run lets you set up and run calculations for multiple scenarios at once. This is helpful if you want to
queue a large number of calculations, or manage a group of smaller calculations as a set. The list of selected scenarios
for the batch run remain with your project until you change it.
To perform a batch run:
1. Selecting View > Scenarios to open the Scenario Manager, or click the Scenario Manager tab.
2. Click the Compute Current Scenario button, then select Batch Run from the shortcut menu.
3. The Batch Run Editor dialog box appears.
4. Check the scenarios you want to run, then click the Batch button. Each scenario is calculated. You can cancel the
batch run between any scenario calculation. The selected scenarios run consecutively.
5. When the batch run is completed, the scenario that was current stays current, even if it was not calculated.
6. Select a calculated scenario from the Scenario toolbar drop-down list to see the results throughout the program.
Batch Run Editor Dialog Box
The Batch Run Editor dialog box contains the following controls:
Scenario List Displays a list of all current scenarios. Click the check
box next to the scenarios you want to run in batch mode.
Batch Starts the batch run of the selected scenarios.
Select Displays a drop-down menu containing the following

commands: Select All - Selects all scenarios listed. Clear
Selection - Clears all selected scenarios.
Close Closes the Batch Run Editor dialog box.
Help Displays context-sensitive help for the Batch Run Editor

dialog box.
Related Topics
Creating Scenarios (on page 364)
Editing Scenarios (on page 364)
Scenario Manager
365
Batch Run Editor Dialog Box

The Batch Run Editor dialog box contains the following controls:
Batch: Start the batch run of the selected scenarios.
Select: Display a menu containing the following commands:
Select All-Select all scenarios listed.
Clear Selection-Clear all selected scenarios.
Close: Close the Batch Run Editor dialog box.
Help: Display context-sensitive help for the Batch Run Editor dialog box.
Alternatives
Alternatives are the building blocks behind scenarios. They are categorized data sets that create scenarios when placed
together. Alternatives hold the input data in the form of records. A record holds the data for a particular element in your
system.
Scenarios are composed of alternatives as well as other calculation options, allowing you to compute and compare the
results of various changes to your system. Alternatives can vary independently within scenarios and can be shared
between scenarios.
Scenarios allow you to specify the alternatives you want to analyze. In combination with scenarios, you can perform
calculations on your system to see the effect of each alternative. Once you have determined an alternative that works
best for your system, you can permanently merge changes from the preferred alternative to the base alternative.
When you first set up your system, the data that you enter is stored in the various base alternative types. If you want to
see how your system behaves, for example, by increasing the diameter of a few select pipes, you can create a child
alternative. You can make another child alternative with even larger diameters and another with smaller diameters. The
number of alternatives that can be created is unlimited.
Note: WaterGEMS, WaterCAD, and HAMMER all use the same file format (.wtg). Because of this interoperability,
some alternatives are exposed within a product even though that data is not used in that product (data in the
Transient Alternative is not used by WaterGEMS, data in the Water Quality, Energy Cost, Flushing, etc.
alternatives is not used in HAMMER, etc.).
Alternatives Manager
The Alternative Manager allows you to create, view, and edit the alternatives that make up the project scenarios. The
dialog box consists of a pane that displays folders for each of the alternative types which can be expanded to display all
of the alternatives for that type and a toolbar.
366
The toolbar consists of the following:
Creates a new Alternative.

New
Deletes the currently selected alternative.

Delete
Creates a copy of the currently selected alternative.

Duplicate
Opens the Alternative Editor dialog box for the currently

selected alternative.
Open
Moves all records from one alternative to another.

Merge Alternative
Renames the currently selected alternative.

Rename
Generates a report of the currently selected alternative.

Report
Displays the full alternative hierarchy.

Expand All
Collapses the alternative hierarchy so that only the top-

level nodes are visible.
Collapse All
367
Displays online help for the Alternative Manager.

Help
Alternative Editor Dialog Box

This dialog box presents in tabular format the data that makes up the alternative being edited. Depending on the
alternative type, the dialog box contains a separate tab for each element that possesses data contained in the alternative.
Note: Note: As you make changes to records, the check box automatically becomes checked. If you want to reset
a record to its parent's values, clear the corresponding check box.
Many columns support Global Editing (see Globally Editing Data), allowing you to change all values in a single
column. Right-click a column header to access the Global Edit option. The check box column is disabled when you edit
a base alternative.
The Alternative Editor displays all of the records held by a single alternative. These records contain the values that are
active when a scenario referencing this alternative is active. They allow you to view all of the changes that you have
made for a single alternative. They also allow you to eliminate changes that you no longer need.
There is one editor for each alternative type. Each type of editor works similarly and allows you to make changes to a
different aspect of your system. The first column contains check boxes, which indicate the records that have been
changed in this alternative.
If the check box is selected, the record on that line has been modified and the data is local, or specific, to this
alternative.
If the check box is cleared, it means that the record on that line is inherited from its higher-level parent alternative.
Inherited records are dynamic. If the record is changed in the parent, the change is reflected in the child. The records on
these rows reflect the corresponding values in the alternative's parent.
Note that the tabs for element types that are not used in the current model are marked with an icon
Base and Child Alternatives

There are two kinds of alternatives: Base alternatives and Child alternatives. Base alternatives contain local data for all
elements in your system. Child alternatives inherit data from base alternatives, or even other child alternatives, and
contain data for one or more elements in your system. The data within an alternative consists of data inherited from its
parent and the data altered specifically by you (local data).
Remember that all data inherited from the base alternative are changed when the base alternative changes. Only local
data specific to a child alternative remain unchanged.
Creating Alternatives
New alternatives are created in the Alternatives Manager dialog box. A new alternative can be a Base scenario or a
Child scenario. Each alternative type contains a Base alternative in the Alternatives Manager tree view.
368
Note: For information regarding the differences between the two types of alternatives, see Base and Child
Alternatives .
To create a new Alternative:

1. Select View > Alternatives to open the Alternatives Manager, or click the Alternatives Manager tab.
2. To create a new Base alternative, highlight the type of alternative you want to create, then click the New button.
3. To create a new Child alternative, right-click the Base alternative from which the child will be derived, then select
New > Child Alternative from the submenu.
4. Double-click the new alternative to edit its properties in the Alternative Editor.
Related Topics
Editing Alternatives (on page 369)
Editing Alternatives
You edit the properties of an alternative in its own alternative editor. The first column in an alternative editor contains
check boxes, which indicate the records that have been changed in this alternative.
If the box is checked, the record on that line has been modified and the data is local, or specific, to this alternative.
If the box is not checked, it means that the record on that line is inherited from its higher-level parent alternative.
Inherited records are dynamic. If the record is changed in the parent, the change is reflected in the child. The records
on these rows reflect the corresponding values in the alternatives parent.
To edit an existing alternative, you can use one of two methods:
Double-click the alternative to be edited in the Alternatives Manager.
or
Highlight the alternative to be edited in the Alternatives Manager and click the Properties button.
In either case, the Alternative Editor dialog box for the specified alternative appears, allowing you to view and define
settings as desired.
Related Topics
Alternative Editor Dialog Box (on page 368)
Creating Alternatives (on page 368)
Active Topology Alternative

The Active Topology Alternative allows you to temporarily remove areas of the network from the current analysis. This
is useful for comparing the effect of proposed construction and to gauge the effectiveness of redundancy that may be
present in the system.
369
For each tab, the same setup applies-the tables are divided into four columns. The first column displays whether the
data is Base or Inherited, the second column is the element ID, the third column is the element Label, and the fourth
column allows you to choose whether or not the corresponding element is Active in the current alternative.
To make an element Inactive in the current alternative, clear the check box in the Is Active? column that corresponds to
that element's Label.
The following buttons are available:
Selection Set: Opens a submenu containing the following options:

Create Selection SetAllows you to create a new selection set.
370
Add to Selection SetAdds all of the elements in the current tab of the alternative to a previously created selection
set that you specify.
Remove from Selection SetRemoves 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 DrawingSelects the elements in the current tab of the alternative in the drawing pane.
Add to Current SelectionAdds 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 SelectionRemoves 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 SelectionSelects the element or elements that are both in the current tab of the alternative
Report: Generates a report containing the data within the current alternative.
Help: Opens the online help.

Creating an Active Topology Child Alternative
When creating an active topology child alternative, you may notice that the elements added to the child scenario
become available in your model when the base scenario is the current scenario.
To create an active topology alternative so that the elements added to the child scenario do not show up as part of the
base scenario:
1. Create a new project.
2. Open the Property Editor.
3. Open the Scenario Manager and make sure the Base scenario is current (active).
4. Create your model by adding elements in the drawing pane.
5. Create a new child scenario and a new child active topology alternative:
a. In the Scenario Manager, click the New button and select Child Scenario from the submenu.
b. The new Child Scenario is created and can be renamed.
c. In the Alternatives Manager, open Active Topology, select the Base Active Topology, right-click to select New,
then Child Alternative.
d. Rename the new Child Alternative.
6. In the Scenario Manager, select the new child scenario then click Make Current to make the child scenario the
current (active) scenario.
7. Add new elements to your model. These elements will be active only in the new child alternative.
8. To verify that this worked:
a. In the Scenario Manager, select the base scenario then click Make Current to make the base scenario the current
(active) scenario. The new elements are shown as inactive (they are grayed out in the drawing pane).
b. In the Scenario Manager, select the new child scenario then click Make Current to make the child scenario the
current (active) scenario. The new elements are shown as active.
Note: If you add new elements in the base scenario, they will show up in the child scenario.
371
Physical Alternative
One of the most common uses of a water distribution model is the design of new or replacement facilities. During
design, it is common to try several physical alternatives in an effort to find the most cost effective solution. For
example, when designing a replacement pipeline, it would be beneficial to try several sizes and pipe materials to find
the most satisfactory combination.
Each type of network element has a specific set of physical properties that are stored in a physical properties
alternative. To access the Physical Properties Alternative select Analysis > Alternatives and select Physical Alternative.
The Physical Alternative editor for each element type is used to create various data sets for the physical characteristics
of those elements.

372
Demand Alternatives
The demand alternative allows you to model the response of the pipe network to different sets of demands, such as the
current demand and the demand of your system ten years from now.
Initial Settings Alternative
373
The Initial Settings Alternative contains the data that set the conditions of certain types of network elements at the
beginning of the simulation. For example, a pipe can start in an open or closed position and a pump can start in an on or
off condition.


374
Operational Alternative
The Operational Alternative is where you can specify controls on pressure pipes, pumps, as well as valves.
375


Age Alternative
The Age Alternative is used when performing a water quality analysis for modeling the age of the water through the
pipe network. This alternative allows you to analyze different scenarios for varying water ages at the network nodes.
376


377
Constituent Alternatives
The Constituent Alternative contains the water quality data used to model a constituent concentration throughout the
network when performing a water quality analysis.
Selecting a constituent from the Constituent drop-down list provides default values for table entries. This software
provides a user-editable library of constituents for maintaining these values, which may be accessed by clicking the
Ellipsis (...) next to the Constituent menu.
The following attributes can be defined in the Constituent alternative:
Concentration (Initial) - The concentration at the associated node at the start of an EPS run.
Concentration (Base) - The concentration of the inflow into the system at the associated node. If there is no inflow,
then this flow does not affect constituent concentration.
Mass Rate (Base) - The mass per unit time injected at a node when the constituent source type is set to "Mass
Rate".
Constituent Source Type - there are four ways in which you can specify a constituent entering a system:
378
A concentration source fixes the concentration of any external inflow entering the network, such as flow from a
reservoir or from a negative demand placed at a junction.
A mass booster source adds a fixed mass flow to that entering the node from other points in the network.
A flow paced booster source adds a fixed concentration to that resulting from the mixing of all inflow to the
node from other points in the network.
A setpoint booster source fixes the concentration of any flow leaving the node (as long as the concentration
resulting from all inflow to the node is below the setpoint).
Pattern (Constituent) - The name of the constituent pattern created under Component > Patterns that the
constituent will follow. The default value is "Fixed".
Is Constituent Source? - This attribute should be set to True if the element is to be a source in the scenario. Setting
it to False will turn off the source even if there are values defined for Concentration (Base) or Mass Rate (Base).
Selection Set Opens a submenu containing the following options:

Create Selection SetAllows you to create a new
selection set.
Add to Selection SetAdds all of the elements in the
current tab of the alternative to a previously created
selection set that you specify.
Remove from Selection SetRemoves 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 DrawingSelects the elements in the
current tab of the alternative in the drawing pane.
Add to Current SelectionAdds 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 SelectionRemoves 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 SelectionSelects 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.
379
Constituents Manager Dialog Box

The Constituents manager allows you to:
Create new Constituents for use in Water Quality Analysis
Define properties for newly created constituents
Edit properties for existing constituents.
To open the Constituents manager
Choose Components > Constituents
or
Click the Constituents icon
from the Components toolbar.

The Constituents manager opens.
Trace Alternative
The Trace Alternative is used when performing a water quality analysis to determine the percentage of water at each
node coming from a specified node. The Trace Alternative data includes a Trace Node, which is the node from which
all tracing is computed.
380
Add to Selection SetAdds all of the elements in the current tab of the alternative to a previously created
Remove from Selection SetRemoves all of the elements in the current tab of the alternative from a
Select In Drawing: Opens a submenu containing the following options:
Add to Current SelectionAdds all of the elements in the current tab of the alternative to the group of elements
that are currently selected in the Drawing Pane.
Select Within Current SelectionSelects the element or elements that are both in the current tab of the
alternative and are already selected in the Drawing Pane.
Fire Flow Alternative

The Fire Flow Alternative contains the input data required to perform a fire flow analysis. This data includes the set of
junction nodes for which fire flow results are needed, the set of default values for all junctions included in the fire flow
set, and a record for each junction node in the fire flow set.
381
The Fire Flow Alternative window is divided into sections which contain different fields to create the fire flow. These
fields include:
Use Velocity Constraint?: If set to true, then a velocity constraint can be specified for the node.
Velocity (Upper Limit): Specifies the maximum velocity allowed in the associated set of pipes when drawing out fire
flow from the selected node.
Pipe Set: The set of pipes associated with the current node where velocities are tested during a fire flow analysis.
Fire Flow (Needed): Flow rate required at the junction to meet fire flow demands. This value will be added to the
junction's baseline demand or it will replace the junction's baseline demand, depending on the default setting for
applying fire flows.
Fire Flow (Upper Limit): Maximum allowable fire flow that can occur at a withdrawal location. This value will prevent
the software from computing unrealistically high fire flows at locations such as primary system mains, which have
large diameters and high service pressures. This value will be added to the junction's baseline demand or it will replace
the junction's baseline demand, depending on the default setting for applying fire flows.
Apply Fire Flows By: There are two methods for applying fire flow demands. The fire flow demand can be added to the
junction's baseline demand, or it can completely replace the junction's baseline demand. The junction's baseline demand
is defined by the Demand Alternative selected for use in the Scenario along with the fire flow alternative.
Fire Flow Nodes: A selection set that defines the fire flow nodes to be subject to a fire flow analysis. The selection set
must be a concrete selection set (not query based) and must include the junctions and hydrants that need to be analyzed.
Any non-junction and hydrant elements in the selection set are ignored.
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 a zone. The model determines
the available fire flow such that the minimum zone pressures do not fall below this target pressure. Each junction has a
zone associated with it, which can be located in the junction's input data. If you do not want a junction node to be
analyzed as part of another junction node's fire flow analysis, move it to another zone.
Use Minimum Pressure Zone Constraint?: Check whether a minimum pressure is to be maintained throughout the entire
pipe system.
Pressure System Lower Limit: Minimum pressure allowed at any junction in the entire system as a result of the fire
flow withdrawal. If the pressure at a node anywhere in the system falls below this constraint while withdrawing fire
flow, fire flow will not be satisfied.
Fire Flow Auxiliary Results Type: This setting controls whether the fire flow analysis will save "auxiliary results" (a
snap shot result set of the fire flow analysis hydraulic conditions) for no fire flow nodes, just the failing fire flow nodes,
if any, or all fire flow nodes. For every fire flow node that attracts auxiliary results a separate result set (file) is created.
When enabling this setting be conscious of the number of fire flow nodes in your system and the potential disk space
requirement. Enabling this option also will slow down the fire flow analysis due to the need to create the additional
results sets. Note: The base result set includes hydraulic results for the actual fire flow node and also for the pipes that
connect to the fire flow node. The results stored are for the hydraulic conditions that are experienced during the actual
fire flow analysis (i.e., under fire flow loading). No other hydraulic results are stored unless the auxiliary result set is
"extended" by other options listed below.
Use Extended Auxiliary output by Node Pressure Less Than: Defines whether to include in the stored fire flow
auxiliary results, results for nodes that fall below a defined pressure value. Such nodes might indicate low pressure
problems under the fire flow conditions.
Node Pressure Less Than?: Specifies the number.
382
Use Pipe Velocty greater Than: Defines whether to include in the stored fire flow auxiliary results, results for pipes that
exceed a defined velocity value. Such pipes might indicate bottle necks in the system under the fire flow conditions.
Pipe Velocity Greater Than: Specifies the number.
Auxiliary Output Selection Set: This selection set is used to force any particular elements of interest (e.g., pumps,
tanks) into a fire flow node's auxiliary result set, irrespective of the hydraulic result at that location. Said another way
this option defines which elements to always include in the fire flow auxiliary result set for each fire flow node that has
auxiliary results.
Fire Flow System Data
Each fire flow alternative has a set of default parameters that are applied to each junction in the fire flow set. When a
default value is modified, you will be prompted to decide if the junction records that have been modified from the
default should be updated to reflect the new default value.
The table consists of the following columns:
ID: Displays the unique identifier for each element in the alternative.
Label: Displays the label for each element in the alternative.
Specify Local Fire Flow Constraints?: Select this check box to allow input different from the global values. When you
select this check box, the fields in that row turn from yellow (read-only) to white (editable).
Velocity (Upper Limit): Specify the maximum velocity allowed in the associated set of pipes when drawing out fire
flow from the selected node.
Fire Flow (Needed): Flow rate required at a fire flow junction to satisfy demands.
Fire Flow (Upper Limit): Maximum allowable fire flow that can occur at a withdrawal location. It will prevent the
software from computing unrealistically high fire flows at locations such as primary system mains, which have large
diameters and high service pressures.
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 a zone. The model determines
the available fire flow such that the minimum zone pressures do not fall below this target pressure. Each junction has a
zone associated with it, which can be located in the junction's input data. If you do not want a junction node to be
analyzed as part of another junction node's fire flow analysis, move it to another zone.
Pressure (System Lower Limit): Minimum pressure to occur at all junction nodes within the system.
Filter Dialog Box

The Filter dialog box lets you specify your filtering criteria. Each filter criterion is made up of three items:
ColumnThe attribute to filter.
OperatorThe operator to use when comparing the filter value against the data in the specific column (operators
include: =, >, >=, <, <=, < >).
ValueThe comparison value.
Any number of criteria can be added to a filter. Multiple filter criteria are implicitly joined with a logical AND
statement. When multiple filter criteria are defined, only rows that meet all of the specified criteria will be displayed. A
filter will remain active for the associated table until the filter is reset.
383
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 will be highlighted.
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, and variable speed pump batteries 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.
384

385

Pressure Dependent Demand Alternative

The Pressure Dependent Demand Alternative allows a pressure dependent demand function to be used.

386

Transient Alternative
The Transient Alternative allows you to edit and view data that is used for WaterGEMS V8i transient calculations.
There is a tab for each element type, each containing the WaterGEMS V8i specific attributes for that element type.
387


Failure History Alternative

The Failure History alternative allows you to edit data associated with pipe break analysis.
388
Failure history properties include the following:

ID: Displays the unique identifier for each element in the alternative.
Label: Displays the label for each element in the alternative.
Use Local Duration of Pipe Failure History: When this box is checked the value entered in the corresponding Duration
of Pipe Failure History column will override the duration set in the Length of Pipe Break History field.
Number of Breaks: The number of pipe breaks in the duration of the pipe's failure history.
Cost of Break: The cost of each break in the duration of the pipe's failure history.
Pipe Break Group: The pipe break group to which the associated pipe belongs.
Duration of Pipe Failure History: The local duration of the pipe failure history. This column becomes editable for pipes
that have the Use Local Duration of Pipe Failure History? box checked.
389
User Data Extensions Alternative

The User Data Alternative allows you to edit the data defined in the User Data Extension command for each of the
network element types. The User Data Alternative editor contains a tab for each type of network element and is project
specific.
Add to Selection SetAdds all of the elements in the current tab of the alternative to a previously created
Remove from Selection SetRemoves all of the elements in the current tab of the alternative from a
Select In Drawing: Opens a submenu containing the following options:
Add to Current SelectionAdds all of the elements in the current tab of the alternative to the group of elements
that are currently selected in the Drawing Pane.
Select Within Current SelectionSelects the element or elements that are both in the current tab of the
alternative and are already selected in the Drawing Pane.
Scenario Comparison
The scenario comparison tool enables you to compare input values between any two scenarios to identify differences
quickly. While WaterGEMS/CAD/HAMMER users have previously had the capability to open a child scenario or
alternative and compare it with its parent, this tool greatly extends that capability in that you can compare any two
scenarios or alternatives (not necessarily parent-child) and very easily detect differences.
The scenario comparison tool can be started by picking Tools > Scenario Comparison or by selecting the Scenario
Comparison button from the toolbar
If the button is not visible, it can be added using the "Add or Remove Buttons" drop down from the Tools toolbar (see
Customizing WaterGEMS V8i Toolbars and Buttons (on page 25)).
On first opening the scenario comparison tool, the dialog below opens which gives an overview of the steps involved in
using the tool. Pick the New button (leftmost).
390
This opens a dialog which allows you to select which two scenarios will be compared.
The scenario manager button next to each selection gives you the ability to see the tree view of scenarios. Chose OK to
begin the scenario comparison tool. This initially displays a list of alternatives and calculation options, with the ones
with identical properties displayed with a yellow background and those with different properties displayed with a pink
background. The background color can be changed from pink to any other color by selecting the sixth button from the
left and then selecting the desired color.
The dialog below shows that the Active Topology, Physical, Demand and Constituent alternatives are different between
the scenarios. There is a second tab for Calculation Options which shows if the calculation options are different
between scenarios.
This display can also be copied to the clipboard using the Copy button.
The alternatives that have differences are also shown in the left pane with a red mark as opposed to the green check
indicating that there are no differences.
391
To obtain more detailed information on differences, highlight one of the alternatives and select the green and white
Compute arrow at the top of pane (fourth button).
This initially returns a summary of the comparison which indicates the time when the comparison was run, which
scenarios were involved and number of elements and attributes for which there were differences.
By picking "Differences" in the left pane for the alternative of interest, you can view the differences. In this display,
only the elements and properties that are different are shown with a pink background. In the example below, only 7
pipes had their diameters changed and only 3 of those had difference C-factors. There are separate tables for each
element type that had differences.
392
Using the buttons on top of the right pane, when Differences is selected, you can create a selection set of the elements
with differences or highlight those elements in the drawing. This is very useful for finding elements with differences in
a large model.
Scenario Comparison Options Dialog Box

This dialog box allows you to select the color used to highlight differences between the scenarios being compared in
the Scenario Comparison tool.
To choose another color, click the ellipsis button, select the new color from the palette, and click OK.
Scenario Comparison Collection Dialog Box

Some of the Differences types (such as Demand) may include collections of data (multiple demands within a single
Demand Collection). By clicking the ellipsis button next to one of these collections you can open this dialog, which
displays a table that breaks down the collection by the individual pieces of data.
393
Modeling Capabilities
To learn more about the software's modeling capabilities, click the links below:
Model and Optimize a Distribution System
WaterGEMS V8i provides modeling capabilities, so that you can model and optimize practically any distribution
system aspect, including the following operations:
Hydraulic Analysis
Perform a steady-state analysis for a snapshot view of the system, or perform an extended-period simulation to see
how the system behaves over time.
Use any common friction method: Hazen-Williams, Darcy-Weisbach, or Mannings methods.
Take advantage of scenario management to see how your system reacts to different demand and physical conditions,
including fire and emergency usage.
Control pressure and flow completely by using flexible valve configurations. You can automatically control pipe,
valve, and pump status based on changes in system pressure (or based on the time of day). Control pumps, pipes,
and valves based on any pressure junction or tank in the distribution system.
Perform automated fire flow analysis for any set of elements and zones in the network.
Calibrate your model manually, or use the Darwin Calibrator.
Generate capital and energy-cost estimates.
Compute system head curves.
Water Quality Analysis
Track the growth or decay of substances (such as chlorine) as they travel through the distribution network.
Determine the age of water anywhere in the network.
Identify source trends throughout the system.
Modeling capabilities include:
Steady-State/Extended Period Simulation (on page 395)
Global Demand and Roughness Adjustments (on page 399)
Check Data/Validate (on page 401)
Calculate Network (on page 399)
Flow Emitters (on page 406)
Parallel VSPs (on page 407)
Fire Flow Analysis (on page 408)
394
Water Quality Analysis (on page 412)

Calculation Options
Patterns (on page 464)
Controls (on page 468)
Active Topology (on page 480)
Steady-State/Extended Period Simulation
Bentley WaterGEMS V8i gives the choice between performing a steady-state analysis of the system or performing an
extended-period simulation over any time period.
Bentley HAMMER V8i can compute the initial conditions for your transient simulation, rather than requiring you to
enter them manually. When computing the initial conditions, HAMMER gives the choice between performing a steady-
state analysis of the system or an extended-period simulation over any time period.
Steady-State Simulation
Note:
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.
Extended Period Simulation

When the variation of the system attributes over time is important, an extended period simulation is appropriate. This
type of analysis allows you to model wet wells filling and draining, regulating valves opening and closing, and
pressures and flow rates changing throughout the system in response to varying load conditions and automatic control
strategies formulated by the software.
While a steady-state model may tell whether the system has the capability to route calculated loads, an extended period
simulation indicates whether the system has the ability to provide acceptable levels of service over a period of minutes,
hours, or days.
Data requirements for extended period simulations are greater than for steady-state runs. In addition to the information
required by a steady-state model, you also need to determine load patterns and operational rules for pumps and valves.
The following additional information is required only when performing Extended Period Simulation, and therefore is
not enabled when Steady-State Analysis has been specified.
Start TimeSelect the clock time at which the simulation begins.
DurationSpecify the total duration of an extended period simulation.
Hydraulic Time StepSelect the length of the calculation time step.
Override Reporting Time Step?Set to true if you want the Reporting Time Step to differ from the Hydraulic Time
Step.
395
Reporting Time StepData will be presented at every reporting time step. The reporting time step should be a
multiple of the hydraulic time step.
Note: If you run an Extended Period Simulation, you can generate graphs of the domain elements in the results
by right-clicking an element and selecting Graph.
Note: Each of the parameters needed for an extended period analysis has a default value. You will most likely
want to change the values to suit your particular analysis.
Occasionally the numerical engine will not converge during an extended period analysis. This is usually due to controls
(typically based on tank elevations) or control valves (typically pressure regulating valves) toggling between two
operational modes (on/off for pump controls, open/closed for pipe controls, active/closed for valves). When this occurs,
try adjusting the hydraulic time step to a smaller value. This will minimize the differences in boundary conditions
between time steps, and may allow for convergence.
Time Browser
The Time Browser dialog box is where you can change the currently displayed time step and animate the main drawing
pane.
Choose Analysis > Time Browser to open the dialog box.
The dialog box contains the following controls:
Time Display Shows the current time step that is displayed in the
drawing pane.
Time Slider Manually moves the slider representing the currently

displayed time step along the bar, which represents the
full length of time that the scenario encompasses.
Go to start Sets the currently displayed time step to the beginning of

the simulation.
Play backward Sets the currently displayed time step from the end to the
beginning.
396
Step backward Returns the currently displayed time step to the previous
time step.
Pause/Stop Stops the animation. Restarts it again with another click.
Step Advances the currently displayed time step to the

following time step.
Play Advances the currently displayed time step from

beginning to end.
Go to end Sets the currently displayed time step to the end of the
simulation.
Speed Slider Controls the length of the delay between time steps during
animations.
Options Opens the Time Browser Options dialog box where

Increments and Looping Options can be set.
Help Opens online help.
Time Step Pane Lists each time step in the simulation. Clicking a time
step sets it as current.
Time Browser Options
This dialog box is where you define the animation settings that are applied when the drawing pane is animated. Click
Options from Time Browser.
It contains the following controls:
Frame Options
397
Increment Controls the smoothness of the animation. Each time step

in a scenario counts as one animation frame. Use this
slider to specify the number of frames that are skipped for
each step in the animation. For example, if there are time
steps every 3 minutes in the scenario and the slider is set
at 3 frames, each step in the animation represents 9
minutes of scenario time when you click the Play button.
Looping Options
No Loop Stops the animation at the end of the simulation, if

selected.
Loop Animation Restarts the animation automatically, if selected. When

this option is selected, the animation reaches the end of
the simulation and then restarts from the beginning.
Rocker Animation Restarts the animation automatically in reverse. When

this option is selected, the animation reaches the end of
the simulation and then plays the simulation in reverse.
When the beginning of the simulation is reached, the
animation advances towards the end again and will do so
continually.
Steady State Run

This feature allows you to obtain a hydraulic steady state from the data in your WaterGEMS V8i model. When the
Steady button is selected in the Type of Run area of the Run dialog box, the model data is sent to the steady state
solver so it can begin the calculations. If errors are encountered, the steady state solver will show a dialog box with a
list of messages. Prior to a steady state run:
Steady State OptionsThe parameters that control the steady state hydraulic computations are similar to those in
WaterGEMS V8i. They can be modified using the Tools > Project Options menu command and clicking the Steady
State tab:
Steady State Trials is set for maximum accuracy by default. We recommend you not modify this setting. This is
similar to the setting in WaterGEMS V8i.
Steady State Accuracy is set for maximum accuracy by default. We recommend you not modify this setting. This is
similar to the setting in WaterGEMS V8i.
Pump Curves Linear Mode is either True or False. If True, the steady state solver uses linear interpolation to
estimate the curve if the solution lies between points entered in the pump table. This method is consistent with the
transient solver in WaterGEMS V8i.
Friction Method is either Hazen-Williams (for which the Friction Coefficient is a C factor) or Darcy-Weisbach.
Selecting Darcy-Weisbach will display both the Darcy-Weisbach f (for the Friction Coefficient) and the Roughness
Height in the Drawing Pane. Roughness Height is only used for a steady state run and typical values are available
from the material library.
Element Data for Steady StateSome fields in the Drawing Pane are only required for a steady state run, as
described by tooltips. If some information required by the steady state solver is missing, WaterGEMS V8i will
display a Warning Message dialog prompting for additional data or an Error Message dialog with instructions on
398
how to proceed. 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.
Calculate Network
The following steps need to be completed before performing hydraulic calculations for a network:
1. Click the Analysis toolbar and select Calculation Options.
2. In the Calculation Options dialog, double-click Base Calculation Options or create a new one and double-click it.
This will open the Properties viewer.
3. In the Properties viewer, set the Time Analysis Type to Steady-State or Extended Period. If Extended Period is
selected, then specify the starting time, the duration, and the time step to be used.
4. Optionally, in Extended Period mode, you may perform a Water Quality Analysis. Set the Calculation Type to Age,
Constituent or Trace.
5. Optionally, in Steady-State mode, you may also perform a Fire Flow Analysis. Change the Calculation Type to Fire
Flow.
6. Optionally, in the Adjustments section, you may modify the demand, unit demand, or roughness values of your
entire network for calibration purposes. If Demand Adjustments, Unit Demand Adjustments, or Roughness
Adjustments are set to Active in the Calculation Option properties and adjustments have been specified, the active
adjustments will be used. This does not permanently change the value of the input data, but allows you to
experiment with different calibration factors until you find the one that causes your calculation results to most
closely correspond with your observed field data.
7. Optionally, verify and/or adjust the settings in Hydraulics section to change the general algorithm parameters used
to perform Hydraulic and Water Quality calculations.
8. Click Validate to ensure that your input data does not contain errors.
9. Click Compute to start the calculations.
Global Demand and Roughness Adjustments
Demand and Roughness Adjustments based on observed data are an important part of the development of hydraulic and
water quality models. It is a powerful feature for tweaking the two most commonly used parameters during model
calibration: junction demands and pipe roughness.
One of the first steps performed during a calculation is the transformation of the input data into the required format for
the numerical analysis engine. If Demand Adjustments, Unit Demand Adjustments, or Roughness Adjustments are set
to Active in the Calculation Option properties and adjustments have been specified, the active adjustments will be used
during this transformation. This does not permanently change the value of the input data but allows you to experiment
with different adjustment factors until you find the one that causes your calculation results to most closely correspond
with your observed field data.
For example, assume node J-10 has two demands, a 100 gpm fixed pattern demand and a 200 gpm residential pattern
demand, for a total baseline demand of 300 gpm. If you enter a demand adjustment multiplier of 1.25, the input to the
numerical engine will be 125 gpm and 250 gpm respectively, for a total baseline demand of 375 gpm at node J-10. If
you use the Set operation to set the demands to 400, the demand will be adjusted proportionally to become 133 and 267
gpm, for a total baseline of 400 gpm. In addition, if a junction has an inflow of 100 gpm (or a demand of -100 gpm),
and the adjustment operation Set demand of 200 gpm, then the inflow at that junction will be -200 gpm (equivalent to a
demand of 200 gpm).
399
The Adjustments dialog is divided into three tabs, each containing a table of adjustments and controls to control the
data within the table. These controls are as follows:
NewAdds a new adjustment to the table.
DeleteRemoves the currently highlighted adjustment from the table.
Shift UpAdjustments are executed in the order they appear in the table. This button shifts the currently
highlighted adjustment up in the table.
Shift DownAdjustments are executed in the order they appear in the table. This button shifts the currently
highlighted adjustment down in the table.
The tables contained within the tabs are as follows:
DemandsUse this adjustment tab to temporarily adjust the individual demands at all junction nodes in the system
that have demands for the current scenario or a subset of junctions contained within a previously created selection
set. The Demands adjustment table contains the following columns:
ScopeUse this field to specify the elements that the adjustment will be applied. Choose <Entire Network> to
apply the adjustment to every demand node, or choose a subset of nodes by selecting one of the previously created
selection sets from the list.
Demand PatternUse this field to specify the demands to which the adjustment will be applied. Choose <All
Base Demands> to perform the adjustment on every base demand in the model. Choose Fixed to perform the
adjustment on only those nodes with a Fixed demand pattern. Choose one of the demand patterns in the list to apply
the adjustment to only the specified pattern.
OperationChoose the operation to be performed in the adjustment using the value specified in the Value column.
ValueType the value for the adjustment.
Unit DemandsUse this adjustment tab to temporarily adjust the unit demands at all junction nodes in the system
that have demands for the current scenario, or a subset of junctions contained within a previously created selection
set.
apply the adjustment to every node with a unit demand, or choose a subset of nodes by selecting one of the
previously created selection sets from the list.
400
Unit DemandUse this field to specify the unit demands to which the adjustment will be applied. Choose <All
Unit Demands> to perform the adjustment on every unit demand in the model. Choose one of the unit demands in
the list to apply the adjustment to only the specified unit demand.
RoughnessesUse this adjustment tab to temporarily adjust the roughness of all pipes in the distribution network
or a subset of pipes contained within a previously defined selection set.
apply the adjustment to every pipe, or choose a subset of pipes by selecting one of the previously created selection
sets from the list.
Check Data and Validate
This feature allows you to validate your model against typical data entry errors, hard to detect topology problems, and
modeling problems. When the Validate box is checked, the model validation is automatically run prior to calculations.
It can also be run at any time by clicking Validate. The process will produce either a dialog box stating No Problems
Found or a Status Log with a list of messages.
The validation process will generate two types of messages. A warning message means that a particular part of the
model (i.e., 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. 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 valve not being connected on both
its intake and discharge sides.
The validation process will generate two types of messages. A warning message means that a particular part of the
model (i.e., 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. 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 valve not being connected on both
Note: In earlier versions of the software, it was possible to create a topological situation that was problematic
but was not checked for in the network topology validation. The situation could be created by morphing a node
element such as a junction, tank, or reservoir into a pump or valve. This situation is now detected and corrected
automatically, but it is strongly recommended that you verify the flow direction of the pump or valve in
question. If you have further questions or comments related to this, please contact Bentley Support. Warning
messages related to the value of a particular attribute being outside the accepted range can often be corrected by
adjusting the allowable range for that attribute.
The check data algorithm performs the following validations:

Network TopologyChecks that the network contains at least one boundary node, one pipe, and one junction.
These are 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.
401
Element ValidationChecks that every element in the network is valid for the calculation. For example, this
validation ensures that all pipes have a non-zero length, a non-zero diameter, a roughness value that is within the
expected range, etc.
User Notifications
User notifications are messages about your model. These messages can warn you about potential issues with your
model, such as slopes that might be too steep or elements that slope in the wrong direction. These messages also point
you to errors in your model that prevent the software from solving your model.
To see user notifications:
1. Compute your model.
2. If needed, open the User Notification manager by clicking Analysis > User Notifications.
3. Or, if the calculation fails to compute because of an input error, when your model is finished computing, the
software prompts you to view user notifications to validate the input data.
4. You must fix any errors identified by red circles before the software can compute a result.
5. Errors identified by orange circles are warnings that do not prevent the computation of the model.
6. In the User Notifications manager, if a notification pertains to a particular element, you can double-click the
notification to magnify and display the element in the center of the drawing pane.
7. As needed, use the element label to identify the element that generates the error and use the user notification
message to edit the elements properties to resolve the error.
Using the Totalizing Flow Meter
Totalizing flow meters allow you to view results of the total volume going through your model for a specific selection
of elements.
Totalizing Flow Meters Manager Dialog

The Totalizing Flow Meter manager consists of the following controls:
New Create a new totalizing flow meter.
Delete Delete the selected totalizing flow meter.
Rename Rename the label for the current totalizing flow meter.
Edit Open the totalizing flow meter editor.
Refresh Recompute the volume of the current totalizing flow

meter.
Help Opens the online help for totalizing flow meter.
402
To create a new Totalizing Flow Meter

1. Click Compute. (EPS settings must be on in order to utilize this feature.)
2. From the Analysis Menu click Totalizing Flow Meters.
3. Click New which will open up the Select box.

4. Select the elements to be calculated or click the Query box then click Done.
You can also create a totalizing flow meter by simply right-clicking a pressure pipe and selecting the Totalizing Flow
Meter command from the context menu that appears.
Totalizing Flow Meter Editor Dialog

The Totalizing Flow Meter editor allows you to define settings for new or existing flow meters, and to display the
calculated results for the current flow meter settings.
The Totalizing Flow Meter Summary tab displays the totals for each element type.
The Totalizing Flow Meter Details tab displays results for each individual element.
To define flow meter settings:
1. Set Start and Stop times. Once selected, the results are automatically updated.
2. Click the Report button to run a report or click Close.
To remove elements from the Totalizing Flow Meter definition:
Highlight the element to be removed in the list and click the Delete button above the list pane.
To add elements to the Totalizing Flow Meter definition:
1. Click the Select From Drawing button above the element list pane.
2. In the Drawing View, click the element or elements to be added.
403
Click the Done button in the Select dialog.
System Head Curves
The purpose of a pump is to overcome elevation differences and head losses due to pipe friction and fittings. The
amount of head the pump must add to overcome elevation differences is dependent on system characteristics and
topology (and independent of the pump discharge rate), and is referred to as static head. Friction and minor losses,
however, are highly dependent on the rate of discharge through the pump. When these losses are added to the static
head for a series of discharge rates, the resulting plot is called a system head curve.
Pumps are designed to lift water from one elevation to another, while overcoming the friction and minor losses
associated with the piping system. To correctly size a pump, one must understand the static head (elevation differences)
and dynamic head (friction and minor losses) conditions under which the pump is expected to operate. The static head
will vary due to changes in reservoir or tank elevations on both the suction and discharge sides of the pump, and the
dynamic head is dependent on the rate of discharge through the pump.
System head curves are a useful tool for visualizing the static and dynamic head for varying rates of discharge and
various static head conditions. The system head curve is a graph of head vs. flow that shows the head required to move
a given flow rate through the pump and into the distribution system.
System Head Curves in Closed Systems

The theory behind system head curves is that there is a tank or reservoir on both the suction and discharge side of the
pump for which the curve is developed. In the case of closed (dead end) systems, there is no reservoir or tank
downstream of the pump. The demands must always be exactly met. In order to develop a system head curve for such a
pipe network, it is necessary to account for the relationship between usage and pressure. Therefore the network
demands must be represented by pressure dependent demands.
To develop a system head cure for such a network, the demands must be set to pressure dependent demands (PDD) and
there must be no threshold pressure set for demands. This is done by:
1. Defining a PDD function in Components > Pressure Dependent Demand.
2. Setting up a PDD alternative assigning the PDD functions and making certain that "Reference Pressure Equals
Threshold?" is unchecked.
3. Setting the Calculation Option "Use Pressure Dependent Demand" to True.
Check the model to make sure it runs correctly before creating the System Head Curve.
System Head Curves Manager Dialog

The System Head Curves manager allows you to create, edit, and manager system head curves. It consists of the
following controls:
New: Create a new system head curve.
Delete: Delete the selected system head curve.
Rename: Rename the label for the current system head curve.
Edit: Open the system head curve editor.
Help: Open the online help for system head curves.
404
System Head Curves Editor Dialog

The System Head Curve editor allows you to define and calculate a graph of head vs. flow that shows the head required
to move a given flow rate through the selected pump and into the distribution system.
To create a new System Head Curve Definition:
1. Click Compute. (EPS settings must be on in order to utilize this feature.)
2. From the Analysis Menu click System Head Curves.
3. Click New, which will open the System Head Curve editor. The System Head Curves Editor is where you can
specify the settings of System Head Curve Definition. You can also compute and view the system head curve for a
specific timestep.
4. Choose the pump that will be used for the system head curve from the Pump pulldown menu, or click the ellipsis
and click the pump to be used in the drawing pane.
5. Type a value for Maximum Flow and Number of Intervals.
6. Choose a time step in the Time (hours) column.
7. Click Compute to calculate the results for the specified time step.
8. View the results as a graph or data.
9. Click Report to view the report.
10. Click Close to exit the System Head Curve editor.
Note: You can select more than one time step for the system head curve calculation by holding down the <Ctrl>
key and clicking each time step that you want to calculate.
Post Calculation Processor
The Post Calculation Processor allows you to perform statistical analysis for an element or elements on various results
obtained during an extended period simulation calculation.
The results of the Post Calculation Processor analysis are then displayed in a previously defined user defined field. To
learn more about user defined fields see User Data Extensions.
The Post Calculation Processor dialog consists of the following controls:
Start Time Specify the start time for the period of time that will be
analysed.
Stop Time Specify the stop time for the period of time that will be
analysed.
Statistic Type Choose the type of statistical analysis to perform.
Result Property Choose the calculated result that will be analysed for the
selected element(s).
Output Property Choose the user-defined data extension where the results
of the analysis will be stored.
405
Operation Choose an operation to determine how to apply the

calculation result to the output field. For example Set will
enter the result of the analysis to the field without
modification, Add will enter the sum of any current value
in the output field and the calculated result, and so on.
Remove Element Removes the element that is currently selected in the

table.
Select From Drawing Allows you to select additional elements from the
drawing pane and add them to the table.
Flow Emitters
Flow 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.
Emitters are used to model flow through sprinkler systems and irrigation networks. They can also be used to simulate
leakage in a pipe connected to the junction (if a discharge coefficient and pressure exponent for the leaking crack or
joint can be estimated) and compute a fire flow at the junction (the flow available at some minimum residual pressure).
In the latter case, one would use a very high value of the discharge coefficient (e.g., 100 times the maximum flow
expected) and modify the junctions elevation to include the equivalent head of the pressure target.
406
When both an emitter and a normal demand are specified for a junction, the demand that WaterGEMS V8i reports in its
output results includes both the normal demand and the flow through the emitter.
The flow through an emitter is calculated as:
Where
Q is flow.
k is the emitter coefficient and is a property of the node.
P is pressure.
n is the emitter exponent and is set globally in the calculation options for the run; it is dimensionless but affects the
units of k. The default value for n is 0.5 which is a typical value for an orifice.
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
407
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:
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.
Fire Flow Analysis
One of the goals of a water distribution system is to provide adequate capacity to fight fires. WaterGEMS V8i's
powerful fire flow analysis capabilities can be used to determine if the system can meet the fire flow demands while
maintaining various pressure constraints. Fire flows can be computed for a single node, a group of selected nodes, or all
nodes in the system. A complete fire flow analysis can comprise hundreds or thousands of individual flow solutions-
one for each junction selected for the fire flow analysis.
408
Fire flows are computed at user-specified locations by iteratively assigning demands and computing system pressures.
The program calculates a steady-state analysis for each node in the Fire Flow Alternative. At each node, it begins by
running a Steady-State analysis to ensure that the fire flow constraints that have been set can be met without
withdrawing Fire Flow from any of the nodes. If the constraints are met in this initial run, the program then begins
iteratively assigning the Needed Fire Flow demands at each of the nodes, and checking to ensure that the constraints are
met. The program then runs another set of Steady State analyses, this time either adding the Maximum Fire Flow (as set
in the Fire Flow Upper Limit input box of the Fire Flow Alternative) to whatever normal demands are required at that
node, or replacing the normal demands. In either case, the program checks the residual pressure at that node, the
Minimum Zone Pressure, and, if applicable, the Minimum System Pressure. If the Fire Flow Upper Limit can be
delivered while maintaining the various pressure constraints, that node will satisfy the Fire Flow constraints. If one or
more of the pressure constraints is not met while attempting to withdraw the Fire Flow Upper Limit, the program will
iteratively assign lesser demands until it finds the maximum flow that can be provided while maintaining the pressure
constraints. If a node is not providing the Fire Flow Upper Limit, it is because the Residual Pressure at that node, the
Minimum Zone Pressure, or the Minimum System Pressure constraints are not met while attempting to withdraw the
Fire Flow Upper Limit (or the maximum number of iterations has been reached). If a node completely fails to meet the
Fire Flow constraints, it is because the network is unable to deliver the Needed Fire Flow while still meeting the
pressure constraints.
After the program has gone through the above process for each node in the Fire Flow Analysis, it runs a final Steady-
State calculation that does not apply Fire Flow demands to any of the junctions. This provides a baseline of calculated
results that can then be compared to the Fire Flow conditions, which can be determined by viewing the results
presented on the Fire Flow tab of the individual junction editors, or in the Fire Flow Tabular Report. The baseline
pressures are the pressures that are modeled under the standard steady-state demand conditions in which fire flows are
not exerted.
Note: All parameters defining a fire flow analysis, such as the residual pressure or the minimum zone pressure,
are explained in detail in the Fire Flow Alternative (see Fire Flow Alternative)and in the Fire Flow tab topics.
To perform a Fire Flow analysis:

1. Change the Calculation Type calculation option to Fire Flow.
2. Open the Alternatives manager (Cick the Analysis menu and select Alternatives).
3. Double click on Base-Fire Flow to open the Fire Flow Alternative editor.
4. Define the needed fireflow, fireflow upper limit, pressure constraints and the fire flow nodes selection set.
5. After all necessary fields have been entered, close the Fire Flow Alternative and Aternatives manager and click
Compute.
6. Open the Fire Flow Results Browser. Only the elements that were specified in the selection set will be color coded.
Fire Flow Results

After performing a fire flow analysis, calculation results are available for each junction node in the fire flow selection
set. These results can be viewed in the predefined Fire Flow Report (in tabular format).
409
The results can also be viewed by clicking Report.
You can also choose to have the program save "auxiliary results" (a snap shot result set of the fire flow analysis
hydraulic conditions) for no fire flow nodes, just the failing fire flow nodes, if any, or all fire flow nodes. For every fire
flow node that attracts auxiliary results a separate result set (file) is created. When enabling this setting be conscious of
the number of fire flow nodes in your system and the potential disk space requirement.
Enabling this option also will slow down the fire flow analysis due to the need to create the additional results sets.
Note: The base result set includes hydraulic results for the actual fire flow node and also for the pipes that connect to
the fire flow node. The results stored are for the hydraulic conditions that are experienced during the actual fire flow
410
analysis (i.e., under fire flow loading). No other hydraulic results are stored unless the auxiliary result set is "extended"
by other options listed below.
Fire Flow Results Browser

The Fire Flow Results Browser allows you to quickly jump to fire flow nodes and display the results of fire flow
analysis at the highlighted node. it also allows you to view Fire Flow Auxiliary results (a snap shot result set of the fire
flow analysis hydraulic conditions), if the Fire Flow Auxiliary Results Type option is set to Failed Nodes or All Nodes.
Auxiliary results can also be displayed using the Fire Flow Node FlexTable (see FlexTables Manager (on page 721))
and Element Symbology (see Annotating Your Model (on page 705)).
Go to Analysis > Fire Flow Results Browser or click
Zoom to see results of the specific element
.
To find a specific element, click the Find button
411
.
Reset to Standard Steady State Results
.Click to override the selection set and apply results to all elements in the model. Reset will also occur when you close
Fire Flow Results Browser.
Not Getting Fire Flow at a Junction Node

Perform the following checks if you are not getting expected fire flow results:
Check the Available Fire Flow. If it is lower than the Needed Fire Flow, the fire flow conditions for that node are
not satisfied. Therefore, Satisfies Fire Flow Constraints is false.
Check the Calculated Residual Pressure. If it is lower than the Residual Pressure Constraint, the fire flow condition
for that node is not satisfied. Therefore, Satisfies Fire Flow Constraints is false.
Check the Calculated Minimum Zone Pressure. If it is lower than the Minimum Zone Pressure Constraint, the fire
flow condition for that node is not satisfied. Therefore, Satisfies Fire Flow Constraints is false.
If you checked the box for Minimum System Pressure Constraint in the Fire Flow Alternative dialog box, check to
see if the Calculated Minimum System Pressure is lower than the set constraint. If it is, Satisfies Fire Flow
Constraints is false.
Note: If you are not concerned about the pressure of a node that is NOT meeting the Minimum Zone Pressure
constraint, move this node to another zone. Now, the node will not be analyzed as part of the same zone.
Water Quality Analysis
The following Water Quality Analysis parameters are available for user configuration:
Age ToleranceIf 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 ToleranceIf 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 ToleranceIf 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.
Set Quality Time StepCheck this box if you want to manually set the water quality time step. By default, this box
is not checked and the water quality time step is computed internally by the numerical engine.
Quality Time StepTime 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.
412
Note: If you run a Water Quality Analysis, you can generate graphs of the elements in the results by right-clicking
an element and selecting Graph.
To learn about the types of water quality analysis, click the links below:
Age Analysis
Note: Water quality analysis can only be performed for extended period simulations.
An age analysis determines how long the water has been in the system and is more of a general water quality indicator
than a measurement of any specific constituent. To configure for an age analysis:
1. Click the Analysis menu and select Calculation Options.
2. In the Calculation Options manager, click the New button to create a new calculation option definition.
3. Change the Calculation Type to Age.
4. Specify the Calculation Times and the Age Tolerance. Optionally, specify Hydraulics, Adjustments, and/or
Calculation Flag settings. Close the Calculation Options dialog.
5. Assuming you have not already set up an Age alternative for this scenario (including defining the trace node), go to
the Alternatives tab, click the Ellipsis (...) or New button next to the Age choice list, and add or edit an Age
alternative. To edit an existing alternative (see Age Alternatives), click the Edit button. Enter the appropriate data,
and click Close. Rename the alternative to give it a descriptive name. To add a new alternative, click the Add
button. Enter a descriptive name into the New Alternative dialog box and click OK. Enter the appropriate data into
the Age Alternative Editor and click Close. Back in the Alternatives tab, choose the desired alternative from the
Age Alternative choice list.
6. Click the Compute button.
Constituent Analysis
A constituent is any substance, such as chlorine and fluoride, for which the growth or decay can be adequately
described through the use of a bulk reaction coefficient and a wall reaction coefficient. A constituent analysis
determines the concentration of a constituent at all nodes and links in the system. Constituent analyses can be used to
determine chlorine residuals throughout the system under present chlorination schedules, or can be used to determine
probable behavior of the system under proposed chlorination schedules. To configure for a constituent analysis:

3. Change the Calculation Type to Constituent.
4. Specify the Calculation Times and the Constituent Tolerance. Optionally, specify Hydraulics, Adjustments, and/or
5. Assuming you have not already set up a Constituent alternative for this scenario (including the selection of the
constituent), go to the Alternatives tab, click the Ellipsis (...) or New button next to the Constituent scroll-down list,
and add or edit a Constituent alternative (for more information, see Constituent Alternatives). To edit an existing
alternative, click the Edit button. Enter the appropriate data, and click Close. Rename the alternative to give it a
descriptive name. To add a new alternative, click the Add button. Enter a descriptive name into the New Alternative
dialog box and click OK. Enter the appropriate data into the Constituent Alternative Editor and click Close. Specify
the Constituent, which is defined in the Constituent Library and accessed by clicking the Ellipsis (...) button. Back
in the Alternatives tab, choose the desired alternative from the Constituent Alternative choice list.
413
Trace Analysis
A trace analysis determines the percentage of the water at all nodes and links in the system. The source is designated as
a specific node in the system and is called the trace node. In systems with more than one source, it is common to
perform multiple trace analyses using the various trace nodes in successive analyses. The source node and initial traces
are specified in the Trace Alternative dialog box (for more information, see Trace Alternative). To configure for a trace
analysis:
3. Change the Calculation Type to Trace.
4. Specify the Calculation Times and the Trace Tolerance. Optionally, specify Hydraulics, Adjustments, and/or
5. Assuming you have not already set up a Trace alternative for this scenario (including defining the trace node), go to
the Alternatives tab, click the Ellipsis (...) or New button next to the Trace choice list, and add or edit a trace
alternative. Specify the trace node to be used for this analysis and provide the appropriate data. Back in the
Alternatives tab, choose the desired alternative from the Trace Alternative choice list.
Modeling for IDSE Compliance

Under the US EPA's Stage 2 Disinfectant by-product Rule, utilities are required to identify locations in their water
distribution systems that are likely to have high concentrations of disinfectant by-products such as Trihalomethanes and
Haloacetic acids. Both of these are associated with high water age.
In general the easiest and most beneficial way to comply with the EPA regulations is to conduct a system specific study
and the most expedient way of doing this is to construct a calibrated, detailed extended period simulation model which
can identify locations in the system with high water age. The details of the requirements for such a model are provided
in "System Specific Study Using a Distribution System Hydraulic Model" available at:
http://www.epa.gov/safewater/disinfection/stage2/compliance.html
WaterGEMS V8i can be used to comply with these regulations. Special tools have been added to assist in IDSE (Initial
Distribution System Evaluation) studies. They are described below:
The utility must demonstrate that it has a well calibrated model.
From the regulations:
"A description of all calibration activities undertaken (or to be undertaken). This must include, if calibration is
complete,
A graph of predicted tank levels versus measured tank levels for the storage facility with the highest residence time
in each pressure zone.
A time series graph of water age results for the storage facility with the highest residence time in your system
showing predictions for the entire EPS simulation period (i.e. from time zero until the time it takes for the model to
reach a consistently repeating pattern of residence time)."
414
The graphing tools for displaying field observations alongside of model results have been improved for Select Upgrade
1 to make it easier to import field data using copy/paste commands from data sources such as spreadsheets and data
base files
The utility's model used in an IDSE study must contain at least 50% of the pipe length in the real system and at
least 75% of the pipes volume.
EPA regulations require:
At least 50 percent of total pipe length in the distribution system.
At least 75 percent of the pipe volume in the distribution system.
All 12-inch diameter and larger pipes.
All 8-inch diameter and larger pipes that connect pressure zones, mixing zones from different sources, storage
facilities, major demand areas, pumps, and control valves, or are known or expected to be significant conveyors of
water.
All 6-inch diameter and larger pipes that connect remote areas of a distribution system to the main portion of the
system or are known or expected to be significant conveyors of water.
All storage facilities, with controls or settings applied to govern the open/closed status of the facility that reflect
standard operations.
All active pump stations, with realistic controls or settings applied to govern their on/off status that reflect standard
operations.
All active control valves or other system features that could significantly affect the flow of water through the
distribution system (e.g., interconnections with other systems, pressure reducing valves between pressure zones).
A table providing information on the total length of pipe and volume of water in the model is available by clicking the
Report menu and selecting Pressure Pipe Inventory. This inventory can be printed using the Print Preview button at the
top of the display or copied to the clipboard for use in other documents by highlighting all columns and hitting CTRL-
C. If the columns are so wide that the wrapping of the columns does not look attractive, the user can resize the column
widths by grabbing the edges of the column and sliding the border to a desired position.
Below is an example of one such table:
415
The utility must be able to calculate, display and perform statistics on water age.
This is done by setting up an EPS run for a long duration (e.g. one week). The user then selects "Age" as the calculation
type in the calculation options. The duration of the run should be sufficiently long such that the water age is not
continuing to increase in the system at the end of the run. Selecting a good initial water age for the tanks can reduce the
length of time required to reach a recurring pattern.
416
The user also needs the ability to calculate some statistics after an water age EPS run to include average water
age at each element between hours a and b.
Average water age over the final 24 hours of an EPS run can be calculated using the Post Calculation Processor which
can be found under the Analysis menu.
An example is shown below. To determine the average water age at all junctions for the last 24 hour of, for instance, a
144 hour run, set the following values:
Start time: 120
Stop Time: 144
Statistic Type: Mean (Time weighted)
Results Property (field): Age (Calculated)
Output Property (field): AveAge
Operation: Set
Then use the browser above the bottom pane to select all the junctions for which average age is to be calculated. It's
recommended to create a selection set with the elements desired before entering the Post Calculation Processor.
Mean (Time weighted) takes into account the fact that not all time steps are of the same size.
Result property (field) means that the Age (Calculated) property (attribute) in the model will be used to determine the
average age.
Output property (field) means that the resulting average age for each selected element will be placed in a user defined
property (field) called AveAve. . Instructions on establishing a user defined output property (field) can be found under
User Data Extensions Dialog Box.
Once the average age property has been determined for each element, it is possible to color, annotate, contour or
perform other WaterGEMS V8i operations on that property as with any other user defined property. The user can sort
on this property (attribute) in FlexTables and determine the median. This helps the user comply with the portion of the
regulation that states:
"Average residence time is the average age of water delivered to customers in a distribution system. Average residence
time is not simply one-half the maximum residence time. Ideally, it should be a flow-weighted or population-weighted
estimate. The model results for water age/DBP concentration can be used to determine the average residence time for
417
your system. One option for doing this is to list the water age/DBP concentration results in ranked order for the entire
system..."
A histogram plot sorts the water age results into groups and shows the percentage of nodes with water ages
falling within the given range.
A histogram can be created using a WaterObjects.NET feature which enables the user to utilize the graphing capability
of Excel to create the histogram. The user starts Excel and if WaterGEMS V8i was loaded correctly, picks WaterGEMS
V8i > Import Data and will then enter a browser titled "Please select a Water Model." The user browses to the file
corresponding to the model under consideration. The screen below opens. (If model results have not been calculated for
the base scenario for the model the user will be asked if a calculation is desired.)
The fields in this dialog are described below for the case of creating a IDSE histogram The fields in this dialog are
described below for the case of creating a IDSE histogram:
Source model: Full path name of model file
Scenario: Name of Scenario to be imported
Time step: Time step to be imported (value of average age is same for any time step)
Element type: Average age is calculated at junctions
Property (attribute): Average age for this case but any property (attribute) can be imported
Use selection set: check if user only wants to import a subset of junctions
Select set: name of selection set if previous box is checked
Active elements only: Check if inactive elements are to be ignored which is usually the case
The second group of settings refers to the Excel spreadsheet file:
Destination sheet: Select existing sheet name
Import label: Only needed if spreadsheet calculation involve knowing the element label
Labels: Column in which labels are placed
418
Values: Column in which values of selected property (attribute) are placed

The next group of settings refers to the Histogram to be created:
Create histogram: Check if histogram is desired
Histogram Name: Name of worksheet in which histogram is placed
Number of intervals: Number of bars in histogram
Specify min/max?: If checked, user can override default values of ranges (recommended)
Minimum: Minimum value of lowest interval
Maximum: Maximum value of highest interval
Note: The "Get min/max" button will populate the Minimum and Maximum boxes and act as defaults. (The
Minimum and maximum fields enable the user to create histograms which have round number a breakpoints
instead of the default ranges which can be on the order of 18.34-24.67.)
Histogram type: The vertical axis can be labeled by number of points (Junction elements) in each interval or
percentage of point in each interval.
The Import button begins the importing of values from the model file into the spreadsheet and creates the histogram if
that box is checked. The final histogram will look like the one below for 10 intervals with Frequency selected.
Here is an example with a large number of intervals and percentage of points as the axis:
419
Water Quality Batch Run

The Water Quality Batch Run feature allows you to perform a combined Water Quality Trace or Constituent analysis.
You can then use the provided reporting tools to graph the combined effects of each type of analysis on various parts of
your system, or to review system-wide tabular statistics reports.
420
The dialog consists of a list pane on the left that displays all of the trace and constituent batch analyses in the project
along with the following controls:
New: Creates a new Trace or Constituent analysis. Highlight the folder for the type of analysis you want to create
and click New.
Delete: Deletes the trace or constituent analysis that is currently highlighted in the list pane.
Rename: Allows you to enter a new label for the trace or constituent analysis that is currently highlighted in the list
pane.
Compute: Calculates the trace or constituent analysis that is currently highlighted in the list pane.
Graph: After an analysis has been computed, this button opens the Graph Element Selection dialog, allowing you to
select the elements to graph.
Statistics Table: Opens the Water Quality Batch Run Statistics Table dialog, which displays statistics for each node
and pipe.
The controls available in the right side of the dialog change depending on whether a Trace or Constituent analysis is
Trace Analysis
When a Trace analysis is highlighted in the list pane the right side of the dialog will look like this:
421

Representative Scenario: Choose the scenario that represents the state of the system you would like to analyze.
Select the scenario from the list or click the Scenarios button to open the Scenarios dialog and select the desired
scenario from the tree view.
Select Elements: Click this button to return to the drawing pane to select the trace source elements that will be used
for the analysis.
Source Element Table: This table lists the selected trace source elements that will be used in the analysis. The
element Label, Element ID, and Element Type are displayed for each trace source element.
Note: If water passes through an inflow node, even it if came from another source, it is treated as having
originated at this source. Therefore, the trace will essentially be double counted. The solution to this problem,
when inflow source nodes are involved is to place them on a short stub where water from other sources will not
flow through them.
Constituent Analysis
When a Constituent analysis is highlighted in the list pane the right side of the dialog will look like this:
422

Representative Scenario: Choose the scenario that represents the state of the system you would like to analyze.
Select the scenario from the list or click the Scenarios button to open the Scenarios dialog and select the desired
scenario from the tree view.
Select Alternatives to Analyze: Opens the Select Alternatives to Analyze dialog, allowing you to choose which
alternatives will be used in the Constituent analysis.
Alternatives Pane: This area displays the alternatives to be analyzed.
Select Alternatives to Analyze Dialog Box

This dialog allows you to select the alternatives to be used in a Constituent Water Quality Batch Run.
423
Available Items Contains all of the alternatives that are available for the
constituent analysis. The Available Items list is located on
the left side of the dialog box.
Selected Items Contains all of the alternatives that will be included in the
constituent analysis. The Selected Items list is located on
the left side of the dialog box.
Select or clear alternatives to be used in the table. The

Add and Remove buttons are located in the center of the
dialog box. [ > ] Adds the selected alternative from the
Available Items list to the Selected Items list. [ >> ] Adds
all of the alternatives in the Available Items list to the
Selected Items list. [ < ] Removes the selected alternative
from the Selected Items list. [ << ] Removes all
alternatives from the Selected Items list.
Add and Remove Buttons
Graph Element Selection Dialog Box

This dialog allows you to select the elements for which results will be displayed after a Water Quality Batch Run Trace
analysis.
Click the Select From Drawing button
to return to the drawing pane, allowing you to select the elements that will be included in the graph. Pipes and Nodes
can both be selected.
424
Once elements have been selected, the dialog will display a table containing the Label, ID, and Element Type of all of
the selected elements. Click OK to open the graph.
Graph Viewer Dialog Box

Using the Graph Viewer dialog box you can view the results of the water quality batch run.
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
425
Graph Tab
Opens the Print Preview dialog box to view the current

image and change the print information.
Print Preview
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 748) 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
426
Graph Tab
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.
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.
Animation Options Dialog Box
This dialog allows you to set the animation delay for the Graph Viewer Dialog Box.
The Delay value is the amount of time between frames of animation when the Play button in the Graph Viewer Dialog
Box is clicked.
Statistics Table Dialog Box
427
This dialog displays calculated statistics for a water quality batch run.
The dialog shows the statistics in a tabular format divided into a Nodes tab and a Pipes tab, along with the following
controls:
Export for Color Coding: Opens the Export for Color Coding dialog, allowing you to specify the scenario and fields
to export for use with the color coding feature.
Copy: Copies the statistic table to the clipboard for use in an external application.
Report: Generates a preformatted report containing the data in the statistics table.
Alternative/Trace Node: For Trace Analysis, this field allows you to select the Trace Node for which statistics are
calculated. For Constituent Analysis, this field allows you to select the constituent scenario.
Start Time: Allows you to select the start time for the statistics calculations.
Stop Time: Allows you to select the stop time for the statistics calculations.
Auto-Refresh: When this box is checked, the results in the table will automatically be refreshed when changes are
made.
428
Refresh: Refreshes the results displayed in the table to reflect changes made in this dialog.
Multi-Species Water Quality Analysis

Using constituent analysis, a user can track a single constituent through a water distribution system, provided the
constituent behaved according to one of the kinetic models (e.g. first order decay). However, some constituents cannot
be modeled this way because they are involved in significant multi-species reactions or their kinetics do not fit one of
the existing models. To handle these cases, WaterGEMS V8i provides Multi-species Analysis, based on the EPANET-
MSX model with a WaterGEMS V8i user interface.
In order to use multi-species analysis in WaterGEMS V8i, in addition to the usual EPS input, the user must provide:
Generic options such as water quality time step size
Species name and mass units
Reaction rate coefficients either globally or pipe by pipe
Rate and equilibrium equations for pipes and tanks
Sources of each species and relevant time patterns
Initial concentration of species
Reporting options
These values are entered as text in the Multi-species Analysis Setup and Multi-Species Model Configuration using the
syntax described below. For a multi-species scenario, the calculation options are set to Multi-species analysis (see
Multi-species Analysis Setup and Multi-species Model Configuration). The distinction between Setup and
Configuration is that setup contains values describing kinetics and can be used with any model while configuration
contains values for sources and overrides that are specific to the current model.
The data for a multi-species analysis is divided into sections as described below:
[TITLE] adds a descriptive title to the data set
[OPTIONS] sets the values of computational options
[SPECIES] names the chemical species being analyzed
[COEFFICIENTS] names the parameters and constants used in chemical rate and equilibrium expressions
[TERMS] defines intermediate terms used in chemical rate and equilibrium expressions
[PIPES] supplies the rate and equilibrium dynamics in pipes expressions that govern species
[TANKS] supplies the rate and equilibrium dynamics in storage tanks expressions that govern species
[SOURCES] identifies input sources (i.e., boundary conditions) for selected species
[QUALITY] supplies initial conditions for selected species throughout the network
[PARAMETERS] allows parameter values to be assigned on a pipe by pipe basis
[PATTERNS] defines time patterns used with input sources
[REPORT] specifies reporting options
The values for most of these sections are entered under model setup while the sections on Sources, Quality and
Parameters are model specific and are described under model configuration.
This help topic provides the steps to run a multi-species analysis in WaterGEMS V8i. For more detailed background
and theory, the user is referred to the EPANET-MSX manual.
Setup
429
To enter the data for a multi-species run, the user must create a multi-species setup by selecting Component > Multi-
Species Analysis Setups. Pick New to create a setup.
430
The user can also Delete, Copy, Rename or Import/Export setups from a library.
431
The exact syntax for the setup is provided in the help topic Multi-species Analysis Setup.
Configuration
Within the calculation options, the user identifies model specific properties for a Multi-species analysis.
The exact syntax for the setup is provided in the help topic Multi-species Analysis Setup.
Calculation Options
To run a multi-species analysis, the user must set the Calculation Type in the Calculation Options to Multi-Species
Analysis.
This opens up a category at the bottom of the calculation options where the user Multi-Species Setup to use from the
list of those created above and the Model Configuration for this model.
Results
The results of a multi-species analysis run are available using the property grid, graphing, annotation, color coding just
as any other WaterGEMS V8i results.
Multi-Species Analysis Setup

Multi-species Analysis Setup can be reached using Component > Multi-Species Analysis Setups. Once a setup has been
created, it can be referenced in the calculation options for any scenario.
432
433
434
435
436
437
438
439
Multi-species Model Configuration

Multi-species model configuration consists of data for multi-species analysis that is dependent on the model (as
opposed to setup data which is independent of the model). The configuration is entered under calculation options.
Picking the ellipse next to Model Configuration opens the dialog where model configuration data are specified. The
semi-colon is used to designate a comment. Text is not case sensitive (e.g. SOLVER and solver are treated the same),
but coefficients are (e.g. Kb and kb are different coefficients).
Descriptions of the individual sections of the data are given below:
[SOURCES]
Purpose: Defines the locations where external sources of particular species enter the pipe network.
Formats:
sourceType nodeID specieID strength (patternID)
Definitions:
sourceType: either MASS, CONCEN, FLOWPACED, or SETPOINT
nodeID: the ID label of the network node where the source is located
specieID: a bulk species identifier
strength: the baseline mass inflow rate (mass/minute) for MASS sources or concentration (mass/L) for all other source
types
patternID: the name of an optional time pattern that is used to vary the source strength over time.
Remarks:
440
Use one line for each species that has non-zero source strength.
Only bulk species can enter the pipe network, not wall species.
The definitions of the different source types conform to those used in the original EPANET program are as follows:
MASS type source adds a specific mass of species per unit of time to the total flow entering the source node from all
connecting pipes.
CONCEN type source sets the concentration of the species in any external source inflow (i.e., a negative demand)
entering the node. The external inflow must be established as part of the hydraulic specification of the network model.
FLOWPACED type source adds a specific concentration to the concentration that results when all inflows to the source
node from its connecting pipes are mixed together.
SETPOINT type source fixes the concentration leaving the source node to a specific level as long as the mixture
concentration of flows from all connecting pipes entering the node is less than the set point concentration.
If a time pattern is supplied for the source, it must be one defined in the [PATTERNS] section of the MSX file, not a
pattern from the associated EPANET input file.
Examples:
[SOURCES]
;Inject 6.5 mg/minute of chemical X into Node N1
;over the period of time defined by pattern PAT1
MASS N1 X 6.5 PAT1
;Maintain a 1.0 mg/L level of chlorine at node N100
SETPOINT N100 CL2 1.0
[QUALITY]
Purpose: Specifies the initial concentrations of species throughout the pipe network.
Formats:
GLOBAL: specieID concen
NODE: nodeID specieID concen
LINK: linkID specieID concen
Definitions:
specieID: a species identifier
nodeID: a network node ID label
linkID: a network link ID label
concen: a species concentration
Remarks:
Use as many lines as necessary to define a network's initial condition.
Use the GLOBAL format to set the same initial concentration at all nodes (for bulk species) or within all pipes (for wall
species).
Use the NODE format to set an initial concentration of a bulk species at a particular node.
441
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 V8i provides the user with a unique and flexible tool to evaluate a water distribution system and identify
the most critical elements. The user is allowed to 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 V8i 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.
442
Before being able to conduct a criticality analysis, WaterGEMS V8i 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 V8i 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 448) 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 V8i 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 V8i 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.
443
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.)
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.
444
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.
Running Criticality Analysis

After segments have been identified (not necessary to run outage segments), WaterGEMS V8i 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 V8i 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 V8i 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
445
Run with Hydraulic PDD? Steady State/EPS Flow Results Pressure Results
Engine
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
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).
446
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
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.
447
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 V8i criticality analysis as the basic element of a system that can be isolated so
that the effects of an outage can be evaluated.
WaterGEMS V8i 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 V8i automatically identifies
segments. These segments can consist of a portion of a single pipe or several pipes and their 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 V8i 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.
The first figure below shows a simple pipe network with valves:
448
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.
449
If on the other hand, "Consider valves?" is unchecked, then each segment consists of one and only one pipe as shown
below.
450
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
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.
451
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.
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.
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.
452
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.
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.
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.
453
The following calculation option parameters are available for user configuration:
Friction MethodSet the global friction method.
Output Selection SetSelect whether to generate output for All Elements (the default setting) or only the elements
contained within the chosen selection set.
Calculation TypeSelect 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 AdjustmentsSpecify whether or not to apply adjustment factors to standard demands.
Active Demand AdjustmentsThe collection of demand adjustments that are applied during the analysis.
Unit Demand AdjustmentsSpecify whether or not to apply adjustment factors to unit demands.
Active Unit Demand AdjustmentsThe collection of unit demand adjustments that are applied during the analysis.
Roughness AdjustmentsSpecify whether or not to apply adjustment factors to roughnesses.
Active Roughness AdjustmentsThe 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 DateSelect the calendar date on which the simulation begins.
Time Analysis TypeSelect 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 StepIn 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 TimeSelect the clock time at which the simulation begins. DurationSpecify the total duration of an
extended period simulation.
Hydraulic Time StepSelect 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 StepData 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 StepTime 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 CompatibilityThis field allows you to choose which engine compatibility mode you want to run in.
Choose WaterGEMS V8i 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 V8i (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.
454
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 FrequencyThis 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 OffThis 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 LimitThis 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).
TrialsUnitless number that defines the maximum number of iterations to be performed for each hydraulic
solution. The default value is 40.
AccuracyUnitless 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 ExponentEmitters 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 LabelLabel that describes the type of liquid used in the simulation.
Liquid Kinematic ViscosityRatio of the liquid's dynamic, or absolute viscosity to its mass density.
Liquid Specific GravityRatio of the specific weight of the liquid to the specific weight of water at 4 degrees C or
39 degrees F.
Use Pressure Dependent Demand?If set to true the flows at junctions and hydrants will be based on pressure
constraints.
Age ToleranceIf 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 ToleranceIf 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 ToleranceIf 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 ConsistencyFlow 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 ConsistencyHead 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.
455
Friction Coefficient CriterionFor 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 AfterSet the time at which reporting begins. The default value is 0.02.
Show Extreme Heads AfterSets 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 MethodSelect 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/ClosingToggles 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 TypeSelect 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 PointsChoose the report points type from the following:
No PointsNo report points are defined.
All PointsAll nodes in the model are report points.
Selected PointsSelecting this option makes the Report Points Collection field active, allowing you to define
the report points.
Report Points CollectionClicking 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 TimesChoose whether to report Periodically, At Specific Times, At No Times, or At All Times.
Report PeriodSpecify 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 CollectionOpens 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 TypeSelects whether the run duration is measured in time or time steps.
Run DurationPeriod of time simulated by the model.
Pressure Wave SpeedSpeed for the liquid being conveyed, the pipe material selected and its dimension ratio
(DR), bedding, and other factors.
Vapor PressurePressure below which a liquid changes phase and become a gas (steam for water), at a given
temperature and elevation.
Wave Speed Reduction FactorThe low pressure wave speed reduction factor.
Decrease TimeThe time for the wave speed to decrease from its normal value to the reduced value at vapor
pressure.
Increase TimeThe time for the wave speed to increase from its reduced value to the normal value at vapor
pressure.
Generate Animation DataSet this property to True to generate animation data for selected report paths and points.
Calculate Transient ForceSet this property to True to calculate transient forces.
Run Extended CAVToggles 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.
456
Flow ToleranceFlows 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 TimeIf 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.
Controlling Results Output

You can limit the output data that is written to the result file from the WaterGEMS V8i 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.
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'
457
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
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 460).
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 V8i 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
458
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
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 V8i 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.
459
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.
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
460
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

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 V8i 2.00.12
2. WaterGEMS V8i 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 V8i 2.00.12 - Computation engine based on EPANET 2.00.12 with Bentley's own enhancements and
features.
2. WaterGEMS V8i 2.00.10- Computation engine based on EPANET 2.00.10 with Bentley's own enhancements and
features.
461
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.
462
463
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 loads. Diurnal curves are patterns that
relate to the changes in loads 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.
Note: This curve is conceptual and should not be construed as representative of any particular network.
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
464
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:
HydraulicThis type of pattern can be applied to Junctions or Tanks. Use this pattern type to describe demand or
inflow patterns over time.
ConstituentThis type of pattern can be applied to Reservoirs, Tanks, or Junctions. Use this pattern type to
describe changes in Constituent Baseline Loads over time.
PumpThis 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.
ReservoirThis 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 SettingsThis type of pattern can be applied to valves. Use this pattern type to describe changes to valve
settings over time.
Valve Relative ClosureThis 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.
465
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 UsageThis 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.
Start TimeThe 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 MultiplierThe 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 FormatThe following pattern formats are available:
StepwiseThe 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.
ContinuousThe 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.
466
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 StartThe amount of time from the Start Time of the pattern to the time step point being defined.
MultiplierThe multiplier value associated with the time step point.
Relative ClosureThe percentage of full flow that the valve allows at the associated time step point. This attribute
is only available for Operational (Transient, Valve) pattern types.
Relative Speed MultiplierThe 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.
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:
467
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.
The Control Manager consists of the following tabs:

ControlsManage all controls defined in the system.
ConditionsDefine the condition that must be met prior to taking an action.
ActionsDefine what should be done to an element in the system in response to an associated control condition.
Control SetsAssign groups of controls to Control Sets.
468
Controls Tab
The Controls tab allows you to manage all controls defined in the system. Controls can be one of two types: simple or
logical. Simple controls are made up of an IF condition and a THEN action statement. Logical controls are made up of
an IF condition, a THEN action, and an optional ELSE action, and can be assigned a priority for resolving potential
conflicts between logical controls.
Controls, Conditions, and Actions are assigned a non-editable application-provided ID (e.g., LC01).
The 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:
NewCreates a new control.
DeleteDeletes the highlighted control.
DuplicateOpens a submenu with the following options:
Duplicate (Full - create new conditions and actions)
Duplicate (Partial - use existing conditions and actions)
Control SetsEdits 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 WizardOpens the Control Wizard dialog.
Import ControlsAllows you to select a control file (.ctl) to import.
Export ControlsAllows you to export the current controls to a control file (.ctl).
ReportGenerates a summary of the selected control, listing the ID, conditions, actions, and elements incorporated
into the control.
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:
TypeWhen a Type filter other than <All> is specified, only controls of that type will be displayed in the Controls
list.
PriorityWhen a Priority filter other than <All> is specified, only controls of that priority will be displayed in the
Controls list.
Condition ElementWhen 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 ElementWhen 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.
469
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:
Evaluate as Simple ControlTurn on in order to evaluate the condition as a simple control.
IF ConditionThe drop-down list allows you to choose from a list of conditions that have already been created in
the Conditions tab.
THEN ActionThe 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.
PriorityThis 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).
DescriptionThis 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.
SummaryThis area of the dialog box displays a description of the control.
Status PaneWhen 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.
470
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):
ConditionsBecause this control needs to be triggered by multiple conditions, a Composite Condition is chosen. In
this instance, the operator OR is chosen to link the conditions, because the pump should be turned on if either condition
is true.IF condition{WW-1 Level < 5 ft.}OR condition{System Load > 5000 gpm}ActionsBecause 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
471
472
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.
473
474
475
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:
NewOpens the New Logical Action dialog box, where you can create a new logical action.
EditDepending 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.
DeleteDeletes the highlighted action. You will be prompted to confirm this action.
FindOpens the Find Logical Action dialog box, which allows you to find a particular action based on a variety of
criteria.
ReportGenerates 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 SetWhen a control set is specifed, only actions that are a component of that control set are displayed in
the Actions list.
476
TypeWhen a Type filter other than <All> is specified, only actions of that type will be displayed in the Actions
list.
Action ElementWhen 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:
ElementThe 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.
AttributeThis 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.
SettingThis 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 Head (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.
For all valves except for the GPV, there is no explicit Active status with which to base a control uponthe 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.
OperatorThe operator for logical actions is always EQUAL TO (=).
Attribute ValueThis fields 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.
DescriptionThis 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:
477
%# 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.
SummaryThis 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.
InsertAdds a new row to the Action list
DeleteDeletes the highlighted row from the Action list.
DescriptionThis 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.
SummaryThis area of the dialog box displays an automatically updated preview of the expanded description.
Control Sets Tab

The Control Sets tab allows you to create, modify and manage control sets. Control sets are a way to organize your
controls, and also provide the means to use different controls in different scenarios.
A Control Set is made up of one or more control statements (called Controls) of the form: If (condition) then (action)
else (action). The actions and conditions are defined under the Conditions or Actions tab under control.
The following options are available in this dialog box:
478
NewOpens the Logical Control Set editor dialog box. From this window, you can add previously created logical
controls to the new control set.
EditOpens the Logical Control Set editor dialog box, which allows you to edit the highlighted control set.
DuplicatePrompts for a name, then opens the Logical Control Set editor to allow you to add or remove controls
from the control set.
DeleteDeletes the highlighted control set. You will be prompted to confirm this action. You can hold down the
Ctrl key while clicking on items in the list to select multiple entries at once.
RenameAllows you to rename the highlighted control set.
ReportGenerates a summary of the highlighted control set, listing the ID, conditions, actions, and elements for all
of the logical controls contained within the control set.
Add and Remove Control Sets Dialog Box

This dialog allows you to create and manage control sets.
The dialog consists of a list pane that displays all of the control sets defined for the current project and a series of
buttons that allow you to create, edit, and manage control sets.
The following controls are located above the control set list pane:
Opens the Logical Control Set Editor, allowing you to

define a new control set.
New
Deletes the control set that is currently highlighted in the

list pane.
Delete
Creates a copy of the control set that is currently

Duplicate
Renames the control set that is currently highlighted in

the list pane.
Rename
Control Wizard
The Control Wizard lets you quickly create pump controls based on tank HGL.
479
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 V8i > View > Apply WaterGEMS V8i Renderer
command.
480
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 projects 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 project 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.
External Tools
481
External Tools allows you to manage commands which you can run directly from within WaterGEMS V8i. 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 PaneThis pane lists the external tools that have been created.
NewCreates a new external tool in the list pane.
DeleteDeletes the currently highlighted external tool.
RenameAllows you to rename the currently highlighted external tool.
CommandThis 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.
ArgumentsThis 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 ArgumentsThe 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:
Project DirectoryThis predefined argument expands to the directory where your project was last saved. The
argument string is %(ProjDir). e.g. C:\Users\MyUser\Documents\Bentley\<ProductName>\ .
Project File NameThis predefined argument expands to the file name of your project when it was last saved. The
argument string is %(ProjFileName). E.g. Project.wtg.
Project Store File NameThis predefined argument expands to the datastore filename of your project when it was
last saved. The argument string is %(ProjStoreFileName). E.g. Project.wtg.sqlite.
Project Working DirectoryThis predefined argument expands to the directory where your project is located
when it is being edited. The argument string is %(ProjWorkingDir). E.g. C:\Users\MyUser\AppData\Local\Temp
\Bentley\<ProductName>\.
Project Working File NameThis predefined argument expands to the filename of your project when it is being
edited. The argument string is %(ProjWorkingFileName). E.g. Project.wtg.$$$.
Project Store Working File NameThis predefined argument expands to the datastore filename of your project
when it is being edited. The argument string is %( ProjWorkingStoreFileName). E.g. Project.wtg.sqlite.$$$.
Working DirectoryThis predefined argument expands to the top-level temporary working directory. The
argument string is %(ProjWorkDir).
Initial DirectorySpecifies the initial or working directory of the tool or command.
[>] Predefined Initial DirectoriesThe button located to the right of the Initial Directory field provides a
submenu of predefined directory variables. The available predefined directory variables are:
Project DirectoryThe variable string is %(ProjDir). Refer to the Predefined Arguments above for more
information.
Project Working DirectoryThe variable string is %(ProjWorkingDir). Refer to the Predefined Arguments above
Working DirectoryThe variable string is %(ProjWorkDir). Refer to the Predefined Arguments above for more
information.
RunThis button executes the external tool using the specified settings.
482
Hydraulic Transient Pressure Analysis
Steady-state hydraulic models, such as WaterGEMS V8i, simulate systems in which a dynamic equilibrium has been
achieved and where changes in head or flow take minutes to hours. WaterGEMS V8i can also solve such systems using
a steady state run. In contrast, WaterGEMS V8i also simulates hydraulic systems whose balance has been upset by
rapid control-valve operation or other emergenciesall 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
483
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 > Project 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.
484
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.
485
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 pipes 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
486
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 HAMMERs results provide conservative predictions of extreme
transient pressures.
Global Adjustment to Vapor Pressure

If system pressure drops to the fluids 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
V8is 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 pressureyou can change it on the System tab of the
Project Options window (Tools > Project 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 > Project
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 Project Options window (Tools > Project
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:
487
Network TopologyChecks 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 ValidationChecks 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 pipes 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 850)).
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
Numerical Model Calibration and Validation

As part of its expert witness and break-investigation service, EHG has calibrated and validated HAMMERs 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
signalsall 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.
488
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
489
operations. This requires field measurements to quantify your systems 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 V8i, 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)
490
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)
TimeAllows you to choose the time step. The values at this time step will be used as the initial conditions for the
HAMMER transient calculations.
AllWhen this button is selected, initial conditions will be applied to all elements in the model.
SelectionWhen this button is selected, initial conditions will be applied only to elements that are currently selected in
the drawing pane.
Selection SetWhen 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 V8i can be defined by the user, or the user can elect to have
WaterGEMS V8i automatically select a time step for them. If WaterGEMS V8i 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 V8i generally requires some adjustment to the pipe lengths or wave speeds. The
adjustments are done automatically by WaterGEMS V8i, 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 V8i 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 V8i model could require excessive adjustments to the length or wave speed. If this happens,
WaterGEMS V8i prompts you to subdivide longer pipes or reduce the time step to avoid resulting inaccuracies.
In addition, many short pipes in a model will prompt WaterGEMS V8i 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.)
491
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
3. Associate SCADA signal with model element and tag from SCADA data source
4. Use SCADA data in model
492
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 WaterGEMS/CAD 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 Tools > SCADAConnect
Simulator. 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.
493
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.
494
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 496)). 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 511)).
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).
495
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 either Component > SCADA Signals or Tools > SCADAConnect
Simulator > SCADA Signals (first button on top of dialog). 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 496), SCADA Signals
- OPC (on page 501), and SCADA Signals - Citect (on page 503)).
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
496
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.
497
The fields are described below:

Connection actually establishes the connection with the data file. Picking Edit will open the dialog below:
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:
498
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:
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.
499
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.
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.
500
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 - 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.
501
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
502
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).
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.
503
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.
504
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.
505
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 Tools > 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).
506
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.
507
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.
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.
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 579)).
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 496)), 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 494)).
508
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.
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.
509
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.
510
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 515)).
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.
511
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.
512
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
513
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.
514
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 V8i and open the file for the model. Select Tools > SCADAConnect Simulator or pick the
SCADAConnect Simulator button.
515
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.
516
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.
517
Upon starting SCADAConnect Simulator, the use sees the manager below:
518
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
519
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 a data and time for data found in an historical source
3. Live loads the model with initial conditions from current data provided from an OPC server or the latest value from
a database source
4. 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.
520
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.
521
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.
522
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.
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.
523
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 Tools > 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.
524
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.
525
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.
526
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 Tools > SCADAConnect Simulator and picking the sixth
button (SCADA Results Publishing) in that dialog:
527
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.
528
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.
529
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 Tools > 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.
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.
Control Overrides - SCADAConnect Simulator
530
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.
This can also be used to simulate a power outage by setting the pump status value to Off over some time period.
Pipe Break and Shutdowns - SCADAConnect Simulator

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
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
531
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.
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.
532
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.
Fire Response - SCADAConnect Simulator

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
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.
533
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.
534
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
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.
535
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.
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.
536
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.
537
Flushing Simulation
WaterGEMS V8i 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 V8i 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 V8i 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
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 valve 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
538
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
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.
539
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

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:
540
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
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".
541
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.
542
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.
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.
543
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.
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
544
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
- UDF inactive
545
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.
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
546
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.
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.
547
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.
Compute - starts analysis of highlighted study or area.
Flushing Browser - opens up flushing browser for the selected scenario.
548
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
Help - opens flushing help
The columns listed in the browser include:
Label - the event label
Flushing Type - conventional or UDF
549
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.
550
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.
551
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.
552
Modeling Tips
The paragraph presents some FAQs related to modeling water distribution networks with WaterGEMS V8i. 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 tanks cross-sectional area can then be determined.
For example, consider a hydropneumatic tank that operates between 50 psig and 60 psig. The tanks 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:
553
Drawdown (ft.) Discharge (gpm)
40 8300
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:
554
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 2150 = 300 gpm at 80 feet. The same two pumps in series would pump 150 gpm at 280 = 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
hydrants 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:
555
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 V8i 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.
556
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:
557
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 V8i, 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 pumps
actual speed to some reference speed. The reference speed generally used is the full speed of the motor. For example, if
558
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.
559
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.
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.
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.
560
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:
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.
561
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
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.
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 V8i 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
562
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 V8i 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.
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
563
Scores that can be based on properties include standard WaterGEMS V8i 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 V8i 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
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.
564
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 V8i
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:
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
565
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.
(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 V8i 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.
566
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.
567
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 V8i 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.
568
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.
569
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.
570
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.
Pipe Break Analysis
571
572
573
574
575
576
577
578
Calibrating Your Model with Darwin Calibrator
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
project 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.

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 V8i 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.
579
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 project, 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:
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 Bentley WaterGEMS
V8i 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.
580
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.
Graph Opens the Correlation Graph dialog box, which displays a

graph of the solution that is currently highlighted in the
list pane.
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
581
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
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.
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
582
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.
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.
583
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 V8i model, rather than adding Demand Adjustment
Groups. Consider creating Demand Groups based on usage patterns. 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 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.
584
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.
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.
585
The options you specify are applied to every calibration trial in the Calibration Study. The Calibration Criteria tab
contains the following controls:
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
586
587
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.
588
The Demand tab consists of a table containing the following columns:

Demand Adjustment Group - Displays the name of the demand adjustment group.
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.
Emitter Coefficient Increment - Set the increment as the emitter coefficient intervals at which you want the GA to
range between your upper and lower limits to do this. This field will only be editable for Set Emitter Coefficient and
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.
589
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.
590
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.
Manual Runs
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.
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.
591
The Demand tab consists of a table containing the following columns:

Demand Adjustment Group - Displays the name of the demand adjustment group.
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
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
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
range between your upper and lower limits to do this. This field will only be editable for Set Emitter Coefficient and
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.
592
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.
593
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.
594
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 596)).
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.
595
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.
596
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:
597
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,
598
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 shouldnt 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 doesnt 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.
599
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 shouldnt 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 doesnt 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:
600
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 V8i . 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. Windows 98/ME users
should let Windows manage virtual memory, however, Windows NT4/2000/XP users may wish to increase the size
of their system paging file. 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 Bentley WaterGEMS V8i 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
601
Optimizing Capital Improvement Plans with Darwin Designer
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
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.

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 V8i.
2. Go to Analysis > Darwin Designer.
602
3. Click New Designer Study.
Design Study
A design study is a top-level grouping of the pipe design and rehabilitation you want to do for one complete design
project. A design study should be used to represent a real project unit, such as a system expansion, main replacement,
system augmentation, etc. For different or unrelated projects-such as a main replacement project and a project 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.
603
A design study includes the following:
604
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.
605
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:
606
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.
607
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.
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.
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.
608
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.

Click OK after you

make a selection.

Delete
609

Event.
Click OK to run.
Node Click the ellipsis to select the node from the drawing.
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 OK after you

make a selection.
610

Delete

Event.
Click OK to run.
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.
611
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.
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
612
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
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.
613
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.
614
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

This dialog allows you to create rehabilitation groups by selecting elements from the drawing or by using predefined
selection sets.
615
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.
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
616
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
project. 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.
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.
617
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
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.
618
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
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
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
project.
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.
b. Or click the Ellipsis (...) to open the Rehab Function manager where you can define a new function.
619
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.
620
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.
621
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 project and read things like log entries and dates.
622
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
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
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
623
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
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.
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.
624
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 project and read things like log entries and dates.
625
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.
626
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.
After you have computed your design run, Solutions is added to the project 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.
627
2. Click the Solution tab to view Pipe Group Type information for Design Groups and Rehab Groups.
628
3. Click the Simulated Results tab to view Constraint Type information on Pressure and Flow.
629
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
630
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.
631
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.
632
Graph Viewer Dialog Box

Using the Graph Viewer dialog box you can view the results of the water quality batch run.
633
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
634
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 748) 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.
635
Graph Tab
Data Tab

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.
636
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.
637
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.
638
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 V8i 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 V8i 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.
639
Set Field Options
Right-click on the Demand Multiplier field .

You can set the value, precision, and format for the data:
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
640
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.
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
With version 8 of Bentley WaterGEMS V8i , construction cost estimating for piping has been moved to the Darwin
Designer.
Cost calculations are performed in WaterGEMS V8i/GEMS 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 {{WaterGEMS V8i}} 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.
641
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.
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.
642
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.
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.
643
A detailed breakdown by pipes is given by picking Solution 1.
Advanced Darwin Designer Tips
644
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 V8i, 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 V8i. 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 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
existedbut, 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
645
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?
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 V8i . 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
646
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?
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
647
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:
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.
648
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%
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 V8i ) 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.
649
Optimizing Pump Operations
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 644).
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.
650
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.
651
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 project, 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.
652
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.
653
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: The Time of Day energy pattern billing period is for Scenario Energy Costs only, not for Energy
Management calculations.
Power Meters
This dialog allows you to associates pumps and pump stations with the power meter serving them.
654
The dialog consists of a list pane on the left that displays all of the power meters associated with the project 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.
655
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, tanks, and variable speed pump batteries 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 menu and select the Energy Costs command, or click
the Energy Costs button .
656
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).
After energy costs have been computed, the tree view will also contain icons for Pump Usage, Time details, 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 .
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.
Note: VSPBs are not included in the pump station calculations.
657
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
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
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.
658
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.
659
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

Delete
Renames the Unit Carbon Emission definition that is

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

Daily Cost - The energy cost divided by the number of days in the EPS run plus the demand charge divided by the days
in the billing period.
Usage Cost - The total pump energy usage over the entire EPS run, not including demand charges.
Overall Energy Used - Unit energy expended per unit of volume pumped. The formula used to arrive at this value is:
(Pump Energy Used)/(Total Volume Pumped).
Overall Unit Cost - Unit cost per unit of volume pumped. The formula used to arrive at this value is: (Usage Cost)/
(Total Volume Pumped).
After a successful energy cost calculation, the following results summaries appear in the tree view:
Pump Usage
The most important results in the Pump Usage summary are Total Energy Use Cost and Average Efficiency, either
pump or wire-to-water.
660
There are tabs for Pumps and Variable Speed Pump Batteries.
Time Details
The 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:
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
661
(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 Settings
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.
You can also view the results in graph form by clicking on the Graph tab.
662
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.
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
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.
663
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, and variable speed pump batteries 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.
664

665
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
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
666
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
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
667
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.
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
668
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
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.
669
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.

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.

Scheduler Study
670
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.
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.
671
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.
672
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:




Constraints Tab
This tab allows you to specify global pressure constraints, and then to override them locally at specified nodes if
desired.
673
First, populate the table using the following toolbar buttons:




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.
674




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.
675




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.
676




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.
677




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.
678




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.
679
Populate the table using the following toolbar buttons:




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:
680
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
681
6pm for an EPS starting at 12am, they would enter a time from started as 6 hours, and duration as 12 hours. The
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
Duration: This value, in conjunction with the Time From Start value, allows you to limit the scheduling period in
scheduler engine will ensure the pumps are not sunning at all other times.
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.
682
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.
683
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.
684
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.
685
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.
686
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.
687
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.
688
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.
689
Pump Decisions Tab

This tab displays the pump decisions summary and details.
690
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.
691
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.
This tab displays the energy used and cost for the objective elements.
692
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.
693

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.

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 approriate 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.
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,
694
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
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
695
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.
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.
696
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?
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?
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.
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
697
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.
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:
698
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:
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
699
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
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
700
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
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?
701
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).
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.
702
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).
703
Presenting Your Results

Graphs (on page 7)
Node Histories Tab
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.
704
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 V8i.
To work with annotations, open the Element Symbology manager: click View > Element Symbology (Ctrl+1).
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
705
Use the Annotation Properties dialog box to define annotation settings for each element type.
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
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
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.
706
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 project.
707
The dialog box contains a list pane that displays each of the definitions currently contained within the project, 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.
Export Exports the currently highlighted

symbology definition as an .sde file
that can be imported into other
projects.
Delete Removes the currently highlighted

symbology definition.
Duplicate Creates a copy of the currently

highlighted symbology definition.

highlighted symbology definition.
Help Displays online help for the

Symbology Definitions manager.
708
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 V8i 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 V8i automatically sets intermediate colors for the other values. For 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.
709
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.
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
710
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 V8i 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 project are stored. Choose View >
Contours to open the Contours dialog box.
The dialog box contains a list pane that displays all of the contours currently contained within the project, 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
Rename Renames the currently selected

contour.
711
Edit Opens the Contour Definition dialog

box, where you can modify the
settings of the currently selected
contour.
Export Clicking this button opens a submenu

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.
712
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.
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 ].
713
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.
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.
714
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 project, along with a
toolbar.
715
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
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.
716
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 projects 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.
717
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 719)
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.
718
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:
719
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.
720
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 project, 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.
721
The dialog box contains a list pane that displays all of the custom FlexTables currently contained within the project,
along with a toolbar.
Note that element types that are not used in the current model are marked with an icon
722
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. Folder
Creates a folder in the list pane,
allowing you to group custom
FlexTables.

FlexTable.

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.
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 project, WaterGEMS
displays two items in the FlexTable Manager: Tables - Project (for project-level FlexTables) and Tables - Shared (for
FlexTables shared by more than one WaterGEMS project). 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 - Project 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:
723
2. In the FlexTables Manager, select the folder you want to delete, then click the Delete button.
To rename a FlexTable folder:
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.
Related Topics
FlexTables Manager (on page 721)
Opening FlexTables (on page 726)
Creating a New FlexTable (on page 726)
Deleting FlexTables (on page 726)
Naming and Renaming FlexTables (on page 727)
Editing FlexTables (on page 727)
Sorting and Filtering FlexTable Data (on page 728)
Customizing Your FlexTable (on page 730)
Using Predefined Tables
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.
Export to File Export to a Shapefile .shp, a Tab

Delimited file .txt, or a Comma
Delimited File .csv.
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.
Paste Lets you paste the contents of the

Windows clipboard into the selected
table cell, row, or column. Use this
with the Copy button.
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.
724
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
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.
The status bar at the bottom of the FlexTable dialog box contains the following items:
x of x elements displayedNumber of elements displayed in the FlexTable of the total possible number of that type
of element.
FILTEREDIf 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.
SORTEDIf 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.
725
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.
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.
Opening FlexTables
You open FlexTables from within the FlexTable Manager.
To open FlexTables:
1. Click View > FlexTables or click the FlexTables button on the View toolbar to open the FlexTables Manager.
Creating a New FlexTable

You can create project-level or shared FlexTables.
Project-level FlexTables are available only for the project in which you create them.
Shared tables are available in all WaterGEMS projects.
To create a new FlexTable:
Project-level and shared FlexTables are created the same way:
2. In the FlexTables Manager, right-click Tables - Project or Tables - Shared, then select New > FlexTable.
3. Or, select Tables - Project 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.
726
Naming and Renaming FlexTables

You name and rename FlexTables in the FlexTable Manager.
To rename FlexTables:
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
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:
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:
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.
727
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:
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.
6. In the Global Edit field, type or select the value you wantfor 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:
To sort the order of columns in a FlexTable:
You can sort the order of columns in a FlexTable in two ways:
Edit the FlexTable (see Editing FlexTables (on page 727)), 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.
To sort the contents of a FlexTable:
1. Open the FlexTable you want to edit
2. Right-click a column heading to rank the contents of the column.
3. Select Sort AscendingSort Descending, or Custom.
To filter a FlexTable:
You filter a FlexTable by creating a query.
1. Open the FlexTable you want to filter.
2. Right-click the column heading you want to filter, and select Filter.
3. The Query Builder dialog box opens.
4. 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:
5. Double-click the field you wish to include in your query. The database column name of the selected field appears in
the preview pane.
728
6. Click the desired operator or keyword button. The SQL operator or keyword is added to the SQL expression in the
preview pane.
7. 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.
8. Double-click the unique value you want to add to the query. The value is added to the SQL expression in the
preview pane.
9. 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.
10. Click the Apply button above the preview pane to execute the query. If you didnt validate the expression, the
Apply button validates it before executing it.
11. 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.
729
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.
Note: Table filtering lets you perform global editing (see Editing FlexTables (on page 727)) on any subset of
elements. Only the elements that appear in the filtered table can be edited.
Custom Sort Dialog Box

You can sort elements in the table based on one or more columns in ascending or descending order. For example, the
following table is given:
Slope (ft./ft.) Depth (ft.) Discharge (cfs)
0.001 1 4.11
0.002 1 5.81
0.003 1 7.12
0.001 2 13.43
0.002 2 19.00
0.003 2 23.27
A custom sort is set up to sort first by Slope, then by Depth, in ascending order. The resulting table would appear in the
following order:
Slope (ft./ft.) Depth (ft.) Discharge (cfs)
0.001 1 4.11
0.001 2 13.43
0.002 1 5.81
0.002 2 19.00
0.003 1 7.12
0.003 2 23.27
Customizing Your FlexTable

There are several ways to customize tables to meet a variety of output requirements:
730
Changing the Report TitleWhen 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 ColumnsYou can add, remove, and change the order of columns from the Table Setup dialog
box.
Drag/Drop Column PlacementWith 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 ColumnsWith 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 HeadingsWith 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.
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.
ReplaceThis 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.
731
RenumberThis 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.
AppendThis 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. For example, only manhole attributes
are available for a manhole table.
732
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.
733
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.
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.
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.
Using Sparklines
734
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 735).
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.
735
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 Project table), the user can explicitly state the table path (e.g. Tables -
Predefined or Tables - Project). 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.
736
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 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, such as conduit diameters. (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 Project Inventory Report

To create a report that provides an overview of your network, click Report > Project 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

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.
737
Report Options
The Report Options dialog box offers control over how a report is displayed.
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.

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 cells menu.
%(Company) - The name specified in the project 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.
738
% (ProductInfo) - The current product and its build number.

% (ProjDirectory) - The directory path where the project file is stored.
% (ProjEngineer) - The engineer specified in the project properties.
% (ProjFileName) - The full file path of the current project.
% (ProjStoreFileName) - The full file path of the project.
% (ProjTitle) - The name of the project specified in the project 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.
739
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 V8i:
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. Also, you can
right-click a graph listed in Graph Manager to:
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.

graph.

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.
Help Displays online help for the Graph

Manager.
740
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.
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.
741
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 .
Graph Series Options Lets you control what your graph

displays. For more information, see
Graph Series Options Dialog Box .
Chart Settings Opens the Chart Options dialog box,

allowing you to change graph display
settings.
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
742
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
743
Graph Tab

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.
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
744
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.
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.
scenario in the graph. The Expand All button opens all of the folders so that all scenarios are visible; the Collapse
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.
745
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.
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 747) 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 > 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.
746
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
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
747
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.
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 project 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 767).
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.
748
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:
Color Lets you set a color for the background of your graph.
The Color Editor opens, see Color Editor Dialog Box (on
page 768).
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.
749
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.
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
gradients 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 gradients 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.
750
Transparency Lets you set transparency for your shadow, where 100 is
General Tab
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 767).
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.
751
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.
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.
752
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.
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
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.
753
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.
Border Lets you set a custom border for the symbols. You must
clear Default Border to use this option. The Border Editor
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 legends box. The
Color Editor opens, see Color Editor Dialog Box (on page
768).
Frame Lets you define the outline of the legends box. The
Border Editor opens, see Border Editor Dialog Box (on
page 767).
Pattern Lets you set a pattern for the fill of the legends box. The
Box.
Round Frame Lets you round the corners of the legends box. Select this
check box to round the corners of the shape.
Transparent Lets you set the fill of the legends 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 legends 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:
754
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
768)).
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.


Colors Tab
Start Lets you set the starting color for your gradient.
box if you want a two-color gradient.
End Lets you select the final color for your gradient.
755
Options Tab
Sigma Lets you use the options controls. Select this check box to
Sigma Focus Lets you set the location on the chart background of the
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.

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 768).
Pattern Lets you set a pattern for the shadow. The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box.
Bevels Tab
Use the Bevels tab to create a rounded effects for the legend. The Bevels tab contains the following controls:
effect, for the background for the selected title.
756
effect, for the inside of the background for the selected
title.
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 graphs
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.
757
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
page 767).
Color Lets you set a color for the graph of the selected series.
The Color Editor opens, see Color Editor Dialog Box (on
page 768).
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 757)). The Hatch Brush Editor
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 V8i.
Color Each line Lets you enable or disable the coloring of connecting
lines in a series. This is unused by WaterGEMS V8i.
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
Stairs Lets you display a step effect between points on your

graph.
Inverted Inverts the direction of the stairs effect
758
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.

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
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 767).
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
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.
759
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 757)).
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 V8i.
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 V8i 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 V8i.
Randomxxxx not sure
Number of sample valuesxxxx not sure
Defaultxxxx not sure
Applyxxxx 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:
Visible Lets you display marks.
760
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
Border Lets you set up the leader line. The Border Editor opens,
see Border Editor Dialog Box (on page 767).
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 771).
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
768).
Frame Lets you define the outline of the boxes. The Border
Editor opens, see Border Editor Dialog Box (on page
767).
761
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
expect to see.
Transparency Lets you set transparency for the boxes, where 100 is
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
768)).
Fill Lets you set a pattern for the text. The Hatch Brush Editor
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
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

762


Colors Tab
Options Tab
Shadow Tab
Use the Shadow tab to create a shadow for the marks. The Shadow tab contains the following controls:

shadow effect.

opens, see Color Editor Dialog Box (on page 768).
763
Bevels Tab
Use the Bevels tab to create a rounded effects for your marks. The Bevels tab contains the following controls:
effect, for the background for the selected title.
effect, for the inside of the background for the selected
title.
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 772). 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 V8i.
Note: Each tool has its own parameters, see Chart Tools Gallery Dialog Box (on page 772).
Chart Options Dialog Box - Export Tab

Use the Export tab to save your graph for use in another application. The Export tab contains the following controls:
764
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:
765
Include Series Data This is unused by WaterGEMS V8i.
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 doesnt 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.
766
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
768).
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
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:
767
Format Tab



Colors Tab
Options Tab
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:
768
Transparency Lets you set transparency for your color, where 100 is
Custom Lets you define a custom color to use. The Color dialog
box opens, see Color Dialog Box (on page 769).
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:
Custom Lets you define a custom color to use. The Color dialog
box opens, see Color Dialog Box (on page 769).
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
769
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 768).
% Lets you set transparency for your color, where 100 is

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
Format Tab



Colors Tab
770
Options Tab
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.

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.
771
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
Transparency Lets you set transparency for the pointers, where 100 is
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 764).
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.
772
Pen Lets you define the cursor tool. The Border Editor opens,
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
760). After you have added the Drag Marks tool to your graph, you can modify the following settings:
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:
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:
tool.
Pen Lets you define the line. The Border Editor opens, see
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.
773
Gantt Drag
Lets you move and resize Gantt bars by dragging. This is unused by WaterGEMS V8i.
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:
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:
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:
tool.
774
Fill Lets you set the fill for the nearest-point indicator. The
Box.
Border Lets you set the outline of the nearest-point indicator. The
page 767).
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 V8i.
Series Animation
Animates series points. After you have added the Series Animation tool to your graph, you can modify the following
settings:
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
775
Fill Lets you set the fill for the arrows. The Hatch Brush
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
767).
Pattern Lets you set the fill of the color band. The Hatch Brush
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 767).
Color Lets you set a solid color for the color band. The Color
Editor opens, see Color Editor Dialog Box (on page 768).
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.
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.
776
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
767).
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 757)), 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 V8i.
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.
777
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,
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 771).
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 768).
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
expect to see
778
Transparency Lets you set transparency for the boxes, where 100 is
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.
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
completely opaque.
Gradient Tab
Format Format Lets you set up the gradients 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.
779
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 768). 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 gradients
end color. Sigma Scale Lets you control how much of
the gradients end color is used by the gradient
background.
Shadow Tab

shadow effect.

opens.
Editor opens.
Bevels Tab
effect, for the outside of the legend.
780
effect, for the inside of the legend.
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
TeeChart Gallery Dialog Box

Use the TeeChart Gallery dialog box to change the appearance of a series.
781
Series
The available series chart designs include:

Standard
Stats
Financial
Extended
3D
Other
View 3DLets 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.
SmoothSmooths 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
782
Extended
View 3DLets 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.
SmoothSmooths the display of the charts. Select this check box to smooth the display, clear it to turn off
smoothing.
Customizing a Graph
783
784
785
786
787
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
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.
788
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).
The following controls are available in the Calculation Summary dialog box:
789
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.
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.
scenario in the graph. The Expand All button opens all of the folders so that all scenarios are visible; the Collapse
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.
Transient Results Viewer
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:
790
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.
File: The File menu contains the following commands:
Open: Allows you to select a HAMMER output (.hof), graph (.grp), or animation (.ani) file you want to view.
Note: normally the appropriate HAMMER output file is opened automatically when the Transient Results
Viewer is launched.
Exit: Closes the Transient Results Viewer.
Settings: The Settings menu contains the following commands:
Anti-Alias: When this toggle command is checked, the lines in plots and animations will be smoothed.
Show Logo: When this toggle command is checked, the logo defined by the Tools > Set Logo command will be
displayed in the results viewer window.
Show Company Name: When this toggle command is checked, the company name defined by the Tools > Set
Company Name command will be displayed in the results viewer window.
Tools: The Tools menu contains the following commands:
Set Logo: Opens a browse menu allowing you to choose a .gif file that will be used when the Settings>Show
Logo command is toggled on.
Set Company Name: Opens a dialog allowing you to enter a company name that will be used when the
Settings>Show Company Name command is toggles on. You can also choose the font, font style, and font size
that will be used.
Help: The Help menu contains the following command:
About: Opens the Bentley Bentley HAMMER About box.
Path (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 715) section.
Graph Type: Select the attribute(s) that will be displayed on the plot/animation.
Plot: Click this button to generate a plot of the currently selected graph type along the currently selected profile
path.
Animate: Click this button to generate an animation of the currently selected graph type along the currently
selected profile path.
Number of Points: 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 fo the profile path.
Time Histories: Select the Report Point.
Graph Type: Select the attributes(s) that will be displayed on the plot/animation.
Plot: Click the button to generate a plot of the currently selected graph type for the currently selected report
point.
Animate: Click this button to generate an animation of the currently selected graph type for the currently
selected report point.
End Point: This field displays the report point of the Time History.
Number of Time Steps: This field displays the number of time steps in the transient simulation.
791
Looking from left to right, the Transient Results Viewer allows you to select the locations (point histories or pipeline
profiles) for which to display one or more of the result variables (head, flow, or volume) as plots or animations:
Clicking Plot automatically displays the selected variables on a graph so you can annotate, save, and print it.
Clicking Animate displays the selected variables on a graph and automatically loads the compact Animation
Controller so you can animate all on-screen graphs. You can also save the screen layouts you prepare (as an .ani
file) for use in future presentations.
The components of the Animation Controller are:
Play Controls: Like other media devices, these controls let you play forward or backward, stop, or advance by a
single frame forward or backward.
Menus: Similar to those in the Viewer but only showing applicable commands.
Time Valve: Shows the time step or framme for which results are currently displayed onscreen for point histories or
path (profile) graphs (not shown).
Clock: The large, easy-to-read clock displays minutes, seconds, and hundredths of a second. Transient pressure
pulses can travel fast enough to require this degree of simulation and display accuracy.
Slider: Control animation speed (in frames per second) and frame position. Manipulate them during an animation to
jump ahead or change speed.
Using the Java Transient Results Viewer
By default, the new Transient Results Viewer is used. To revert to the older Java Transient Results Viewer:
Open the "TransientResultViewerOptions.xml" file located in the C:\ProgramData\Bentley\HAMMER\8\ directory.
The line that determines which viewer is used is UseNewViewer.
The available options are YES, NO, PROMPT (settings will not be case sensitive)
yEs = uses new version
nO = uses old viewer
pROmpt = opens a prompt that allows you to choose which viewer to use
Format Graph Shortcut Viewer
These menu commands are only available from within the Transient Results Viewer. Open this menu by right-clicking
on a graph axis.
The formatting category includes the following menu commands to format the contents of the output variable graphs
(in Viewer) to obtain report-ready figures:
Format Graph: Opens a dialog to select the axis titles and labels, major and minor grid lines, tick marks,
background color, and outline style.
Format Data: Opens a dialog to select the line type, color, and thickness for each output variable (head, flow, or
volume) displayed in the current graph. For the currently selected output variable, you can specify an offset value to
create a new line parallel to it; for example, to show a pipeline's surge pressure tolerance. You can also limit your
formatting selections to a Line Segment, to show different pipe materials along a pipeline, for example.
792
Note: A Line Segment is a portion of the dependent variable (head, flow, or volume) bounded by two user-
selected values of the independent variable (on the x-axis). You can subdivide output variables into several
Line Segments.
Format Shades: Opens a dialog to create and modify Differential Shades between any two output variables (head,
flow, or volume). You can select the color and opacity of each Differential Shade. You can toggle each Differential
Shade on or off to improve animation performance or to reduce the size of a graph when printing to a file.
Copy Settings: Copies the settings for the current graph to the Windows clipboard.
Paste Settings: Modifies the current graph using the settings previously copied to the Windows clipboard.
Copy Symbols: Copies all symbols in the current graph pane to the Windows clipboard.
Paste Symbols: Pastes the symbols previously copied to the Windows clipboard into the current graph pane.
The edit category includes the following menu commands:
Copy Data: Copies the output variable line data shown in the current graph pane so you can paste it into another
graph.
Paste Data (-): Clears the contents of the current graph pane, then pastes the output variable line data previously
copied to the Windows clipboard into the current graph pane.
Paste Data (+): Pastes the output variable line data previously copied to the Windows clipboard into the current
graph pane so you can compare the results of two HAMMER project files. All results are displayed at the correct
scale using the units set for the graph.
The draw category includes the following menu commands, which are available in the Viewer only:
Draw Lines: Draws vertical, horizontal, or diagonal lines and allows you to specify their line type, color, and
thickness.
Draw Text: Allows you to enter vertical or horizontal text labels.
Draw Symbols: Displays a graphical list of hydraulic symbols you can insert into the current graph pane.
The node symbols category includes the following menu commands, which are available in the Viewer only:
Set Symbol Size: Sets the symbol size for nodes.
Set Text Size: Sets the size of node labels.
Show/Hide Labels: Shows or hides node labels.
Show/Hide Junctions: Shows or hides junctions.
Show/Hide Consumptions: Shows or hides consumptions.
These menu commands are only available from within the Transient Results Viewer by right-clicking anywhere except
the graph axes.
FlexUnits: Opens the FlexUnits manager, from which you can select the units of measurement, display precision,
and whether or not to use scientific notation. Please note that changes made here are local to the current instance of
the Transient Results Viewer. If the Transient Results Viewer is closed and re-opened, the units will be reset to the
units used in the main HAMMER interface.
The graph display category includes the following menu commands to adapt the appearance of each graph for use on
screen or as a printed figure.
Show Frame (Ctrl + F): Toggles the display of the frames that convert an on-screen plot to a report-ready figure,
complete with your company logo, project number, date, and a title block.
Page View (Ctrl + V): Toggles the display of the page outline to help you visualize how it will look after printing.
With HAMMER figures, what you see is what you get (WYSIWYG) so there is no need for a print preview
command.
793
Lock Aspect Ratio (Ctrl + L): Toggles the display of the frames between figure format, in which the length and
width are scaled to the paper size, and on-screen format, for which you can set the length and width by dragging the
corner of the graph window.
Show Title Bar (Ctrl + T): Toggles the display of the graph window's title bar. Turn title bars off to maximize the
display area; for example, when animating.
The print and save category includes the following menu commands to specify printing options:
Page Setup: Opens a dialog box in which you can select a printer, set page orientation, and set margin widths.
Print (Ctrl + P): Prints the current graph according to the graph display options currently shown in the graph
window.
Save (Ctrl + S): Saves the current graph file to disk, overwriting any previous version of the same name.
Remember to save your work often.
Save As: Saves the current graph file to disk under a different filename. A dialog box prompts you to enter the
drive, directory, and new file name.
The data sources category includes the following menu commands to specify or modify data sources.
Set Data From: Opens an .rpt file and plots the selected variables in the current graph window, after deleting the
current graph contents.
Add Data From: Opens an .rpt file and plots the selected variables in the current graph window, without deleting
the current graph window, without deleting the current graph window, without deleting the current graph contents.
Use for deleting the current graph contents. Useful for comparing the results of two similar HAMMER projects.
Close (Ctrl + F4): Closes the current graph window without saving its contents.
Transients Results Viewer Dialog (New)
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 (on page 794)
Time Histories Tab (on page 798)
Node Histories Tab (on page 704)
Profiles Tab
This tab allows you to view profile results from transient simulations.
794
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 715) 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 797).
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
This dialog displays the transient profile using the settings on the Transient Results Viewer Profiles Tab (on page 794).
795
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).

Profile Options: Clicking this button opens the Transient Profile Viewer Options Dialog Box (on page
797), 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
797).
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.
796
To zoom back out, click and hold the mouse button, drag the mouse in the opposite direction (right to left), and
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.
797
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
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 799).
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.
Node Histories Tab
798
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
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).

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

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.
799
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
800
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)
801
Importing and Exporting Data
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 V8i 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.
Moving Data and Images Between Model(s) and other Files
WaterGEMS V8i 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.
802
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 project 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.
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:\Documents and Settings\<User Name>\Local
Settings\Application Data\Bentley\<Product Name>\8 (under Windows 2003 Server/XP) or C:\Users\<User
Directory>\AppData\Local\Bentley\<Product Name>\8 (under Windows Vista, Windows 7, and Server 2008).
Highlight the flex table, right click, and select Duplicate > As shared flex table.
Importing a WaterGEMS V8i Database
You can import a WaterGEMS V8i database file, which will create a new model using the data in the database.
To import a WaterGEMS V8i Database
1. Click the File menu, select Import, then choose WaterGEMS V8i Database from the submenu.
2. Browse to and highlight the wtg.sqilte file to import.
3. Click Open.
803
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 project. 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.
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.
804
Exporting a Submodel
You can export any portion of a model as a submodel for import into other projects. 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 project 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.
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.
805
File Upgrade Wizard
The File Upgrade Wizard allows you to allows you to upgrade older WaterGEMS V8i database files to the most current
format.
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 V8i 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
V8i, 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.
806
Menus
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.
Menus
To learn more about the menus, click the links below:
File Menu
The File menu contains the following commands:
New Creates a new project. When you select this command, a

new untitled project is created.
Open Opens an existing project. When you select this

command, the Open dialog box opens, so you can choose
which program to open.
Close Closes the current project without exiting the program.
Close All Closes all currently open projects.
Save Saves the current project.
Save As Saves the current project under a new project name and/or
to a different directory location.
Save All Saves all currently open projects.
807
Menus
Update Server Copy Updates the ProjectWise server copy using the current
project.
Import Opens a menu containing the following commands:

WaterGEMS V8i/HAMMER Database Opens a Select
Database File to Import window where you can choose
the file to import (*.sqlite). EPANET Opens a Select
EPANET File to Import window where you can choose
the file to import (*.inp). WaterGEMS V8i Database
Lets you import a WaterGEMS V8i project database file.
Submodels Opens a Select Submodel File to Import
window where you can choose the file to import
(*.sqlite).
Export Opens a menu containing the following commands: DXF

Export the current network layout as a DXF drawing.
EPANET Opens a Select EPANET File to export
window where you can choose the file to export (*.inp).
Submodels Export the current project to a Submodel
file (*.sqlite). WaterGEMS V8iExport the current
project to a WaterGEMS V8i input file (.inp). Publish i-
modelOpens the Publish to i-model dialog.
Seed Seed files allow you to save project settings and data as a
template (the seed file has an .sts extension). You can
then reuse these settings/data while creating new projects
using the data from the previously saved seed file.
Selecting the Seed command opens a submenu containing
the following commands: New from Seed: Allows you to
create a new project using the previously saved seed file
you specify. Save to Seed: Saves the current project
settings and data as a seed file for reuse in future projects.
Page Setup Opens the Page Setup dialog box where the print settings
can be set up.
Print Preview Opens a submenu containing the following commands:

Fit to Page Opens the Print Preview window,
displaying the current view as it will be printed. The view
will be zoomed in or out so that the current view fits to a
single page of the default page size. Scaled Opens the
Print Preview window, displaying the current view as it
will be printed. The view will be scaled so that it matches
the user-defined drawing scale (this is defined on the
Drawing Tab of the Options dialog: Tools > Options).
808
Menus
Print Opens a submenu containing the following commands:

Fit to Page Prints the current view. The view will be
zoomed in or out so that the current view fits to a single
page of the default page size. Scaled Prints the current
view. The view will be scaled so that it matches the user-
defined drawing scale (this is defined on the Drawing Tab
of the Options dialog: Tools > Options).
Project Properties Opens the Project Properties dialog box where Title, File
Name, Engineer, Company, Date, and Notes can be
added.
Recent Files When the Recent Files Visible option is selected in the
Options dialog box, the most recently opened files will
appear in the File menu.
Exit Closes the program.
Edit Menu
The Edit menu contains the following commands:
Undo Cancels the last data input action on the currently active
dialog box. Clicking Undo again cancels the second-to-
last data input action, and so on.
Redo Cancels the last undo command.
Delete Deletes the currently highlighted element.
Select By Polygon Lets you select elements in your model by drawing a

polygon in the drawing pane. Click in the drawing pane to
draw each side of the polygon, then right-click and select
Done when the polygon is complete. All elements
contained within the polygon will be selected.
Select by Polygon Selects elements by Polygon.
Select All Selects all of the elements in the network.
Invert Selection Selects all of the currently unselected elements in the

drawing pane and deselects all of the currently selected
elements.
Select by Element Opens a menu listing all available element types. Select
one of the element types from the submenu to select all
elements of that type in the model.
809
Menus
Select by Attribute Opens a menu listing all available attribute types. Select
one of the attribute types from the menu and the Query
Builder dialog box opens.
Clear Selection Deselects the currently selected element(s).
Clear Highlight Removes Network Navigator highlighting for all

elements.
Find Element Finds a specific element by entering the elements label.
Analysis Menu
The Analysis menu contains the following commands:
Scenarios Opens the Scenario Manager, which allows you to create,

view, and manage project scenarios.
Alternatives Opens the Alternative Manager, which allows you to

create, view, and manage alternatives.
Calculation Options Opens the Calculation Options Manager, which allows

you to create, view, and manage calculation settings for
the project.
Post Calculation Processor Opens the Post Calculation Processor dialog.
Totalizing Flow Meters Opens the Totalizing Flow Meters manager where you
can create new meters.
Hydrant Flow Curves Opens the Hydrant Flow Curves dialog box, which allows
you to view, edit, and create hydrant flow definitions.
System Head Curves Opens the System Head Curves manager.
Transient Results Viewer Opens the transient results viewer dialog.
Transient Time Step Options Opens the Transient Time Step Options dialog.
Transient Thematic Viewer Opens the Transient Thematic Viewer dialog.
Energy Costs Opens the Scenario Energy Cost Manager, where you can
view and compute energy costs.
Darwin Calibrator Opens the Darwin Calibrator where you can create, edit,
and run calibration studies.
Darwin Designer Opens the Darwin Designer where you can create, edit,
and run designer studies and design runs.
810
Menus
Darwin Scheduler Opens the Darwin Scheduler where you can create, edit,
and run scheduler studies and design runs.
Criticality Opens the Segmentation and Criticality Manager where

you can create new criticality scenarios.
Pressure Zone Opens the Pressure Zone manager where you can identify
elements that are located in a pressure zone based on the
boundaries of the zone.
Time Browser Opens the Time Browser dialog box, where you can
manipulate the currently displayed time step and animate
the drawing pane.
Fire Flow Results Browser Opens the Fire Flow Results Browser, which allows you
to quickly jump to fire flow nodes and display the results
of fire flow analysis at the highlighted node.
Flushing Results Browser Opens the Flushing Results Browser, allowing you to
display the results of the flushing analysis at various
locations.
Calculation Summary Opens the Calculation Summary to view results.
Transient Calculation Summary Opens the Transient Calculation Summary to view results
of transient calculations.
User Notifications Opens User Notifications allowing you to view warnings

and errors uncovered by the validation process.
Patterns Opens the Pattern Manager where you can create and edit
diurnal loading patterns for use with extended period
simulations.
Pattern Setups Opens the Pattern Setup Manager where you can associate
diurnal patterns with the appropriate unit sanitary loads
for a given scenario.
Validate Runs a diagnostic check on the network data to alert you

to possible problems that may be encountered during
calculation. This is the manual validation command, and
it checks for input data errors. It differs in this respect
from the automatic validation that WaterGEMS V8i runs
when the compute command is initiated, which checks for
network connectivity errors as well as many other things
beyond what the manual validation checks.
Compute Initial Conditions Allows you to establish the initial conditions for the
transient simulation
811
Menus
Compute Calculates the network. Prior to calculating, an automatic

validation routine is triggered, which checks the model
for network connectivity errors and performs other
validation.
Always Compute Initial Conditions When this option is toggled on, initial conditions will
always be computed when a Compute command is
initiated.
Components Menu
The Components menu contains the following commands:
Controls Opens the Controls manager where you can set controls,
conditions, actions, and logical control sets.
Zones Opens the Zones manager where you can create, edit,
duplicate, or delete zones.
Patterns Opens the Patterns manager where you can create and edit
patterns.
Pressure Dependent Demand Functions Opens the Pressure Dependent Demand Functions
manager where you can create and edit pressure
dependent demands.
Unit Demands Opens the Unit Demands manager where you can create
and edit unit demands based on area, count and
population.
Pump Definitions Opens the Pump Definitions manager where you can
create and edit pump definitions.
Minor Loss Coefficients Opens the Minor Loss Coefficients Manager dialog.
GPV Headloss Curves Opens the GPV Headloss Curves manager where you can
create and edit headloss curves for General Purpose
Valves.
Constituents Opens the Constituents manager where you can create,

edit, duplicate, or delete constituents.
Valve Characteristics Opens the Valve Characteristics dialog.
Air Flow Curves Opens the Air Flow Curves dialog.
Time Series Field Data Opens the Time Series Field Data dialog.
Engineering Libraries Opens the Engineering Libraries Manager.
812
Menus
View Menu
The View menu contains the following commands:
Element Symbology Opens the Element Symbology Manager, which allows

you to create, view, and manage annotation and color-
coding in your project.
Background Layers Opens the Background Layers Manager, which allows

you to create, view, and manage the background layers
associated with the project.
Network Navigator Opens the Network Navigator.
Selection Sets Opens the Selection Sets Manager, which allows you to
create, view, and manage selection sets associated with
the project.
Queries Opens the Query Manager, where you can create SQL
expressions for use with selection sets and FlexTables.
Prototypes Opens the Prototypes Manager, where you can enter

default values for elements in your model. Prototypes can
reduce data entry requirements if a group of network
elements share common data.
FlexTables Opens the FlexTables Manager, where you can create,

view, and manage the tabular reports for the project.
Graphs Opens the Graph Manager, where you can create, view,
and manage graphs for the project.
Profiles Opens the Profile Manager, where you can create, view,
and manage the profiles for the project.
Contours Opens the Contours manager where you can create and
edit contour definitions.
Named Views Opens the Named Views manager where you can create,
edit, and use Named Views.
Aerial View Opens the Aerial View navigation window.
Properties Turns the Properties Editor display on or off.
Property Grid Customizations Opens the Property Grid Customizations Manager.
813
Menus
Auto-Refresh Turns automatic updates to the main window view on or

off whenever changes are made to the WaterGEMS V8i
datastore. When selected, a check mark indicates that
automatic updates are turned on.
Refresh Drawing Updates the main window view according to the latest
information contained in the WaterGEMS V8i datastore.
Zoom Opens a menu containing the following commands: Zoom

Extents Sets the view so that the entire network is
visible in the drawing pane. Zoom Window Activates
the manual zoom tool, which lets you specify a portion of
the drawing to enlarge. Zoom In Enlarges the size of
the model in the drawing pane. Zoom Out Reduces the
size of the model in the drawing pane. Zoom Realtime
Enables the realtime zoom tool, which allows you to
zoom in and out by moving the mouse while holding
down the left mouse button. Zoom Center Opens the
Zoom Center dialog box, which allows you to enter
drawing coordinates that will be centered in the drawing
pane. Zoom to Selection Enables you to zoom to
specific elements in the drawing. You must select the
elements to zoom to before you select the tool. Zoom
Previous Resets the zoom level to the last setting.
Zoom Next Resets the zoom level to the setting that
was active before a Zoom Previous command was
executed.
Pan Activates the Pan tool, which allows you to move the
model within the drawing pane. When you select this
command, the cursor changes to a hand, indicating that
you can click and hold the left mouse button and move
the mouse to move the drawing.
Toolbars Opens a menu that lists each of the available toolbars.

Select one of the toolbars in the menu to turn that toolbar
on or off.
Reset Workspace Resets the WaterGEMS V8i workspace so that the

dockable managers appear in their default factory-set
positions.
Tools Menu
The Tools menu contains the following commands:
Active Topology Selection Opens a Select dialog to select elements in the drawing to
make them Inactive or Active.
814
Menus
ModelBuilder Opens the ModelBuilder Connections Manager, where

you can create, edit, and manage ModelBuilder
connections to be used in the model-building/model-
synchronizing process.
TRex Opens the TRex wizard where you can assign elevation to
model nodes using data from outside sources.
SCADAConnect Simulator Opens the SCADAConnect Simulator where you can add
or edit SCADA connections.
Skelebrator Skeletonizer Opens the Skelebrator manager, where you can define and
perform skeletonization operations.
LoadBuilder Opens the LoadBuilder manager where you can assign

demands to model nodes using data from outside sources.
Thiessen Polygon Opens the Wizard used to create Thiessen polygons for
use with LoadBuilder.
Demand Control Center Opens the Demand Control Center manager where you
can add new demands, delete existing demands, or
modify existing demands.
Unit Demand Control Center Opens the Unit Demand Control Center manager where
you can add new unit demands, delete existing unit
demands, or modify existing unit demands.
Scenario Comparison The scenario comparison tool enables you to compare

input values between any two scenarios to identify
differences quickly.
Hyperlinks Associate external files, such as pictures or movie files,

with elements in the model.
User Data Extensions Opens the User Data Extension dialog box, which allows
you to add and define custom data fields. For example,
you can add new fields such as the pipe installation date.
Assign Isolation Valves to Pipes Opens the Assign Isolation Valves to Pipes where you can
find and assign isolation valves to their closest pipes
according to user-defined tolerances.
Batch Pipe Split Opens the Batch Pipe Split dialog.
Batch Morph Opens the Batch Morph dialog.
Wave Speed Calculator Opens the Wave Speed Calculator dialog.
Copy Initial Conditions Opens the Initial Conditions dialog.
815
Menus
Database Utilities Opens a menu containing the following commands:

Compact Database When you delete data from a
WaterGEMS V8i project, such as elements or
alternatives, the database store that WaterGEMS V8i uses
can become fragmented, causing unnecessarily large data
files, which impact performance substantially.
Compacting the database eliminates the empty data
records, thereby defragmenting the datastore and
improving the performance of the file.
Note: Every tenth time a file is saved, Bentley

WaterGEMS V8i will automatically prompt you to
compact the database. If you open a file without
saving it, the count does not go up. If you open and
save a file multiple times in the same session, the
count only goes up on the first save. If you open, save,
and close the file, the count goes up. Click Yes to
compact the database, or no to close the prompt
dialog box without compacting. Since compacting the
database can take time, especially for larger models,
you may want to postpone the compact procedure
until a later time. You can modify how WaterGEMS
V8i compacts the database in the Options dialog box.
Synchronize Drawing Synchronizes the current model

drawing with the project database. Update Database
Cache Updates the current model to reflect any changes
made in the database. Update Results From Project
DirectoryThis command copies the model result files
(if any) from the project directory (the directory where the
project .sqlite file is saved) to the custom result file
directory. The custom result directory is specified in
Tools>Options>Project tab. This allows you to make a
copy of the results that may exist in the model's save
directory and replace the current results being worked on
with them. Copy Results to Project DirectoryThis
command copies the result files that are currently being
used by the model to the project directory (where the
project .sqlite is stored).
Layout Opens a menu that lists each of the available element

types. Select one of the element types to place that
element in your model.
External Tools Run an existing external tool or create a new one by

opening up the External Tools manager.
Options Opens the Options dialog box, which allows you to

change Global settings, Drawing, Units, Labeling, and
ProjectWise.
816
Menus
Report Menu
The Report menu contains the following commands:
Element Tables Opens a menu that allows you to display FlexTables for
any link or node element. These predefined FlexTables
contain most of the input data and results for each
instance of the selected element in the model.
Scenario Summary Opens the Scenario Summary Report.
Project Inventory Opens the Project Inventory Report, which contains the
number of each of the various element types that are in
the network.
Pressure Pipe Inventory Opens the Pressure Pipe Inventory report.
Transient Analysis Reports Opens a submenu containing a number of reports

displaying the results of a transient analysis.
Report Options Opens the Report Options box where you can set Headers
and Footers for the predefined reports.
Help Menu
The Help menu contains the following commands:
WaterGEMS V8i Help Opens the online help Table of Contents.
Quick Start Lessons Opens the online help to the Quick Start Lessons
Overview topic.
Welcome Dialog Opens the Welcome dialog box.
Check for SELECT Updates Opens your Web browser to the Bentley Web site, where
you can check for WaterGEMS V8i updates.
Bentley Institute Training Opens your browser to the Bentley Institute Training web
site.
Bentley Professional Services Opens your browser to the Bentley Professional Services
web site.
Bentley SELECT Support Opens your browser to SELECTservices area of the

Bentley web site.
817
Technical Reference
Bentley Communities Opens your browser to the BentleyCommunities section

of the website.
Bentley.com Opens the home page on the Bentley web site.
About WaterGEMS V8i Opens the About WaterGEMS V8i dialog box, which
displays copyright information about the product,
registration information, and the current version number
of the release.
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:
PipesTransport water from one location (or node) to another.
Junctions/NodesSpecific 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 TanksBoundary 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.
PumpsRepresented as nodes. Their purpose is to provide energy to the system and raise the water pressure.
ValvesMechanical 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.
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.
818
Technical Reference
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:
Where:
p = Pressure (N/m2, lb./ft.2)
= Specific weight (N/m3, lb./ft.3)

z = Elevation at the centroid (m, ft.)
819
Technical Reference
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.
EGL and HGL
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)
820
Technical Reference
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:
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 modelers 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.
821
Technical Reference
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.
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 ]
822
Technical Reference
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:
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
823
Technical Reference
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:
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 Choleskys method which has been
824
Technical Reference
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
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)
825
Technical Reference
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.33Hd and Qo = 2.00Qd. 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).
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.)
826
Technical Reference
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.
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
827
Technical Reference
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 providers 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.
Friction and Minor Loss Methods
Chezys Equation
Chezys equation is rarely used directly, but it is the basis for several other methods, including Mannings equation.
Chezys equation is:
828
Technical Reference
Q = Discharge in the section (m

3 /s, cfs)
C = Chezys 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:
Free Surface:
Full Flow (Closed Conduit):
f = Friction factor (unitless)
k = Darcy-Weisbach roughness
height (m, ft.)
Re = Reynolds Number (unitless)
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:
829
Technical Reference
Q = Discharge in the section (m

3 /s, cfs)
C = Hazen-Williams roughness
coefficient (unitless)
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)
L = Pipe length (m, ft.)
V = Flow velocity (m/s, ft./sec.)
For section geometries that are not circular, this equation is adapted by relating a circular sections full-flow hydraulic
radius to its diameter:
D = 4R
830
Technical Reference
D = Diameter (m, ft.)
This can then be rearranged to the form:
Q = Discharge (m 3 /s, cfs)
factor (unitless)
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.)
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.
831
Technical Reference
Mannings Equation
Note: Mannings roughness coefficients are the same as the roughness coefficients used in Kutters equation.
Mannings equation, which is based on Chezys equation, is one of the most popular methods in use today for free
surface flow. For Mannings equation, the roughness coefficient in Chezys equation is calculated as:
C = Chezys roughness
coefficient (m 1/2 /s, ft.
1/2 /sec.)
n = Mannings 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 Chezys equation, you obtain the well-known Mannings equation:
k = Constant (1.00 m 1/3 /s,

1.49 ft. 1/3 /sec.)
n = Mannings roughness
(unitless)
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.
832
Technical Reference
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
its a mess. Using half the minor loss coefficient isnt exactly correct, but it pretty much accounts for things.
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 V8i. 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 VSPsThe 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 APEXA 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 NodesWhen 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.
TanksWhen 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.
833
Technical Reference
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.
xxxx Does the following e.g. belong here?
hr = h1 + h2
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
834
Technical Reference
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:
Solved for D:
835
Technical Reference
Mannings Equation
Series Pipes
Solved for n:
Solved for D:
Parallel Pipes
Solved for n:
836
Technical Reference
Solved for D:
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.)
factor (unitless)
L = Pipe length (m, ft.)
V = Flow velocity (m/s, ft./sec.)
For section geometries that are not circular, this equation is adapted by relating a circular sections full-flow hydraulic
radius to its diameter:
D = 4R
837
Technical Reference
D = Diameter (m, ft.)
This can then be rearranged to the form:
factor (unitless)
The Swamee and Jain equation can then be used to calculate the friction factor.
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
its a mess. Using half the minor loss coefficient isnt exactly correct, but it pretty much accounts for things.
Thiessen Polygon Generation Theory
838
Technical Reference
Plane Sweep Method
Nave 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 nave 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 nave 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.
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
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
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:
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.
839
Technical Reference
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%.
840
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
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).
841
Technical Reference
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.
842
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 Users 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 Users 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.
843
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,
Rossman, Lewis A., EPANET Users 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
844
Technical Reference
Salgado, R., Todini, E., & OConnell, 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.
845
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
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 Users 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 Users 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.
846
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,
Roberson, John A. and Clayton T. Crowe, Engineering Fluid Mechanics 4th Edition, Houghton Mifflin Company,
Rossman, Lewis A., EPANET Users 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
Salgado, R., Todini, E., & OConnell, 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.
847
Technical Information Resources
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.

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.
848
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
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 V8i, 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
849
TechNotes, FAQs and other technical support information are available online at WaterGEMS V8i 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
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
850
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 V8i . 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.
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 V8i .log files located in the product directory (e.g., C:\Documents and
Settings\<User Name>\Local Settings\Application Data\Bentley\<Product Name>\8 (under Windows 2003
Server/XP) or C:\Users\<User Directory>\AppData\Local\Bentley\<Product Name>\8 (under Windows Vista,
Windows 7, and Server 2008).
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
851
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.
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.
852
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.
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.
853
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.
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.
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.
854
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
Pressure (Maximum at Start Node, Transient): Maximum pressure at the pipe's start node over the course of the
Pressure (Minimum at Stop Node, Transient): Minimum pressure at the pipe's stop node over the course of the
Pressure (Minimum at Start Node, Transient): Minimum pressure at the pipe's start node over the course of the
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
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.
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.
855
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

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
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.
856
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.
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.
857
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.
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.
858
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

Include 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.
Lateral Diameter: The diameter of the hydrant lateral.
Lateral Minor Loss Coefficient: The minor loss coefficient of the hydrant lateral.
Lateral Length: 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
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.
859
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.
at reservoirs.
the system.
time.
node over time.
time.
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.
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.
860
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.
Tank Attributes

861
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.
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.
Elevation (Minimum): Lowest allowable water surface elevation or level. If the tank drains below this point, it will
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.
862
Level (High Alarm): The level above which the high level alarm is generated. Calculation notifications are
Elevation (Low Alarm): The elevation below which the low level alarm is generated. Calculation notifications are
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
Elevation (Initial): Starting water surface elevation/level in the tank.
Level (Initial): Starting water surface elevation/level in the tank.
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.
at reservoirs.
the system.
time.
node over time.
time.
Relative Closure (Calculated, Inlet Valve): The relative closure of the tank throttling inlet valve at the current
time step. (Only applies if the inlet throttles).
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.
863
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.
Reservoir Attributes

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.
at reservoirs.
the system.
time.
node over time.
time.
864

Periodic Head-Flow Attributes

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.
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.
at reservoirs.
the system.
time.
865
node over time.
time.
Discharge (Calculated): Calculated discharge from the node.
Pump Attributes

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.
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
866
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.
Pump Station: The Pump Station to which this Pump belongs.
at reservoirs.
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.
867
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.
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.
868
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.
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

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.
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 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
869
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.
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 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

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.
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
870
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
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.
at reservoirs.
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.
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.
871
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.
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 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 Use Cost (Total): Total cost of energy used during simulation.
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
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.
872
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

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.
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.
at reservoirs.
873
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.
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.
Valve Attributes
Pressure Reducing Valve (PRV) Attributes

Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow / (Pressure Drop) ^ 0.5.
Hydraulic Grade Setting (Initial, Transient): The initial HGL setting for the transient simulation.
874
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.
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.
Status (Initial, Transient): Choices: Active, Inactive, Closed
at reservoirs.
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.
875
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
derived or local.
Pressure Sustaining Valve (PSV) Attributes
Hydraulic Grade Setting (Initial, Transient): The initial HGL setting for the transient simulation.
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).
876

at reservoirs.
derived or local.
877
Pressure Breaker Valve (PBV) Attributes

Flow (Initial): This is a typical (positive) flow through the valve.
Pressure Drop (Initial): Pressure drop corresponding to the typical flow.
at reservoirs.
878

derived or local.
Flow Control Vale (FCV) Attributes

Flow Setting (Initial): Initial flow setting for the flow control valve.
Flow (Initial, Transient): The initial flow to be used in the transient analysis.
879
at reservoirs.
Flow Setting (Calculated): Flow setting at selected valve for current time step.
derived or local.
880
Throttle Control Valve (TCV) Attributes

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
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).
Relative Closure (Initial Transient): The initial relative closure of the valve at the start of the transient calculation.
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.
881
at reservoirs.
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).
derived or local.
General Purpose Valve (GPV) Attributes
882

Flow (Initial): This is a typical (positive) flow through the valve.
Pressure Drop (Initial): Pressure drop corresponding to the typical flow.
Transient Analysis Behavior: Choices: Orifice, Valve
Status (Initial): Choices: Active, Closed
at reservoirs.
derived or local.
883
Valve With Linear Area Change Attributes

Status (Initial): Choices: Active, Closed
Status (Initial, Transient): Choices: Active, Closed
at reservoirs.
884
derived or local.
Check Valve Attributes

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
at reservoirs.
885
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.
Orifice Between Pipes Attributes

Pressure Drop (Typical): Pressure drop corresponding to the typical flow.
Flow (Typical): This is a typical (positive) flow through the orifice or valve.
at reservoirs.
Flow: Total flow through the orifice.
Headloss: Change in head across orifice.
Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the orifice.
886
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.
Discharge To Atmosphere Attributes

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.
at reservoirs.
887
the system.
time.
node over time.
time.
Discharge (Calculated): Calculated discharge from the node.
Surge Tank Attributes

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.
888
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 (Maximum): Highest allowable water surface elevation or level. If the tank fills above this point, it will
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.
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.
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.
Elevation (Minimum): Lowest allowable water surface elevation or level. If the tank drains below this point, it will
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
Level (High Alarm): The level above which the high level alarm is generated. Calculation notifications are
Elevation (Low Alarm): The elevation below which the low level alarm is generated. Calculation notifications are
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
Use Low Alarm?: Specifies whether or not to check low alarm levels during Steady State/EPS calculation and
Elevation (Initial): Starting water surface elevation/level in the tank.
Level (Initial): Starting water surface elevation/level in the tank.
889
the adjacent pipe.
at reservoirs.
the system.
time.
node over time.
time.
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
890
Hydropneumatic Tank Attributes

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.
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.
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.
891
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
the adjacent pipe.
at reservoirs.
the system.
time.
node over time.
time.
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.
892
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

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
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.
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).
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).
893
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.
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
at reservoirs.
the system.
time.
node over time.
time.
894
Surge Valve Attributes

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
at reservoirs.
the system.
time.
node over time.
time.
895

Rupture Disk Attributes

Pressure Threshold: The pressure above which the rupture disk breaks to vent the liquid to atmosphere.
at reservoirs.
the system.
time.
node over time.
time.
896
Isolation Valve Attributes

Minor Loss Coefficient: K value in the minor headloss equation.
Is Operable?: If true, valve can be used in identifying segments.
at reservoirs.
Hydraulic Grade: Hydraulic Grade at valve location on pipe.
Pressure: Pressure at valve location on pipe.
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

Hydraulic Grade (Enhanced) Interpolated hydraulic grade at this location.
Pressure (Enhanced) Pressure based on the interpolated hydraulic grade
897
Index
A E N
Actions Tab 476 Editing Alternatives 369 Naming and Renaming
Active Topology Selection Editing FlexTables 727 FlexTables 727
Dialog Box 481 Editing Scenarios 364
Adding Elements to a Selection Engineering Libraries 215
Set 199 Extended Period Simulation 395
O
Observed Data Dialog Box 746
Alternative Editor Dialog Box
Opening FlexTables 726
368
Annotating Your Model 705
F
Finalizing the Project 361
FlexTable Dialog Box 724
P
B FlexTables Manager 721
Panning 27
Pattern Curve Dialog Box 467
Batch Pipe Split Dialog Box 184
Preparing to Use ModelBuilder
G 250
C GIS-IDs 267 Profile Setup 717
Chart Options Dialog Box 748 GIS-IDs Collection Dialog Box Profile Viewer Dialog Box 719
Color Coding Your Model 709 268 ProjectWise Cross-Discipline
Conditions Tab 471 Graph Dialog Box 741 Coordination Services
Constituent Alternatives 378 Graph Manager 740 Support 87
Contour Plot 714 Graphing 740 Property Editor 189
Controlling Results Output 457
Controls Tab 469
Copying
I R
Import Bentley SewerCAD 44 Relabeling Elements 191
Exporting
Removing Elements from 199
and Printing
Running Multiple Scenarios at
FlexTable M Once (Batch Runs) 365
Data 733 MicroStation Environment 37
Creating a New FlexTable 726 MicroStation Mode Graphical
Creating a Selection Set from a Layout 39 S
Selection 198 Minimizing Effort through Sample Observed Data Source
Creating Alternatives 368 Attribute Inheritance 747
Creating Queries 222 357 SCADAConnect Overview 492
Creating Scenarios 364 Minimizing Effort through Scenario Cycle 354
Customization Editor Dialog Box Scenario Inheritance Selection Sets Manager 195
237 358 Sharing User Data Extensions
Customizing a Graph 783 ModelBuilder Wizard 254 Among Element Types
Modeling Curved Pipes 183 232
D Sorting and Filtering FlexTable
Data 728
Drawing Synchronization 48
898
Specifying Network Totalizing Flow Meter Editor Working in AutoCAD Mode 46
Connectivity in Dialog 403 Working with Engineering
ModelBuilder 265 Totalizing Flow Meters Manager Libraries 215
Splitting Pipes 182 Dialog 402 Working with FlexTable Folders
Step 1-Specify Data Source 254 723
Step 2-Specify Spatial Options Working with Graph Data
256
U Viewing and Copying 741
User Data Extensions 228
Step 3 - Specify Element Create/
User Notifications 402
Remove/Update Options
257
Using Background Layers 33 Z
Using Folders in the Element Zooming 28
Step 4-Additional Options 259
Symbology Manager 705
Step 5-Specify Field mappings
Using Prototypes 213
for each Table/Feature
Using Selection Sets 194
Class 260
Using the Like Operator 226
Subtypes 265
T W
Warnings 264
Time Series Field Data 788
899

WaterGEMS V8i User's Guide

Uploaded by

Copyright:

Available Formats

WaterGEMS V8i User's Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

WaterGEMS V8i User's Guide

Uploaded by

Copyright:

Available Formats

Last Updated: August 05, 2015

WaterGEMS V8i (SELECTseries 6) Help

Getting Started in WaterGEMS V8i

What's New in WaterGEMS V8i?

New and improved features in WaterGEMS V8i include:

What is WaterGEMS V8i?

Municipal License Administrator Auto-Configuration

Starting WaterGEMS V8i

Working with WaterGEMS V8i Files

.rpc - report file from hydraulic analysis with user notifications

Using the Custom Results File Path Option

Exiting WaterGEMS V8i

To exit WaterGEMS V8i:

Transparency Set the transparency level of the background layer. You

Unit Select the unit that should be used.

Note: The way the image is compressed depends on

Transparency Set the transparency level of the background layer. You

Unit Select the unit that should be used.

Note: The way the image is compressed depends on

Be Communities Search Button

Software Updates via the Web and Bentley SELECT

Browse Click to open a dialog box to select the file to be used as a

Label Identifies the background layer.

Transparency Specify the transparency level of the background layer,

Symbol Choose the symbol that is displayed for each point

Show Flow Arrows (Stand-Alone)

Application Window Layout

The Standard toolbar is arranged as follows:

Create a new WaterGEMS V8i project. When you select

Open an existing WaterGEMS V8i project. When this

Closes the currently open project.

Close all the projects that are opened.

Save the current project.

Save all the projects that are opened.

Open the Print Preview window, displaying the current

Print the current view of the network. Choose Fit to Page

The Edit toolbar is arranged as follows:

Cancel your most recent action.

Redo the last canceled action.

Delete the currently selected element(s) from the network.

Removes the highlighting that can be applied using the

Find a specific element by choosing it from a menu

The Analysis toolbar is arranged as follows:

Opens the Post Calculation Processor, which allows you

Opens the Transient Results Viewer dialog, which allows

Opens the Transient Time Step Options dialog, which

Opens the Transient Thematic Viewer, which allows you

Open the Totalizing Flow Meters dialog box, which

Open the Hydrant Flow Curves dialog box, which allows

Open the Post Calculation Processor, where you can

Open the Darwin Calibrator dialog box, where you can

Open the Darwin Designer dialog box, where you can

Open the Darwin Scheduler dialog box, where you can

The Scenarios toolbar is arranged as follows:

Change the current scenario.

Scenario List Box

Open the Scenario manager, where you can create, view,

Open the Alternative manager, where you can create,

Open the Calculation Options manager, where you can

Run a diagnostic check on the network data to alert you to